Skip to main content
GET
List payout batches
List the mass-payout batches you have queued, page by page. Mass payouts are batch egress (outbound money movement) to up to 500 recipients per batch; every recipient address must be on your withdrawal whitelist.
cURL
200 OK
The example shows an account with no batches yet.
Every money value on this response is an exact decimal string, never a JSON number — totalsByCurrency, feeByCurrency, and each leg’s amount, networkFee and netToDestination. Parse them with a decimal library; parseFloat on an 18-decimal asset loses precision. Each leg’s figures match the underlying withdrawal byte for byte. Batches created before 2026-08-12 stored these as floats and are normalized to strings on read, so the wire type is the same for every batch.

Authorization

Dashboard-only (JWT) with the mass-payouts:view team permission. API keys are not accepted — an API key gets 401 {"error":"Invalid or expired token"}. See the Authentication guide. Rate limit: 60/min.

Parameters

integer
Page number to return, starting at 1. Defaults to 1.
integer
Batches per page, up to 100. Defaults to 20.

Full request example

JavaScript

Response fields

Referred other merchants? Referral earnings are withdrawn through a separate family under /api/v1/me/referrals: GET /summary, GET /withdrawals, and POST /withdrawals (+ MFA, permission referrals:manage). Same whitelist + MFA model as the other withdrawal and payout endpoints.

Errors

See also