Skip to main content
GET
/
v1
/
balance
/
owners
Retrieve owner balance
curl --request GET \
  --url https://api.yorlet.com/v1/balance/owners \
  --header 'Authorization: <api-key>'
{
  "object": "balance.owner",
  "available": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ],
  "in_transit": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ],
  "pending": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ],
  "reserve": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

Returns an owner balance object.

object
enum<string>
required
Available options:
balance.owner
available
object[]
required

Funds available to pay out to the owner.

in_transit
object[]
required

Funds in transit to the owner's bank account.

pending
object[]
required

Funds that are not yet available in the owner balance.

reserve
object[]
required

Funds being held as reserve for the owner.