Skip to main content
POST
/
batches
Create Batch Payments
curl --request POST \
  --url https://api.synctera.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "dry_run": true,
  "tenant": "abcdef_ghijkl"
}
'
{
  "batches": [
    {
      "amount": 123,
      "batch_payment_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "batched_transfer_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "status": "CANCELLED",
      "payment_rail": "<string>",
      "payment_rail_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant": "abcdef_ghijkl",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "dry_run": true,
  "tenant": "abcdef_ghijkl"
}

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"