GET
/
batches
Get Batch Payments
curl --request GET \
  --url https://api.synctera.com/v1/batches \
  --header 'Authorization: Bearer <token>'
[
  {
    "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",
    "payment_rail": "<string>",
    "payment_rail_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "CANCELLED",
    "tenant": "abcdef_ghijkl",
    "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
id
string<uuid>

ID of the Batch Payment

​
status
string

Status of the Batch Payment

​
template_id
string<uuid>

ID of the Batch Payment Template

​
transaction_id
string<uuid>

ID of the Batch Payment Transaction

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

Response

Retrieve all Batch payments

A collection of batch payments

​
amount
integer
required

The total amount of the batch transfer.

​
batch_payment_template_id
string<uuid>
required

The ID of the batch Payment template that was used to create the batch.

​
batched_transfer_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.

​
creation_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required
Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

​
last_updated_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
status
enum<string>
required

The status of a Batch

Available options:
CANCELLED,
COMPLETED,
DECLINED,
INITIATED,
PENDING_APPROVAL,
PENDING_PAYMENT,
RETURNED
​
payment_rail
string

The payment rail that was used to process the batch.

​
payment_rail_transfer_id
string<uuid>

The ID of the payment rail transfer that was used to process the batch.

​
tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
transaction_id
string<uuid>

The transaction ID of the batch which represents a transaction on the ledger.