Skip to main content

List Balances

GET /v1/balances

Overview

Retrieves a list of all balances associated with an account across different chains and currencies.

Authorization

  • Header: Authorization: Bearer sk_test_907...de66
Request Details

Request

curl https://api-prod.paybytoken.io/v1/balances \
-X GET \
-H "Authorization: Bearer sk_test_907...de66"

Request Parameters

ParameterTypeDescription
(None)-No additional parameters required.
Response Details

Response

The response returns a BalanceList object containing the total balance sum and a list of balance details.

Attributes

AttributeTypeDescription
totalstringTotal sum of all available balances (e.g., 12052.6).
dataarray of objectsList of balance objects with their details.

Example Response

{
"total": "12052.6",
"data": [
{
"id": "bal_t24d49WDnBzTTwcA",
"account_id": "acct_t24daokSqxEmdQGD",
"chain": "base",
"currency": "USDC",
"available_balance": "1052.6",
"pending_balance": "0.0",
"created_at": "2025-09-04T12:21:26.000Z",
"updated_at": "2025-09-04T12:21:26.000Z"
},
{
"id": "bal_t24d4cB4kHtJ9Fmn",
"account_id": "acct_t24daokSqxEmdQGD",
"chain": "ethereum",
"currency": "USDC",
"available_balance": "1000.0",
"pending_balance": "0.0",
"created_at": "2025-09-04T12:21:26.000Z",
"updated_at": "2025-09-04T12:21:26.000Z"
},
{
"id": "bal_t24d4eLzZP02J7Dw",
"account_id": "acct_t24daokSqxEmdQGD",
"chain": "base",
"currency": "USDT",
"available_balance": "5000.0",
"pending_balance": "0.0",
"created_at": "2025-09-04T12:21:26.000Z",
"updated_at": "2025-09-04T12:21:26.000Z"
},
{
"id": "bal_t24d4rumAPGwo6R8",
"account_id": "acct_t24daokSqxEmdQGD",
"chain": "ethereum",
"currency": "USDT",
"available_balance": "5000.0",
"pending_balance": "0.0",
"created_at": "2025-09-04T12:21:26.000Z",
"updated_at": "2025-09-04T12:21:26.000Z"
}
]
}