Skip to main content
POST
Simulate a virtual account deposit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string
required

ID of the user.

Pattern: ^user_[A-Za-z0-9]+$
virtualAccountId
string
required

Public ID of the virtual account (prefixed with va_)

Body

application/json

Sandbox-only. Simulates an inbound fiat deposit into the virtual account so the resulting onramp flow can be observed end to end.

Sandbox-only simulated deposit request.

amount
number
required

Deposit amount in the source fiat currency.

Required range: 0.01 <= x <= 100000000
Example:

100

transferType
enum<string>
required

Fiat transfer rail to simulate.

Available options:
ACH,
WIRE
Example:

"ACH"

source
object
required

Simulated sending bank account details.

reference
string

Optional payment reference.

Maximum string length: 35
Example:

"INV-2026-0001"

Response

Sandbox deposit simulated successfully.

A simple message acknowledgement.

message
string
Example:

"Success"