Skip to main content
POST
The field you need to send alongside paymentMethodType and amount depends on the customer’s country. Use the value returned in fiatPaymentInstructions from the Create On-Ramp Session or Create On-Ramp Order response.
For Brazil, the deposit account is provisioned asynchronously — wait until the account is enabled and pixKey is available before simulating the deposit. See Brazil (PIX).
This endpoint only exists in sandbox — it is not routed in production.A successful call returns 200 with no body at all (a zero-length response, not {}), so don’t try to parse the response as JSON.

Authorizations

Authorization
string
header
required

Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.

Body

application/json

Details for simulating the deposit.

paymentMethodType
string
required

The payment method type for the simulated deposit.

Example:

"bank_transfer"

amount
number
required

The amount of fiat to send.

Example:

2100

alias_or_cvu
string

Alias or CVU to which the deposit will be made (from onramp fiatPaymentInstructions). Used for ARS deposits.

Example:

"0100000000000000000001"

clabe
string

CLABE to which the deposit will be made (from onramp fiatPaymentInstructions). Used for MXN deposits.

Example:

"706180196550550550"

payment_url
string<uri>

Payment URL to identify the order (from onramp fiatPaymentInstructions). Used for COP deposits.

Example:

"https://example.com/payment/abc123"

pix_key
string

PIX key to which the deposit will be made (the pixKey from onramp fiatPaymentInstructions). Used for BRL deposits with paymentMethodType: pix.

Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

Response

Deposit simulation successful. The response has no body at all — a zero-length payload, not {}. Do not try to parse it as JSON.