Simulate inbound transfer on a Virtual Account
Simulate an inbound fiat transfer against a Virtual Account, for testing webhook and reconciliation flows. Sandbox / non-production only; returns 404 in production-live. Set the type field in the request body to choose the transfer rail: bankUs (network ach, wire or rtp) or bankIban (network swift). Not every rail is available on every Virtual Account; one whose provider does not offer the requested rail refuses the request. The Idempotency-Key header is required and is deduplicated before the provider is called: a retry carrying the same key replays the recorded response and never reaches the provider again. A retry with a new key is a new request, and on a Virtual Account whose provider models no idempotency key of its own it books a second credit.
Authorizations
Token from POST /auth/token
Headers
Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.
Path Parameters
Body
- US bank account (ACH, Wire or RTP)
- International bank account (SWIFT)
US domestic (ACH, Wire or RTP) inbound simulation against a Virtual Account.
Rail discriminator. Always bankUs for a US domestic inbound.
bankUs Which US rail to simulate.
ach, wire, rtp Always "usd", the only asset the VA rail supports today.
usd Must be greater than 0.00 and at most 10.00 (400 AmountExceedsCap beyond).
Response
The request has succeeded.
Flat (non-discriminated) response for POST /virtual-accounts/{id}/simulate/inbound-transfer.
The Virtual Account that received the simulated transfer (va_ prefix).
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$Echoes the request's rail discriminator.
bankUs, bankIban The rail the transfer settled on.
ach, wire, rtp, swift Always "usd".
usd The simulated transfer amount.
"submitted" for ach/wire/rtp; "pending" for swift — the upstream provider settles SWIFT asynchronously.
submitted, pending When the simulated transfer was submitted.
Correlation id for the subsequent webhook. null for ach/wire/rtp; an intl_wire_in_… id for swift.