GET
/
v1
/
a2a
/
batches
/
{id}
Get full batch transfer information with transfer items by given ID
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/transfer/v1/a2a/batches/{id}
{
  "id": "11221122",
  "status": "IN_PROGRESS",
  "description": "Test batch transfer",
  "startTime": "2023-11-29T14:57:00",
  "transferItemCount": 2,
  "totalAmount": {
    "EUR": 100,
    "NOK": 150
  },
  "completionTime": "2023-11-29T15:31:00",
  "successfulTransferItems": 1,
  "failedTransferItems": 1,
  "transfers": {
    "lastEvaluatedKey": {
      "batchTransferId": "<string>",
      "status": "<string>",
      "transferId": "<string>"
    },
    "size": 123,
    "items": [
      {
        "id": "<string>",
        "creditTransaction": {
          "id": "<string>",
          "errorMessage": "<string>"
        },
        "debitTransaction": {
          "id": "<string>",
          "errorMessage": "<string>"
        },
        "reversalTransaction": {
          "id": "<string>",
          "errorMessage": "<string>"
        },
        "status": "COMPLETED",
        "type": "A2A",
        "fromId": "12345678",
        "toId": "987654321",
        "amount": 100,
        "currency": "EUR"
      }
    ]
  }
}

Path Parameters

​
id
string
required

The batch transfer ID to fetch

Query Parameters

​
auditUser
string
required

The audit user to log the request

​
exclusiveStartKey
object

Key used for transfer item pagination. Use values from lastEvaluatedKey returned by the response to fetch the next page.

​
size
integer
default:25

How many transfers should be returned per page, default is 25. Cannot be more than 50.

Required range: 1 < x < 50

Response

200
application/json

Successful lookup of batch transfer

The response is of type object.