Skip to main content
GET
/
v1
/
balance_transactions
List all balance transactions
curl --request GET \
  --url https://api.yorlet.com/v1/balance_transactions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "balance_transaction",
      "amount": 123,
      "available_on": 123,
      "currency": "<string>",
      "description": "<string>",
      "fee": 123,
      "fee_details": [
        {
          "amount": 123,
          "description": "<string>",
          "tax": 123,
          "tax_percent": 123,
          "type": "<string>"
        }
      ],
      "net": 123,
      "payout": "<string>",
      "source": "<string>",
      "source_object": "<string>",
      "account": "<string>",
      "deleted": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of balance transactions.

​
count
number
required

Total number of items in the list.

Example:

1

​
has_more
boolean
required

Whether more items are available.

Example:

false

​
object
enum<string>
required
Available options:
list
​
data
object[]
required