Skip to content
API reference

Payout balance

Your payout balance per currency (USD always present) + how much USD you can transfer from pay-in.

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 your payout-environment balance grouped by currency. `balances[]` carries each currency with `available` / `pending` / `reserved` (USD is always there, starting at 0; local currencies appear after a swap). `transferableFromPayinUsd` is how much USD from your pay-in balance you can move to payout.

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