Skip to main content
POST
/
api
/
v1
/
onrampSession
Create On-Ramp Session
curl --request POST \
  --url https://skala-sandbox.ripio.com/api/v1/onrampSession/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "fca6d32f-2f7e-4f7e-b224-8be0b92fa3f1",
  "paymentMethodType": "bank_transfer",
  "chain": "ETHEREUM_SEPOLIA",
  "currency": "RTEST",
  "depositAddress": "0x866B933Aabc4F9813405C6E393dbD4B600eF3E2e"
}
'
{
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "chain": "<string>",
  "depositAddress": "<string>",
  "fiatPaymentInstructions": {},
  "transactions": [
    {
      "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
    }
  ]
}
Each customer can only have one active on-ramp session at a time. If a session already exists for the customer, calling this endpoint will update it with the new parameters instead of creating a new one.

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 session.

​
customerId
string<uuid>
required

Unique identifier for the customer.

Example:

"fca6d32f-2f7e-4f7e-b224-8be0b92fa3f1"

​
paymentMethodType
string
required

The payment method used for the fiat deposit.

Example:

"bank_transfer"

​
chain
string
required

The blockchain network to be used for the conversion.

Example:

"ETHEREUM_SEPOLIA"

​
currency
string
required

The target currency for the conversion.

Example:

"USDC"

​
depositAddress
string
required

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

Example:

"0x4e88BBeFF059BDDF5BF90ee0816E86eDf4214b32"

Response

On-Ramp session created successfully.

​
sessionId
string<uuid>
required

Unique identifier for the created on-ramp session.

​
customerId
string<uuid>
required

Unique identifier for the customer associated with the session.

​
createdAt
string<date-time>
required

Date and time the on-ramp session was created.

​
currency
string
required

The target crypto currency for every on-ramp transaction performed with the created session.

​
chain
string
required

The blockchain network to be used for the conversion.

​
depositAddress
string
required

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

​
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.

Examples:
{
  "cvu": "0000465160000000070078",
  "alias": "juan.perez.ramp"
}
{ "cvu": "0000465160000000070078" }
{ "clabe": "706180196550550550" }
​
transactions
object[]

A list containing every transaction that has been either started or completed through this session. On creation, will always be empty.