curl --request GET \
--url https://sandbox-b2b.ripio.com/api/v1/deposits/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-b2b.ripio.com/api/v1/deposits/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-b2b.ripio.com/api/v1/deposits/', 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://sandbox-b2b.ripio.com/api/v1/deposits/",
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://sandbox-b2b.ripio.com/api/v1/deposits/"
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://sandbox-b2b.ripio.com/api/v1/deposits/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-b2b.ripio.com/api/v1/deposits/")
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{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "fa14c963-1afb-4f0d-af0d-e622e0c50297",
"hash": "4f87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118e2",
"index": 0,
"amount": "2.29999999",
"create_date": "2017-10-12T22:40:08.273Z",
"update_date": "2017-10-12T22:41:23.273Z",
"confirmation_date": "2017-10-12T22:40:08.273Z",
"currency_code": "BTC",
"address_destination": "ajxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt",
"address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t",
"end_user_id": "CUST_2",
"status": "COMPLETED",
"network": "BTC",
"risk_score": "MEDIUM",
"is_blocked": false,
"reason": ""
},
{
"id": "cacff7d9-a43f-4420-84e0-579decaacdf4",
"hash": "1G87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118g3",
"index": 0,
"amount": "2.29999999",
"create_date": "2017-10-12T22:40:08.273Z",
"confirmation_date": null,
"update_date": "2017-10-12T22:40:08.273Z",
"currency_code": "BTC",
"address_destination": "bjxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt",
"address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t",
"end_user_id": "CUST_3",
"status": "PENDING",
"network": "BTC",
"risk_score": "MEDIUM",
"is_blocked": false,
"reason": ""
}
]
}List Deposits
Endpoint that list all the deposits received.
Note:
This endpoints allows to poll or reconcile deposited transactions. We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below (see results attribute in response’s payload)
Ordering:
Results are returned in ascending creation order, the oldest deposit first. The order is stable across requests and pages, so paging through the whole list never repeats nor skips a deposit.
curl --request GET \
--url https://sandbox-b2b.ripio.com/api/v1/deposits/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-b2b.ripio.com/api/v1/deposits/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-b2b.ripio.com/api/v1/deposits/', 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://sandbox-b2b.ripio.com/api/v1/deposits/",
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://sandbox-b2b.ripio.com/api/v1/deposits/"
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://sandbox-b2b.ripio.com/api/v1/deposits/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-b2b.ripio.com/api/v1/deposits/")
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{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "fa14c963-1afb-4f0d-af0d-e622e0c50297",
"hash": "4f87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118e2",
"index": 0,
"amount": "2.29999999",
"create_date": "2017-10-12T22:40:08.273Z",
"update_date": "2017-10-12T22:41:23.273Z",
"confirmation_date": "2017-10-12T22:40:08.273Z",
"currency_code": "BTC",
"address_destination": "ajxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt",
"address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t",
"end_user_id": "CUST_2",
"status": "COMPLETED",
"network": "BTC",
"risk_score": "MEDIUM",
"is_blocked": false,
"reason": ""
},
{
"id": "cacff7d9-a43f-4420-84e0-579decaacdf4",
"hash": "1G87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118g3",
"index": 0,
"amount": "2.29999999",
"create_date": "2017-10-12T22:40:08.273Z",
"confirmation_date": null,
"update_date": "2017-10-12T22:40:08.273Z",
"currency_code": "BTC",
"address_destination": "bjxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt",
"address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t",
"end_user_id": "CUST_3",
"status": "PENDING",
"network": "BTC",
"risk_score": "MEDIUM",
"is_blocked": false,
"reason": ""
}
]
}Authorizations
B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:
- clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.
Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.
Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN
- Token URL
- https://sandbox-b2b.ripio.com/oauth2/token/
Query Parameters
Filter deposits by create_date less than or equal to this date.
Filter deposits by create_date greater than or equal to this date.
Filter deposits by confirmation_date less than or equal to this date.
Filter deposits by confirmation_date greater than or equal to this date.
End User that has received deposits.
Currency codes that has been deposited.
Page number to return. Starts at 1.
Filter deposits by update_date less than or equal to this date.
Filter deposits by update_date greater than or equal to this date.
Sort order. Prefix a field with - for descending order. Results with the same value keep their creation order, in the same direction. Defaults to creation order, oldest first. Combine ordering=updated_at with update_date_gte/update_date_lte to poll status changes within a time window.
created_at, -created_at, updated_at, -updated_at Number of deposits to return per page. Defaults to 20, up to 100; larger values return 100.
x <= 100Response
Indicates total count of deposits.
123
Indicates next page by URL.
"http://api.example.org/accounts/?page=4"
Indicates previous page by URL.
"http://api.example.org/accounts/?page=2"
List of fetched deposits.
Show child attributes
Show child attributes
Was this page helpful?