Create account to account batch transfer

POST

a2a

batches

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transfer/v1/a2a/batches' \
  --header 'Authorization: Bearer <token>' \
  --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",
  "startTime": "2023-11-29T14:57:00",
  "transferItemCount": 2,
  "description": "Test batch transfer",
  "totalAmount": {
    "EUR": 100,
    "NOK": 150
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

AccountToAccountTransferRequest · object[]

required

An array of transfer requests

Show child attributes

transfers.fromAccountId

string<biginteger>

required

Id of account from which balance will be debited

transfers.toAccountId

string<biginteger>

required

Id of account from which balance will be credited

transfers.amount

number

required

Transfer amount. It is possible to post only amount which is equal or more than minimal currency unit (For example, for EUR, SEK, NOK minimal unit is 0,01)

transfers.currency

string

required

Currency of the amount in ISO 4217 (Alpha code) format. Currency has to be the same as account currency. Balance transfer can only be done between accounts that are in the same currency, i.e. currency conversion is not supported.

Example:

"EUR"

transfers.text

string

Free form text. Text is available in Transaction API as well as Data export transaction files.

Maximum string length: 255

description

string

Free form description.

Maximum string length: 255

Response

Successful creation of batch transfer

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<date-time>

required

Batch transfer start time.

Example:

"2023-11-29T14:57: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.

Show child attributes

totalAmount.{key}

number

Example:

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

⌘I

Create account to account batch transfer

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transfer/v1/a2a/batches' \
  --header 'Authorization: Bearer <token>' \
  --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",
  "startTime": "2023-11-29T14:57:00",
  "transferItemCount": 2,
  "description": "Test batch transfer",
  "totalAmount": {
    "EUR": 100,
    "NOK": 150
  }
}