v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Accounts

Get the current balance

Returns the custodial balance. Use X-On-Behalf-Of to target a sub-merchant.

get/api/balance

Response

Get the current balance successful

currencyNamestring required

Currency name

currencySymbolstring required

Currency symbol

decimalsnumber required

Number of decimals

amountInWeistring required

Balance expressed in the smallest unit (wei)

readableAmountstring required

Human-readable balance

Example response

{
  "currencyName": "USDC",
  "currencySymbol": "USDC",
  "decimals": 6,
  "amountInWei": "100000000",
  "readableAmount": "100.00",
  "custodial": {
    "address": "0xABC123…",
    "amountInWei": "100000000",
    "readableAmount": "100.00"
  },
  "custodialBalances": [
    {
      "currencyName": "USDC",
      "currencySymbol": "USDC",
      "decimals": 6,
      "amountInWei": "100000000",
      "readableAmount": "100.00",
      "pendingObligationsInCents": 500
    }
  ]
}