v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Batch Payments

List items for an internal transfer batch

This endpoint returns returns a paginated list of items in the specified batch. You will need to enable PERM_BUSINESS_GET_BATCH_INTERNALTRANSFERS to use this endpoint.

get/v1/batches/{batchUuid}/internaltransfers

Path parameters

batchUuidstring required

The uuid of the batch.

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

Query parameters

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

A fire.com list object of Batch Items (Internal transfers or Bank transfers).

totalinteger

total number of batches returned

Example response

{
  "total": 1,
  "items": [
    {
      "batchItemUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
      "status": "SUCCEEDED",
      "result": {
        "code": 500001,
        "message": "SUCCESS"
      },
      "dateCreated": "2021-04-04T10:48:53.540Z",
      "lastUpdated": "2021-04-04T10:48:53.540Z",
      "amountAfterCharges": 10000,
      "icanFrom": 2150,
      "icanTo": 1002,
      "amount": 10000,
      "ref": "Testing a transfer via batch",
      "refId": 123782
    }
  ]
}