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

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

accountId
string
required

ID of the virtual account

Body

application/json
amount
string
required

Amount to simulate deposit

paymentRail
enum<string>
required

Payment rail for the simulated deposit , recommended to use WIRE for faster settlement

Available options:
WIRE,
ACH,
RTP
requestId
string
required

Unique identifier for the request (recommend using uuid v4)

source
object
required
userId
string

Optional user ID to associate with this deposit

reference
string

Optional reference for this deposit

description
string

Optional description for this deposit

sandboxScenario
enum<string>

Sandbox-only field that forces the onramp created by this deposit to a predetermined outcome

Available options:
FIAT_FAILED,
COMPLETED

Response

Successfully triggered sandbox deposit

amount
string
required

Amount to simulate deposit

paymentRail
enum<string>
required

Payment rail for the simulated deposit , recommended to use WIRE for faster settlement

Available options:
WIRE,
ACH,
RTP
requestId
string
required

Unique identifier for the request (recommend using uuid v4)

source
object
required
userId
string

Optional user ID to associate with this deposit

reference
string

Optional reference for this deposit

description
string

Optional description for this deposit

sandboxScenario
enum<string>

Sandbox-only field that forces the onramp created by this deposit to a predetermined outcome

Available options:
FIAT_FAILED,
COMPLETED