Sign in

v1

latestOpenAPI 3.0.02026-07-26103425558.9 KB
Virtual Account

Simulate a deposit to a virtual account

Simulate a deposit to a virtual account in sandbox environment. This endpoint is only available in sandbox and allows testing deposit flows.

Note: This endpoint is only available in sandbox environment.

post/v2/users/{userId}/virtual-accounts/{accountId}/simulate-deposit

Path parameters

userIdstring required

ID of the user

accountIdstring required

ID of the virtual account

Request body

amountstring required

Amount to simulate deposit

paymentRail'WIRE' | 'ACH' required

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

requestIdstring required

Unique identifier for the request (recommend using uuid v4)

userIdstring

Optional user ID to associate with this deposit

referencestring

Optional reference for this deposit

descriptionstring

Optional description for this deposit

Response

Successfully triggered sandbox deposit

amountstring required

Amount to simulate deposit

paymentRail'WIRE' | 'ACH' required

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

requestIdstring required

Unique identifier for the request (recommend using uuid v4)

userIdstring

Optional user ID to associate with this deposit

referencestring

Optional reference for this deposit

descriptionstring

Optional description for this deposit