Testing Settlement in the Test Environment
The Bead test environment includes settlement flow simulators for BTC, Lightning, PayPal, Venmo, and Klarna payments. These simulators advance the settlement lifecycle automatically so you can observe and validate the full status progression without waiting for production-equivalent timing.
How settlement progresses in the test environment
Settlement for all payment types follows the same lifecycle: payments are grouped into batches, batches roll into settlements, and settlements are funded via ACH. In the test environment, a nightly simulator advances each stage automatically.
The status progression you will observe is:
Payments complete and are grouped into an open batch (
batch.status = open).Batch closes overnight (
batch.status = closed). A settlement record is created withstatus = cleared.The simulator runs. A simulated ACH event advances the settlement.
Settlement status moves to
dispatched, thenpaid. A deposit record is created and moves topaid.
Simulator schedule
The simulators run automatically on a nightly schedule. Plan your test flows accordingly:
Process test payments.
Confirm the batch has closed (
batch.status = closed) — this happens at the nightly batch close.Check settlement status the following morning — the simulator will have advanced the settlement to
dispatchedorpaid.
What to observe when testing
Use
GET /Batchesfiltered byType(cryptofor BTC and Lightning,walletAppsfor PayPal, Venmo, and Klarna) to confirm batch status has moved toclosed.Use
GET /Settlementsfiltered byMerchantIdsandTypeto retrieve the settlement record once the batch has closed.Use
GET /Settlements/{id}to reviewstatus,grossFundableAmount,totalTransactionFees,depositFees, andnetFundableAmount.Use
GET /Settlements/{id}/depositsto confirm the deposit recordstatusonce settlement completes.
Expected end state after a full nightly cycle: batch status = closed, settlement status = paid, deposit status = paid.
Differences from production
Batch close
Nightly (midnight ET)
Nightly (midnight ET)
Settlement funding
Real ACH event
Simulated ACH event
Timing to paid
Vendor-dependent (hours to next business day)
Advances overnight on test schedule
Next steps
Use Settlements to review settlement records and fee breakdowns.
Use Batches to track batch status and payment grouping.
Use Deposits to confirm funded movement once settlement completes.
Use Payment Settlements for payment-level settlement detail.
Use Merchant Settlements for the merchant-level settlement event view.
Last updated