Batch Processing Api
Batch processing uses the Batch and Instalment Service (BIS) which allows for transaction processing against cardholder accounts using a dynamic batch file. For merchants who process on their own schedules with dynamic or fixed amounts, the service allows for the presentation of cardholder account references and transaction requirements to run as a scheduled batch.
A batch process request is used to start the batch process workflow by uploading batch data and initialising a new batch for processing. Once validated the batch will be queued for processing and further updates can be received by a subsequent call to retrieve the batch status.
Request
{
"batch_date":"2020-01-02",
"batch_id":35,
"client_account_id":"AC1",
"transactions":[
{
"account_id":"aaabbb-cccddd-eee",
"amount":19995,
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"merchantid":11223344
}
]
}
Response
{
"message":"Approved 044332",
"valid":true
}
Obtains a batch and installment (BIS) report for a given batch id.
Request
{
"batch_id":35,
"client_account_id":"AC1"
}
Response
{
"amount":19995,
"batch_date":"2020-01-02",
"batch_id":35,
"batch_status":"COMPLETE",
"client_account_id":"AC1",
"transactions":[
{
"account_id":"aaabbb-cccddd-eee",
"amount":19995,
"authcode":"001245A",
"datetime":"2020-01-02T18:32:28Z",
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"maskedpan":"4***********0002",
"merchantid":11223344,
"message":"Approved 044332",
"result":1,
"result_code":"000",
"scheme":"Visa",
"scheme_id":"MC",
"scheme_logo":"https://cdn.citypay.com/img/cs/visa-logo.svg",
"transno":78416
}
]
}
The operation is used to retrieve the status of a batch process.
Request
{
"batch_id":[
78,
79
],
"client_account_id":"AC1"
}
Response
{
"batches":[
{
"batch_date":"2020-01-02",
"batch_id":35,
"batch_status":"COMPLETE"
}
]
}