Skip to main content
GET
/
v1
/
a2a
/
batches
Get all batch transfers
curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transfer/v1/a2a/batches' \
  --header 'Authorization: Basic <encoded-value>'
{
  "size": 123,
  "items": [
    {
      "id": "11221122",
      "status": "IN_PROGRESS",
      "startTime": "2023-11-29T14:57:00",
      "transferItemCount": 2,
      "description": "Test batch transfer",
      "totalAmount": {
        "EUR": 100,
        "NOK": 150
      },
      "completionTime": "2023-11-29T15:31:00",
      "successfulTransferItems": 1,
      "failedTransferItems": 1
    }
  ],
  "lastEvaluatedKey": {
    "institutionId": "<string>",
    "startTime": "<string>",
    "id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enfuce.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
auditUser
string
required

The audit user to log the request

​
exclusiveStartKey
object

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

​
size
integer
default:25

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

Required range: 1 < x < 50

Response

Successful lookup of batch transfers

​
size
integer
required

Number of items returned in the response

​
items
BatchTransferResponseWithoutTransferItems · object[]
required

An array of batch transfers

​
lastEvaluatedKey
object

Key used for pagination. Use these values in the request for exclusiveStartKey to fetch the next page.