Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Account to account batch transfer

Get full batch transfer information with transfer items by given ID

This operation will respond with a batch transfer and a list of transfer items for the given batch transfer ID.

get/v1/a2a/batches/{id}

Path parameters

idstring required

The batch transfer ID to fetch

Query parameters

auditUserstring required

The audit user to log the request

batchTransferIdstring
statusstring
transferIdstring

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

sizeinteger

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

Response

Successful lookup of batch transfer

idstring required

Enfuce generated id for batch transfer.

status'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'COMPLETED_WITH_ERRORS' required

Batch transfer status. IN_PROGRESS - Successfully created but not yet complited batch transfer. COMPLETED - Successfully completed batch transfer. FAILED - Completely or partially failed batch transfer.

descriptionstring

Free form description.

startTimestring date-time required
transferItemCountinteger required

Number of transfer items in the batch.

totalAmountobject

Map of total amount per currency.

completionTimestring date-time
successfulTransferItemsinteger

Number of successful transfer items in the batch.

failedTransferItemsinteger

Number of failed transfer items in the batch.

Example response

{
  "id": "11221122",
  "status": "IN_PROGRESS",
  "description": "Test batch transfer",
  "startTime": "2019-01-28T00:00:00",
  "transferItemCount": 2,
  "totalAmount": {
    "EUR": 100,
    "NOK": 150
  },
  "completionTime": "2019-01-28T00:00:00",
  "successfulTransferItems": 1,
  "failedTransferItems": 1,
  "transfers": {
    "items": [
      {
        "type": "A2A",
        "fromId": "12345678",
        "toId": "987654321",
        "amount": 100,
        "currency": "EUR"
      }
    ]
  }
}