Fire a synthetic inbound credit at a sandbox virtual account.
Sandbox-only. Simulates a customer paying into the given virtual account so you can test your credit-confirmed callback handler end-to-end. The synthetic credit runs through the same matching, intent-completion, and callback-delivery pipeline a real credit uses — your callbackUrl receives a real, signed, retried credit-confirmed callback. Available to any sandbox-environment credential, on a virtual account that resolves to a test adapter. Never available to a live-environment credential.
Partner-visible credential identifier issued by bank-rail at credential provisioning time. Names which credential signed the request; the corresponding signing secret never appears in any request.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/bankrail/sandbox/simulate-credit" \ -H "Content-Type: application/json" \ -d '{ "virtualAccount": "9977696744", "amountKobo": 1660000 }'{ "outcome": "completed", "reference": "sandbox-sim-46770a3a-8bbb-429a-8209-dfc3ad808987", "dispatchId": "string", "message": "Synthetic credit dispatched. Your callback handler will receive a credit-confirmed callback."}BRR
The Bankrail Retrieval Reference — one reference for one value movement, from issuance through credit, callback, and reconciliation.
Register the terminal outcome for one of your in-flight sandbox outbound transfers. POST
Sandbox-only. Your transfer resolves through the real requery -> transition -> callback pipeline; your callbackUrl receives a real, signed terminal callback (transfer.confirmed or transfer.failed) within ~30 seconds. Target must be your own transfer, in state "submitted". Registering again before resolution replaces the pending outcome. To exercise the "unknown" deadline path, register nothing and let the requery schedule exhaust.