Balance Transactions
List Balance Transactions
List and paginate the balance transactions available to an account.
GET /api/v1/balance_transactions
Overview
Retrieves the authenticated account's balance transactions with optional chain and currency filters.
Authorization
- Header:
Authorization: Bearer $PAYBYTOKEN_SECRET_KEY
Request Details
Request
curl "https://api-prod.paybytoken.io/api/v1/balance_transactions?chain=base¤cy=USDC&offset=0&limit=10" \
-X GET \
-H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"Request Parameters
| Parameter | Type | Description |
|---|---|---|
chain | string | Exact chain filter. |
currency | string | Exact asset filter. |
offset | integer | Number of records to skip before returning the page. |
limit | integer | Number of items per page, from 1 through 100. |
Response Details
Response
The response returns a paginated list of BalanceTransaction objects.
Attributes
| Attribute | Type | Description |
|---|---|---|
total | integer | Total account balance transactions. The current legacy endpoint does not narrow this count when chain or currency filters are supplied. |
data | array of objects | Balance Transaction objects in newest-first order. |
Example Response
{
"total": 3,
"data": [
{
"id": "btx_pdMf5r3updqUKflE",
"account_id": "p226968785",
"balance_id": "bal_ofK07A66lSdtbXIa",
"amount": "5.0",
"currency": "USDC",
"chain": "base",
"description": null,
"fee": "0.025",
"total": "4.975",
"fee_details": [
{
"type": "service_fee",
"currency": "USDC",
"description": "Service fee for payment intent",
"amount": "0.025"
},
{
"type": "network_fee",
"currency": "USDC",
"description": "Network fee for payment intent",
"amount": "0.0"
}
],
"type": "credit",
"resource_type": "payment_intent",
"resource_id": "pay_pdICAC1vp3WkAKof4QkM",
"remark": null,
"created_at": "2025-09-25T10:35:10.000Z",
"updated_at": "2025-09-25T18:35:10.000Z",
"token": {
"id": "tok_ofIiMC131ysXsbCj",
"currency": "USDC",
"chain": "base",
"decimals": 6,
"name": "USD Coin",
"chain_id": 84532,
"chain_name": "Base",
"currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdc-logo.png",
"chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/base-logo.png",
"chain_explorer_url": "https://sepolia.basescan.org",
"contract_address": "0xBd02F04420F7bA751d6240f053E2decfb6c90821"
}
},
{
"id": "btx_pe0g3021LAI7aCei",
"account_id": "p226968785",
"balance_id": "bal_pdiDvNkBmV9wvjA6",
"amount": "5.0",
"currency": "USDC",
"chain": "bnb_chain",
"description": null,
"fee": "0.025",
"total": "4.975",
"fee_details": [
{
"type": "service_fee",
"currency": "USDC",
"description": "Service fee for payment intent",
"amount": "0.025"
},
{
"type": "network_fee",
"currency": "USDC",
"description": "Network fee for payment intent",
"amount": "0.0"
}
],
"type": "credit",
"resource_type": "payment_intent",
"resource_id": "pay_pdVpMS5dyYQk5ED06a4W",
"remark": null,
"created_at": "2025-09-25T11:30:51.000Z",
"updated_at": "2025-09-25T19:30:51.000Z",
"token": {
"id": "tok_pdcvY8c0GjanZazA",
"currency": "USDC",
"chain": "bnb_chain",
"decimals": 18,
"name": "USD Coin",
"chain_id": 97,
"chain_name": "BNB Chain",
"currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdc-logo.png",
"chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/bnb-logo.png",
"chain_explorer_url": "https://testnet.bscscan.com",
"contract_address": "0x46E59191cfE8bF9Bdb1417Bdf3e72179fCA0F338"
}
}
]
}Did this page answer your question?
Your feedback helps us improve the integration path.