Skip to main content
GET
/
v1
/
a2a
/
batches
/
{id}
/
status
Get batch transfer status by given ID
curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transfer/v1/a2a/batches/{id}/status' \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The batch transfer ID to fetch

Query Parameters

​
auditUser
string
required

The audit user to log the request

Response

Successful lookup of batch transfer status

​
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<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.

Example:
{ "EUR": 100, "NOK": 150 }
​
completionTime
string<date-time>

Batch transfer completion time.

Example:

"2023-11-29T15:31:00"

​
successfulTransferItems
integer

Number of successful transfer items in the batch.

Example:

1

​
failedTransferItems
integer

Number of failed transfer items in the batch.

Example:

1