Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Batch Payments

Get the details of a batch

This endpoint will return the details of the batch specified in the API endpoint - {batchUuid}. You will need to enable PERM_BUSINESS_GET_BATCH to use this endpoint.

get/v1/batches/{batchUuid}

Path parameters

batchUuidstring required

The uuid of the batch.

Example:4ADFB67A-0F5B-4A9A-9D74-34437250045C

Response

Returns the details of the batch specified in the API endpoint - {batchUuid}.

batchUuidstring

A UUID for this item.

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

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

status'PENDING_APPROVAL' | 'REJECTED' | 'COMPLETE' | 'OPEN' | 'CANCELLED' | 'PENDING_PARENT_BATCH_APPROVAL' | 'READY_FOR_PROCESSING' | 'PROCESSING'

status of the batch object

sourceNamestring

A string describing where the batch originated - for instance the name of the API token that was used, or showing that the batch was automatically created by fire.com (in the case of a new payee batch).

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.

currencystring

All payments in the batch must be the same currency.

numberOfItemsSubmittedinteger

A count of the number of items in the batch

valueOfItemsSubmittedinteger

A sum of the value of items in the batch. Specified in pence or cent.

numberOfItemsFailedinteger

Once processed, a count of the number of items that didn’t process successfully.

valueOfItemsFailedinteger

Once processed, a sum of the value of items that didn’t process successfully. Specified in pence or cent.

numberOfItemsSucceededinteger

Once processed, a count of the number of items that processed successfully.

valueOfItemsSucceededinteger

Once processed, a sum of the value of items that processed successfully. Specified in pence or cent.

lastUpdatedstring date-time

The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z

dateCreatedstring date-time

The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z

Example response

{
  "batchUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
  "status": "COMPLETE",
  "sourceName": "Payment API",
  "batchName": "January 2018 Payroll",
  "jobNumber": "2018-01-PR",
  "callbackUrl": "https://my.webserver.com/cb/payroll",
  "currency": "EUR, GBP, USD",
  "numberOfItemsSubmitted": 1,
  "valueOfItemsSubmitted": 10000,
  "numberOfItemsSucceeded": 1,
  "valueOfItemsSucceeded": 10000,
  "lastUpdated": "2021-04-04T10:48:53.540Z",
  "dateCreated": "2021-04-04T10:48:53.540Z"
}