Merchant Balance

Returns the current balance for the authenticated merchant, including available funds, reserved amounts, and pending payouts.


Retrieve merchant balance

Returns the current balance for the authenticated merchant, including available funds, reserved amounts, and pending payouts.

Parameters

No parameters.

Returns

Balance unavailable from external provider

GET/v1/merchant_balance
curl --request GET \
  --url https://api.framepayments.com/v1/merchant_balance \
  --header 'Authorization: Bearer API_KEY'
RESPONSE
{
  "merchant_id": "9b20e0b1-1997-49f7-80ff-971329c084b0",
  "currency": "USD",
  "dots_balance": 50000,
  "available_for_payout": 40000,
  "reserved_amount": 5000,
  "pending_payouts": 5000,
  "last_updated_at": "2026-06-10T18:24:39Z",
  "source": "api",
  "status": "UNAVAILABLE",
  "reason_code": "DOTS_API_ERROR"
}