Skip to main content
POST
Simulate an onramp deposit

Authorizations

Authorization
string
header
required

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

Path Parameters

onrampId
string
required

Public ID of the onramp transaction (prefixed with onramp_)

Body

application/json

Simulate an inbound fiat deposit for an onramp. Sandbox only.

Simulate an inbound fiat deposit against an onramp in the sandbox environment.

amount
number
required
Required range: 0.01 <= x <= 100000000
Example:

100

transferType
enum<string>
required
Available options:
ACH,
WIRE
Example:

"ACH"

source
object
required

Simulated originating bank account for the sandbox deposit.

reference
string

Optional reference code for the simulated deposit.

Maximum string length: 35
Example:

"REF-12345"

Response

Simulated deposit submitted successfully.

Result of a simulated sandbox deposit.

message
string
Example:

"Simulated deposit submitted successfully."