API ReferenceBatches

Submit a batch of requests

Creates a batch of requests and runs them asynchronously. Each element of data has to be compatible with the body expected by the operation. A batch representing the progress and the status of the process is returned as a result. You can retrieve the results using /v3/batches/:id/results once the batch has finished processing.

This endpoints supports up to 24960 requests.

Complete guide: Batches.

Headers

X-Api-KeystringRequired
X-Application-IdstringRequired

Request

This endpoint expects an object.
operation"POST /v3/transactions"Required
An enumeration.
datalist of objectsRequired

Response

Successful Response
idstring
A unique identifier for the batch.
operation"POST /v3/transactions"
An enumeration.
statusenum
The status of the batch. Results are not available for a batch with an error status.
Allowed values:
created_atdatetime
The timestamp of when the batch was created.
updated_atdatetime
The timestamp of when the batch was last updated.
progressinteger
The number of transactions processed so far.
totalinteger
The total number of transactions in the batch.

Errors