Retrieve owner balance
curl --request GET \
--url https://api.yorlet.com/v1/balance/owners \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/balance/owners"
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/balance/owners', 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/balance/owners",
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/balance/owners"
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/balance/owners")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/balance/owners")
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{
"object": "balance.owner",
"available": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
],
"in_transit": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
],
"pending": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
],
"reserve": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
]
}Balance
Retrieve owner balance
Retrieves the current owner balance for an owner on the account.
GET
/
v1
/
balance
/
owners
Retrieve owner balance
curl --request GET \
--url https://api.yorlet.com/v1/balance/owners \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/balance/owners"
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/balance/owners', 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/balance/owners",
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/balance/owners"
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/balance/owners")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/balance/owners")
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{
"object": "balance.owner",
"available": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
],
"in_transit": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
],
"pending": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
],
"reserve": [
{
"currency": "<string>",
"amount": 123,
"unit": {
"id": "<string>",
"name": "<string>"
}
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
Returns an owner balance object.
Available options:
balance.owner Funds available to pay out to the owner.
Show child attributes
Show child attributes
Funds in transit to the owner's bank account.
Show child attributes
Show child attributes
Funds that are not yet available in the owner balance.
Show child attributes
Show child attributes
Funds being held as reserve for the owner.
Show child attributes
Show child attributes
Was this page helpful?
⌘I