The balance object - Yorlet Documentation

{
  "object": "balance",
  "available": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ],
  "in_transit": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ],
  "pending": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ],
  "instant_available": [
    {
      "currency": "<string>",
      "amount": 123
    }
  ]
}

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.

Show child attributes

in_transit

object[]

required

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

Show child attributes

pending

object[]

required

Funds that are not yet available in the balance.

Show child attributes

instant_available

object[]

Funds available for instant payouts.

Show child attributes

List all transfers

Retrieve owner balance