Skip to main content
POST
Start the payouts for a batch
Starts the payouts for a batch: creates a payout transaction for every recipient in one call and records the run as a session. The payouts settle asynchronously.
A webhook callback URL must be configured before you call this, otherwise you have no way to observe individual payout outcomes. Subscribe to Transaction Events for the per-recipient status updates, and poll List Batch Sessions for the overall run.
Passing the previous run’s sessionId retries only the payouts that failed on that run; calling withdraw while a run is still in progress on the same batch is refused with 409. Requires the TRANSACTION.WITHDRAW.CREATE key permission.
If request signing is enabled, sign the query parameters with defaults applied: a call with no sessionId signs {}.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint is rejected with a 401 Unauthorized response, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire. Manage your keys and their permissions under Developer → API keys in the dashboard.

The permission each endpoint requires is below. Where several are listed, any one of them is enough. Keys created before permissions existed carry none and keep access to every endpoint.

Headers

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

Path Parameters

batchId
string
required

Id of a batch belonging to the calling business.

Query Parameters

sessionId
string

Id of an earlier run of this batch (from the sessions list). Only the recipients that failed in that run are paid.

Response

Per-recipient outcomes, keyed by recipientId.

data
object