Skip to main content
POST
/
api
/
v1
/
onramp
Create On-Ramp Order
curl --request POST \
  --url https://skala-sandbox.ripio.com/api/v1/onramp/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "b6cecc1f-c90d-424b-adaa-c82b780696c1",
  "quoteId": "8142b065-79c4-4f48-9e33-11b17bc658d4",
  "depositAddress": "0x4e88BBeFF059BDDF5BF90ee0816E86eDf4214b32",
  "externalRef": "e6c4f1ec-899f-43b5-8479-c2529e3f9c70",
  "extraData": {
    "callback": "https://example.com/callback",
    "bankCode": "1001"
  }
}
'
{
  "transaction": {
    "transactionId": "21d8a046-3221-4b43-a301-0f9adcdd9a45",
    "createdAt": "2023-11-07T05:31:56Z",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fromCurrency": "ARS",
    "toCurrency": "USDC",
    "amount": "<string>",
    "chain": "ETHEREUM_SEPOLIA",
    "paymentMethodType": "bank_transfer",
    "depositAddress": "<string>",
    "status": "WITHDRAWAL_PENDING",
    "externalRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "ON_RAMP",
    "metadata": {},
    "txnHash": null
  },
  "fiatPaymentInstructions": {}
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Details for creating an on-ramp order.

​
customerId
string<uuid>
required

Unique identifier for the customer.

Example:

"b6cecc1f-c90d-424b-adaa-c82b780696c1"

​
quoteId
string<uuid>
required

Unique identifier for the quote obtained from the Quoting Endpoint.

Example:

"8142b065-79c4-4f48-9e33-11b17bc658d4"

​
depositAddress
string
required

The customer's deposit address on the chosen blockchain network.

Example:

"0x4e88BBeFF059BDDF5BF90ee0816E86eDf4214b32"

​
externalRef
string<uuid>
required

Unique identifier for the order that is being created, provided by the partner.

Example:

"e6c4f1ec-899f-43b5-8479-c2529e3f9c70"

​
extraData
object

Additional data for the on-ramp order. Required for Colombia payment methods (bank_transfer, r2p_bancolombia, r2p_nequi).

Response

On-Ramp order created successfully.

​
transaction
object
required

Details of an on-ramp transaction.

​
fiatPaymentInstructions
object
required

Instructions for the customer to complete the fiat deposit. Structure varies depending on payment method and currency: bank_transfer (Argentina) returns cvu and optionally alias (a human-readable identifier that can be used instead of the CVU for transfers — to enable alias customization, contact the Ripio team), bank_transfer (Mexico) returns clabe, bank_transfer (Colombia) returns paymentUrl, breb returns brebKey, r2p_bancolombia returns paymentUrl, r2p_nequi returns phoneNumber.

Examples:
{
  "cvu": "0100000000000000000001",
  "alias": "juan.perez.ramp"
}
{ "cvu": "0100000000000000000001" }
{ "clabe": "706180196550550550" }
{
  "paymentUrl": "https://example.com/payment/abc123"
}
{ "brebKey": "@ABC123" }
{ "phoneNumber": "*****1234" }