Overview
Notifications for batch behave a bit different as they always refer to the order and not each individual debit/credit.
Pending
Immediately after the batch has been accepted for processing, a pending notification is sent to the NotificationURL submitted when setting up the batch.
Example notification
{
"method": "pending",
"params": {
"signature": "fVhjuMqbsH0Ku ... S16VbzRsw==",
"uuid": "258a2184-2842-b485-23ca-293425152415",
"data": {
"amount": "98.02",
"currency": "GBP",
"messageid": "98348932",
"orderid": "87654567",
"notificationid": "4876513450",
"paymentdate": "2024-10-11"
}
},
"version": "1.1"
}Cancel
The cancel notification will be sent for a batch if it could not be processed.
Example notification
{
"method": "cancel",
"params": {
"uuid": "258a2184-9021-b874-21ca-293425152415",
"data": {
"orderid": "87654567",
"messageid": "98348932",
"notificationid": "4876513450",
"attributes": {
}
},
"signature": "F6+hjuMqbsH0Ku ... S16VbzRsw==",
},
"version": "1.1"
}Batch
Sent when the batch has been processed and the result report is available for download on the SFTP server. Note that this file will be available after a couple of days and depends on the processing time for the scheme. If a change occurs after the first notification, subsequent notifications will be sent containing only the instructions affected. So, eg for UK, if the batch notification is sent after three days, a reversal happens on two instructions after 6 days, a new batch notification will be sent and the csv will ONLY contain those instructions and their state.
Example notification
{
"method": "batch",
"params": {
"signature": "F6+hjuMqbsH0Ku ... S16VbzRsw==",
"uuid": "258a2184-9021-b874-21ca-293425152415",
"data": {
"messageid": "98348932",
"orderid": "87654567",
"notificationid": "4876513450",
"attributes": {
"batchfile": "batch.csv",
"reportchecksum": "0cdf0945096283b9ba94e42150ba84d8",
"reportfile": "batch.csv_20230215_report.csv",
"executed": 1231,
"failed": 0
}
}
},
"version": "1.1"
}