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

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

Returns a balance object for the authenticated account.

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

Funds that are available to be paid out automatically by Yorlet or for use in transfers and payouts.

​
in_transit
object[]
required

Funds that have been collected and are in transit to your bank account.

​
pending
object[]
required

Funds that are not yet available in the balance.

​
instant_available
object[]

Funds available for instant payouts.