Batch Payment Summary

Batch payment summary including status, totals, and processing details.

merchantCodestring

Merchant code.

merchantNamestring

Merchant name (Trading name).

merchantUniqueBatchIdstring

Unique batch id provided by the merchant.

processingDatestring<date-time>

Batch processed date.

statusstring

One of:

• File Uploaded — Batch file is uploaded and pending file processing
• Pending — Payment is not processed yet
• Validation in Progress — Batch validation is in progress
• On Hold - Potential Duplicate — Batch is on hold awaiting manual activation
• Ready for Payment Processing — Batch duplicate validation is completed and now it is ready for Payment processing
• On Hold Approved
• Payment Processing in Progress — Batch payment processing in progress
• Completed — Batch payment processing completed
• Cancelled — Batch payment is cancelled
• BatchPay Not Allowed — Error in processing - Merchant status doesn't allow to process batch payment
• Merchant Not Found — Error in file/batch processing merchant code in file not found in database
• Technical Error — Any technical error like batch entry has been added twice

statusRemarksstring

Status remarks.

submittedDatestring<date-time>

Batch submitted date.

totalAmountnumber<double>

Total batch payment amount.

totalEntriesinteger<int32>

Total batch items in the batch.

Batch Payment Summary

{
  "merchantCode": "string",
  "merchantName": "string",
  "merchantUniqueBatchId": "string",
  "processingDate": "2024-07-29T15:51:28.071Z",
  "status": "string",
  "statusRemarks": "string",
  "submittedDate": "2024-07-29T15:51:28.071Z",
  "totalAmount": 0,
  "totalEntries": 0
}