POST
/
v1
/
a2a
/
batches
curl --request POST \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/transfer/v1/a2a/batches \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Test batch transfer",
  "transfers": [
    {
      "fromAccountId": "12345678",
      "toAccountId": "98765432",
      "amount": 123.45,
      "currency": "EUR",
      "text": "Payment for 987654321"
    },
    {
      "fromAccountId": "56565656",
      "toAccountId": "34343434",
      "amount": 23.5,
      "currency": "EUR"
    }
  ]
}'
{
  "id": "11221122",
  "status": "IN_PROGRESS",
  "description": "Test batch transfer",
  "startTime": "2023-11-29T14:57:00",
  "transferItemCount": 2,
  "totalAmount": {
    "EUR": 100,
    "NOK": 150
  }
}

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json
The fields that you want to apply to your batch transfer
​
transfers
object[]
required

An array of transfer requests

​
description
string

Free form description.

Maximum length: 255

Response

200
application/json
Successful creation of batch transfer
​
id
string
required

Enfuce generated id for batch transfer.

Example:

"11221122"

​
status
enum<string>
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.

Available options:
IN_PROGRESS,
COMPLETED,
FAILED,
COMPLETED_WITH_ERRORS
Example:

"IN_PROGRESS"

​
startTime
string
required

Batch transfer start time.

Example:

"2019-01-28T00:00:00"

​
transferItemCount
integer
required

Number of transfer items in the batch.

Example:

2

​
description
string

Free form description.

Example:

"Test batch transfer"

​
totalAmount
object

Map of total amount per currency.

Example:
{ "EUR": 100, "NOK": 150 }