Balance#

The Balance object represents your CasaPay account's funds. Balances are broken down by currency and availability.

The Balance object#

AttributeTypeDescription
objectstringAlways "balance"
availablearrayFunds available for payout
available[].amountintegerAvailable amount
available[].currencystringCurrency code
pendingarrayFunds not yet available
pending[].amountintegerPending amount
pending[].currencystringCurrency code
reservedarrayFunds held in reserve
{
  "object": "balance",
  "available": [
    { "amount": 4500000, "currency": "eur" },
    { "amount": 1200000, "currency": "gbp" }
  ],
  "pending": [
    { "amount": 250000, "currency": "eur" },
    { "amount": 80000, "currency": "gbp" }
  ],
  "reserved": [
    { "amount": 50000, "currency": "eur" }
  ]
}

Retrieve Balance#

GET /v1/balance

curl https://api.casapay.com/v1/balance \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"