Available balance in merchants' preferred local currency

GET/payout/balances

Available balance details in the merchants’ preferred local currency by merchant. This is for all merchants that these API credentials have access to. To make a successful settlement or refund, the merchant must have sufficient available balance.

**NOTE: This API is shared with Crypto Payouts API, so it just returns the merchants current balance no matter for payments or payouts. **

Response

Success

merchant_keystring

Unique key that identifies a merchant

merchant_namestring

Name of the merchant

balancesobject[]

List of available balances

Show balances properties
type"test" | "real"

Is the balance derived from real deposits (actual transfer of local currency or mainnet cryptocurrency) or from test deposits (test transfer of local currency or testnet cryptocurrency).

For available_currency: 'BTC', it is always real and for available_currency: 'testBTC', it is always test. In the case of a local currency available_currency, it can be either real or test.

available_currencystring

The available currency in local currency/cryptocurrency. At this time it is only the merchant’s preferred currency, BTC or testBTC.

available_amountnumber<float>

The available balance amount that can be used for settlements and refunds. There must be sufficient balance for a successful settlement or refund.

Not authorized

messagestring

No permission to access these balances

messagestring
Request
curl -X GET "https://api.triple-a.io/api/v2/payout/balances" \
  -H "Authorization: Bearer <token>"
Response
[
  {
    "merchant_key": "mkey-ckcd2j2md0000zkqs3kueb19s",
    "merchant_name": "A to Z Toys and Games",
    "balances": [
      {
        "type": "test",
        "available_currency": "USD",
        "available_amount": 23.45
      }
    ]
  }
]