Skip to content
API reference

Get balance

Available, pending, frozen, and reserve balances.

GET/api/v1/me/balance
Step-by-step guideStep 1 of 3

Select a stage to see what happens.

Your integration
Request readyIllustrative example
GET/me/balance
Authorization
Bearer ••••••••
Accept
application/json

Prepare the request

Use credentials for the selected environment and complete the required parameters.

Illustrative flow · no data is sent

How this endpoint works

Return the merchant's current balance: available, pending settlement, frozen (held against open claims), and rolling reserve — plus a fee summary, tier and withdrawal fee. The four buckets, and every amount in `feeSummary`, are in USD — which is the only balance you can withdraw. `balances[]` lists what you hold PER CURRENCY and always includes USD, even at zero. Your shop runs one of two balance models. On `usd` (the default) every charge is converted to USD when it is captured, so `balances[]` has a single USD row and nothing changes for you. On `local` you are credited in the currency the buyer paid in, so `balances[]` has one row per currency: convert to USD with POST /me/balance/swap before withdrawing or settling in USDT/USDC.

Server-side authentication
Authentication guide
Key2Pay Developer documentationAPI v1
Documentation
Dashboard