Skip to main content
POST
Create a payment batch
Creates an empty payment batch. Add recipients with the add recipient or bulk add recipients endpoints, then start the payouts with withdraw. Requires the PAYMENT_METHOD.CREATE key permission.

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. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

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.

Body

application/json
name
string
required

A label for the batch.

sourcePaymentMethod
object
required

The wallet the batch is funded from. Every payout is converted from this currency. Other keys are ignored and not stored.

Response

The batch was created

data
object

A payment batch, including the method payouts are funded from.