GET
/
v1
/
a2a
/
batches
/
{id}

Path Parameters

id
string
required

The batch transfer ID to fetch

Query Parameters

auditUser
string
required

The audit user to log the request

exclusiveStartKey
object

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

size
integer
default: 25

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

Response

200 - application/json
id
string
required

Enfuce generated id for batch transfer.

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
description
string

Free form description.

startTime
string
required

Batch transfer start time.

transferItemCount
integer
required

Number of transfer items in the batch.

totalAmount
object

Map of total amount per currency.

completionTime
string

Batch transfer completion time.

successfulTransferItems
integer

Number of successful transfer items in the batch.

failedTransferItems
integer

Number of failed transfer items in the batch.

transfers
object
required