Get Balance

GET /api/v1/balances/:id

Overview

Retrieves the balance details for a specific account and currency on a given blockchain chain using its unique identifier.

Authorization

Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY

Request Details

Request

curl https://api-prod.paybytoken.io/api/v1/balances/bal_t24d49WDnBzTTwcA \
  -X GET \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

Request Parameters

Parameter	Type	Description
`id`	string	Unique identifier of the balance (e.g., `bal_t24d49WDnBzTTwcA`).

Response Details

Response

The response returns a Balance object containing details about the account's balance. See Balances Overview for the full object definition.

Example Response

{
  "id": "bal_t24d49WDnBzTTwcA",
  "account_id": "acct_t24daokSqxEmdQGD",
  "chain": "base",
  "currency": "USDC",
  "available_balance": "1052.6",
  "pending_balance": "0.0",
  "reserved_balance": "0.0",
  "total_balance": "1052.6",
  "token": {
    "id": "tok_base_usdc",
    "currency": "USDC",
    "chain": "base",
    "decimals": 6,
    "name": "USD Coin"
  },
  "created_at": "2025-09-04T12:21:26.000Z",
  "updated_at": "2025-09-04T12:21:26.000Z"
}