Deposits
List deposits
deprecated
Deprecated: use GET /v2/deposits for opaque cursor pagination.
GET
/
v1
/
deposits
List deposits
curl --request GET \
--url https://api.example.com/v1/deposits \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/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://api.example.com/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://api.example.com/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://api.example.com/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://api.example.com/v1/deposits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/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{
"deposits": [
{
"amount": "100.50",
"clientRef": "609eddec-9b97-4f41-8db3-ef9342263418",
"createdAt": "2024-01-15T10:30:00Z",
"currency": "EUR",
"id": "123e4567-e89b-12d3-a456-426614174000",
"method": "manual_deposit",
"status": "completed",
"updatedAt": "2024-01-15T10:35:00Z",
"errorMessage": "Payment declined by bank",
"providerTransactionId": "TXN-123456789"
}
],
"hasMore": true,
"nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}{
"details": [
{
"field": "accounts.0.data.crAccount",
"message": "crAccount must be exactly 10 digits for Nigerian accounts",
"value": "12345678901"
}
],
"error": "BAD_REQUEST",
"message": "Validation failed",
"path": "/v1/resource",
"statusCode": 400,
"timestamp": "2024-01-15T10:30:00.000Z"
}Authorizations
Enter Auth0 JWT token
Query Parameters
Filter deposits by status
Available options:
pending, processing, completed, failed, cancelled, refunding, refunded, in_review Cursor for pagination (composite: timestamp__uuid)
Example:
"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Number of items per page (1-100, default 20)
Required range:
1 <= x <= 100Example:
20
Response
List of deposits retrieved successfully
⌘I
List deposits
curl --request GET \
--url https://api.example.com/v1/deposits \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/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://api.example.com/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://api.example.com/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://api.example.com/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://api.example.com/v1/deposits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/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{
"deposits": [
{
"amount": "100.50",
"clientRef": "609eddec-9b97-4f41-8db3-ef9342263418",
"createdAt": "2024-01-15T10:30:00Z",
"currency": "EUR",
"id": "123e4567-e89b-12d3-a456-426614174000",
"method": "manual_deposit",
"status": "completed",
"updatedAt": "2024-01-15T10:35:00Z",
"errorMessage": "Payment declined by bank",
"providerTransactionId": "TXN-123456789"
}
],
"hasMore": true,
"nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}{
"details": [
{
"field": "accounts.0.data.crAccount",
"message": "crAccount must be exactly 10 digits for Nigerian accounts",
"value": "12345678901"
}
],
"error": "BAD_REQUEST",
"message": "Validation failed",
"path": "/v1/resource",
"statusCode": 400,
"timestamp": "2024-01-15T10:30:00.000Z"
}