curl --request GET \
--url https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": {
"cvu": "0000465160000000070078",
"alias": "juan.perez.ramp",
"status": "enabled"
},
"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>",
"source": "ON_RAMP",
"metadata": {},
"txnHash": null,
"sender": "Juan Pérez",
"status": "COMPLETED",
"refundable": false,
"refundDestinationRequired": false,
"latestRefund": {
"refundId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"rejectionReason": "",
"initiatedBy": "PARTNER",
"requestedAt": "2023-11-07T05:31:56Z"
}
}
]
}{
"code": 40001,
"type": "NotAuthenticated",
"detail": {
"message": "Authentication credentials were not provided.",
"code": "not_authenticated"
},
"status": 401
}{
"code": 40004,
"type": "NotFound",
"detail": {
"message": "Not found.",
"code": "not_found"
},
"status": 404
}Retrieve an On-Ramp Session
Retrieves the details of a specific on-ramp session by its ID.
curl --request GET \
--url https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://skala-sandbox.ripio.com/api/v1/onrampSession/{sessionId}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": {
"cvu": "0000465160000000070078",
"alias": "juan.perez.ramp",
"status": "enabled"
},
"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>",
"source": "ON_RAMP",
"metadata": {},
"txnHash": null,
"sender": "Juan Pérez",
"status": "COMPLETED",
"refundable": false,
"refundDestinationRequired": false,
"latestRefund": {
"refundId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"rejectionReason": "",
"initiatedBy": "PARTNER",
"requestedAt": "2023-11-07T05:31:56Z"
}
}
]
}{
"code": 40001,
"type": "NotAuthenticated",
"detail": {
"message": "Authentication credentials were not provided.",
"code": "not_authenticated"
},
"status": 401
}{
"code": 40004,
"type": "NotFound",
"detail": {
"message": "Not found.",
"code": "not_found"
},
"status": 404
}Authorizations
Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.
Path Parameters
Unique identifier for the session.
Response
Details of the on-ramp session.
Unique identifier for the created on-ramp session.
Unique identifier for the customer associated with the session.
Date and time the on-ramp session was created.
The target crypto currency for every on-ramp transaction performed with the created session.
The blockchain network to be used for the conversion.
The customer's deposit address on the chosen blockchain network.
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.
pix (Brazil) is not available through a session: its payable object is generated per order, so use Create On-Ramp Order instead.
{
"cvu": "0000465160000000070078",
"alias": "juan.perez.ramp",
"status": "enabled"
}
{
"cvu": "0000465160000000070078",
"status": "enabled"
}
{
"clabe": "706180196550550550",
"status": "enabled"
}
{
"brebKey": "@E6JZKEPG5S",
"status": "enabled"
}
A list containing every transaction that has been either started or completed through this session. On creation, will always be empty.
Show child attributes
Show child attributes
Was this page helpful?