List all deposits
curl --request GET \
--url https://api.yorlet.com/v1/deposits \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/deposits"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.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.yorlet.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: <api-key>"
],
]);
$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.yorlet.com/v1/deposits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.yorlet.com/v1/deposits")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "deposit",
"amount": 123,
"application": "<string>",
"assignee": "<string>",
"certificate": "<string>",
"country": "<string>",
"currency": "<string>",
"customer": "<string>",
"description": "<string>",
"requirements": {
"additional": [
"<string>"
],
"currently_due": [
"<string>"
],
"minimum": [
"<string>"
]
},
"returned_at": 123,
"scheme": {
"certificate": "<string>",
"registration_deadline": 123,
"registration_number": "<string>"
},
"transferred_at": 123,
"unit": "<string>",
"account": "<string>",
"deleted": false,
"amount_refunded": 0,
"handled_externally": false,
"metadata": {},
"returned": false,
"transferred": false
}
]
}Deposits
List all deposits
A list of deposits. The deposits are returned sorted by creation date, with the most recent deposits appearing first.
GET
/
v1
/
deposits
List all deposits
curl --request GET \
--url https://api.yorlet.com/v1/deposits \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/deposits"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.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.yorlet.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: <api-key>"
],
]);
$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.yorlet.com/v1/deposits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.yorlet.com/v1/deposits")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "deposit",
"amount": 123,
"application": "<string>",
"assignee": "<string>",
"certificate": "<string>",
"country": "<string>",
"currency": "<string>",
"customer": "<string>",
"description": "<string>",
"requirements": {
"additional": [
"<string>"
],
"currently_due": [
"<string>"
],
"minimum": [
"<string>"
]
},
"returned_at": 123,
"scheme": {
"certificate": "<string>",
"registration_deadline": 123,
"registration_number": "<string>"
},
"transferred_at": 123,
"unit": "<string>",
"account": "<string>",
"deleted": false,
"amount_refunded": 0,
"handled_externally": false,
"metadata": {},
"returned": false,
"transferred": false
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of deposits.
Was this page helpful?
⌘I