Skip to content
API reference

Payout balance

Available payout funds per currency, with direct local-balance funding or a separate USD-funded payout wallet.

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

Select a stage to see what happens.

Your integration
Request readyIllustrative example
GET/me/payout/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

Returns balances[] with available, pending and reserved amounts per currency. With fundingMode=local_balance, available Pay-in funds can be used directly for payouts in that currency; no transfer or swap is required, and transferableFromPayinUsd is zero. Existing payout-wallet funds are included without duplication. With fundingMode=payout_wallet, a USD-model shop transfers USD into Payouts and swaps to the payout currency when necessary. Pending and reserved funds cannot be spent. Sandbox uses only its own test balance.

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