Become a client

Batch

Get Batch resource allows a Partner to return information on the requested batch representation. This includes numbers of requested and received payments as well as the aggregate amount.

Table - Get Batch resource

Resource Template
                            /customers/{id}/batches/{id}
                          
Http Method GET
Description

Returns requested batch's representation.

CreateOn timestamp will indicate when batch was created.

LastUpdatedOn will reflect the following events:

  • a payment added to a batch
  • a batched payment's cancellation
  • batch was quoted
  • batch was committed
Input
                            {
}
                          
Output
                            200 OK 
{
"reference":"<partner generated reference for a batch>",
"createdOn":"<timestamp>","lastUpdatedOn":"<timestamp>",
"numberOfReceivedPayments":"<total number of received payments>",
"numberOfAcceptedPayments":"<total number of accepted payments>",
"aggregateAmounts":
[
{
"currency" :"<currency code>","settlementCurrency":"<currency code>",
"amount":"amount","settlementAmount":"amount", isFixedOnSettlement":
<true/false>
}
]
}
                          
Output; (errors)
                            404 Not Found - if customer not found