Once a batch is submitted you can periodically request a batch status to determine the current state of the batch processing including a count of the total uploaded, processed, and erred operations as well as time and date stamps on processing actions. The same batch status is also visible to your payment service provider via the Batch Integration Status Search screen in Merchant Manager.
You can request a batch status on demand by sending a HTTPS GET request to:
where:
The response body will contain a summary of processing in csv format with one header row and a detail row.
A sample batch status summary file in csv format showing batch status as "COMPLETE".
"merchantId","batchName","totalRecords","uploadCompleted","batchStatus","processed","errors","lastAction","processingCompleted" "TESTMERCHANT","testfile20110818a","46","2011-08-18T10:40:20+10:00","COMPLETE","46","0","2011-09-11T02:36:10+10:00","2011-08-18T10:40:30+10:00"
The following table describes the information returned in the batch response file.
merchantId |
The merchant’s unique alphanumeric identifier. There is a unique Merchant ID for each merchant account/profile. |
batchName |
The batch file name used during initial upload. |
totalRecords |
The total number of operations in the batch. |
uploadCompleted |
The time and date uploading of all records was completed. |
batchStatus |
The current batch processing status. Valid values are:
|
processed |
The total count of records processed. |
errors |
The total count of records which have timed out or could not be processed due to system errors. |
lastAction |
Time and date of the last action on the batch. |
processingCompleted |
The time and date when the batch processing completes and all records are in their final state. |
The next step is processing the batch response.