Endpoints

Payout currencies

GET/api/v1/me/payout/currencies

The distinct currencies you can pay out in (derived from your rails), each flagged with `funded` + `available` + the rails in that currency.

GET/api/v1/me/payout/currenciessecret key

Returns the DISTINCT currencies available for payouts, derived from the configured payout rails — so you don't have to dedupe GET /me/payout/methods yourself. Each currency carries `funded` (true if you hold a payout balance in it), `available` (your balance in that currency, 0 if none), a representative `country`, and the `rails` available in it. Sorted by currency (USD first). In sandbox the synthetic test rails' currencies are included too, so you know exactly what to fund + test.

Request

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

Response

{
  "currencies": [
    { "currency": "USD", "country": "US", "funded": true, "available": 250.00, "rails": [ { "id": "po_usd_bank", "rail": "bank", "country": "US" } ] },
    { "currency": "MXN", "country": "MX", "funded": true, "available": 1850.00, "rails": [ { "id": "po_mxn_spei", "rail": "spei", "country": "MX" } ] }
  ]
}