Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Batch Payments

Create a new batch

This endpoint will create a new batch. This opens a new batch container to hold specific transaction types in a certain currency. You will need to enable PERM_BUSINESS_POST_BATCHES to use this endpoint.

post/v1/batches

Request body

type'BANK_TRANSFER' | 'INTERNAL_TRANSFER' | 'INTERNATIONAL_TRANSFER'

The type of the batch - can be one of the listed 3

currencystring

3 digit ISO code for the currency you wish to send - GBP, EUR, USD, CAD, etc...

batchNamestring

An optional name you give to the batch at creation time.

jobNumberstring

An optional job number you can give to the batch to help link it to your own system.

callbackUrlstring

An optional POST URL that all events for this batch will be sent to.

Example request

{
  "currency": "EUR",
  "batchName": "January 2018 Payroll",
  "jobNumber": "2022-01-PR",
  "callbackUrl": "https://my.webserver.com/cb/payroll"
}

Response

Batch created successfully

batchUuidstring

A UUID for this item.

Example response

{
  "batchUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019"
}