Skip to main content
GET
Get a batch
Fetch a single mass-payout batch, including its per-recipient legs.
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.
cURL

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: 120/min.

Parameters

string
required
The batch id to fetch (from List payout batches).

Full request example

JavaScript
The per-recipient legs generated by a batch also surface in the withdrawals history when queried with filter=all (GET /api/v1/withdrawals?filter=all). The default filter=manual returns only your own withdrawal rows and hides mass-payout legs.

Errors

See also