Sign in

v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB
Sandbox

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 or wire) or bankIban (network swift).

post/virtual-accounts/{virtualAccountId}/simulate/inbound-transfer

Path parameters

virtualAccountIdstring required

Headers

Idempotency-Keystring required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Request body

OR

Response

The request has succeeded.

virtualAccountIdstring required

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

type'bankUs' | 'bankIban' required

Echoes the request's type discriminator on the response.

network'ach' | 'wire' | 'swift' required

Network actually used - the union of both request rails' networks.

asset'usd' required

Always "usd".

amountstring required

Wire-safe decimal string for financial float values (USD amounts, percentages).

status'submitted' | 'pending' required

"submitted" for ach/wire (settles synchronously); "pending" for swift - the upstream provider settles SWIFT asynchronously.

submittedAtstring date-time required

When the simulated transfer was submitted.

referenceIdstring nullable required

Correlation id for the subsequent webhook. null for ach/wire; an intl_wire_in_… id for swift.