v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB

Account to account batch transfer

Create account to account batch transfer

Please note that this feature requires manual configuration. If you want to use it, please contact your CSM.

This operation will create a batch transfer with the given transfer items.

post/v1/a2a/batches

Query parameters

auditUserstring required

The audit user to log the request

Request body

descriptionstring

Free form description.

Example request

{
  "transfers": [
    {
      "currency": "EUR"
    }
  ]
}

Response

Successful creation 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.

Example response

{
  "id": "11221122",
  "status": "IN_PROGRESS",
  "description": "Test batch transfer",
  "startTime": "2019-01-28T00:00:00",
  "transferItemCount": 2,
  "totalAmount": {
    "EUR": 100,
    "NOK": 150
  }
}