Docs
ENFR
Dashboard
API reference

Balance

Your available balance per currency, and your cards balance in US dollars. Amounts are in minor units.

The balance object

Attributes
objectstring

Always balance.

livemodeboolean

true for live objects, false for test objects.

availablearray

One entry per currency: { currency, amount }, in minor units. This is what you can pay out or settle.

cardsobject | null

Your cards balance, in US cents: { currency: "USD", amount }. New cards and card funding draw from it. null if the key’s creator does not have the Owner or Finance role.

The balance object
{
  "object": "balance",
  "livemode": false,
  "available": [
    {
      "currency": "XAF",
      "amount": 3447189
    },
    {
      "currency": "KES",
      "amount": 7164025
    }
  ],
  "cards": {
    "currency": "USD",
    "amount": 427555
  }
}

Retrieve the balance

GET/v1/balance

Returns the balance of the mode of your key (test or live).

Key roles: Every role

Returns

Returns the balance object.

curl https://api.monerail.com/v1/balance \
  -H "Authorization: Bearer $MONERAIL_KEY"
Response200
{
  "object": "balance",
  "livemode": false,
  "available": [
    {
      "currency": "XAF",
      "amount": 3447189
    },
    {
      "currency": "KES",
      "amount": 7164025
    }
  ],
  "cards": {
    "currency": "USD",
    "amount": 427555
  }
}