Skip to main content
GET
/
api
/
v1
/
customers
/
{customerId}
/
onrampSession
/
Retrieve a Customer's On-Ramp Session
curl --request GET \
  --url https://skala-sandbox.ripio.com/api/v1/customers/{customerId}/onrampSession/ \
  --header 'Authorization: Bearer <token>'
{
  "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,
      "sender": "Juan Pérez"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerId
string<uuid>
required

Unique identifier for the customer.

Response

The customer's on-ramp session.

​
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, breb (Colombia) returns brebKey. Methods backed by a persistent deposit account (cvu, clabe, brebKey) also include a status field (processing, enabled or disabled) indicating whether the deposit account is ready to operate; while processing, the deposit key/identifier may be null.

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

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