Skip to main content
POST
Simulate a fiat deposit to a sandbox virtual account

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required
virtualAccountId
string
required

Body

application/json
assetAmount
object
required
outcome
enum<string>
Available options:
completed,
frozen,
returned
externalReference
string
Required string length: 1 - 255
detectedAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
provider
enum<string>

Which sandbox mock provider's bank account to credit. Defaults to MOCK_BANK.

Available options:
mock_bank,
mock_bank_2
rail
enum<string>
Available options:
ach,
fedwire,
rtp
senderInfo
object

Response

Deposit accepted for ingestion; carries the reference to poll on

externalReference
string
required

Payment reference the deposit is detected under — the one supplied on the request with surrounding whitespace trimmed, or a synthetic sandbox_… reference when it was omitted. Poll GET /v2/transactions?externalReference=… to observe the deposit.