Skip to main content
POST
Create Batch Payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Attributes of the Batch Payment

transaction_ids
string<uuid>[]
required

The IDs of the transfers that are part of the batch. These values can be modified by the client before the batch is in a terminal status.

dry_run
boolean

Whether or not the batch should be created as a dry run. If the batch is created as a dry run, the batch will not be processed.

tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

Response

Successful creation of a Batch Payment

batches
Batch Payment · object[]
required

A collection of batch payments

dry_run
boolean

Whether or not the batch should be created as a dry run. If the batch is created as a dry run, the batch will not be processed.

tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"