Skip to main content
POST
Cancel a batch
Cancel a queued mass-payout batch. Legs that are still pending are refunded to your balance.
Only legs still pending are refunded — legs that already went out are not coming back. Check the batch with Get a batch after cancelling to see which legs were stopped in time.
cURL

Authorization

Dashboard-only (JWT) with the mass-payouts:manage team permission. API keys are not accepted — an API key gets 401 {"error":"Invalid or expired token"}. Unlike the create call, cancelling is not MFA-gated — a valid dashboard session with the permission is enough (cancelling only returns pending funds to your own balance). Rate limit: 10/min.

Parameters

string
required
The batch id to cancel (from List payout batches).
The endpoint takes no request body.

Full request example

JavaScript

Errors

See also