v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Batch Payments

List all batches

This endpoint will return a list of batches with the specified types and statuses. You will need to enable PERM_BUSINESS_GET_BATCHES to use this endpoint.

get/v1/batches

Query parameters

batchTypes'INTERNAL_TRANSFER' | 'BANK_TRANSFER' | 'INTERNATIONAL_TRANSFER' | 'NEW_PAYEE'

The type of the batch. Can be one of the listed enums.

Example:INTERNAL_TRANSFER

orderBy'DATE'

You can order the batches by date. No other options at this time

Example:DATE

order'DESC' | 'ASC'

You can order the batches by ascending or descending order.

Example:DESC

offsetinteger

The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will return records 40 to 59.

limitinteger

The number of records to return. Defaults to 10 - max is 200.

Response

List all batches.

totalinteger

total number of batches returned

Example response

{
  "total": 1,
  "batchRequests": [
    {
      "batchItemUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
      "sourceName": "Account Information Test",
      "batchName": "Test Batch",
      "jobNumber": "1234optional",
      "currency": "EUR",
      "numberOfItemsSubmitted": 1,
      "valueOfItemsSubmitted": 100,
      "numberOfItemsFailed": 1,
      "valueOfItemsFailed": 100,
      "lastUpdated": "2021-04-04T10:48:53.540Z",
      "dateCreated": "2021-04-04T10:48:53.540Z"
    }
  ]
}