Endpoints

Payout balance

GET/api/v1/me/payout/balance

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

GET/api/v1/me/payout/balancesecret key

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.

Request

curl "https://sandbox.key2pay.ai/api/v1/me/payout/balance" \
  -H "Authorization: Bearer <accessToken>"

Response

{
  "merchantId": "MCH-…",
  "environment": "sandbox",
  "balances": [
    { "currency": "USD", "available": 250.00, "pending": 0, "reserved": 0 },
    { "currency": "MXN", "available": 1850.00, "pending": 0, "reserved": 0 }
  ],
  "transferableFromPayinUsd": 1200.55
}