Skip to main content

Batch Payment Entry

Individual entry within a batch payment including amount, status, and reference.

additionalReferencestring

Additional reference. (Conditional).

baseAmountnumber<double>

Base amount of the payment is done.

cardCategorystring

Card category.

cardTypeStringstring

Card scheme the payment was processed on, as text. For example: Visa.

cardTypeValueinteger<int32>

Card scheme the payment was processed on, as its numeric code. Pairs with cardTypeString.

companyNamestring

Customer company name.

customerFeenumber<double>

Fee charged on customer card.

customerNamestring

Customer who paid the payment.

customerReferencestring

Reference of the Customer who paid the payment.

entryStatusstring

One of:

  • BatchPay Entry Pending — This Entry is waiting to be processed
  • BatchPay Entry Processed — Payment for this Entry has been successfully processed
  • Customer not found — This Customer is not found in system. Create the Customer using POST - /v2/customers API
  • Duplicate entry — There is a duplicate entry in the batch. Remove duplicate entry
  • Multiple customers found — The System has detected that there is Multiple Customers that have the same Reference setup. Check Customers and update reference
  • Customer status is not open — Corresponding customer for batchpay entry is not in open state. Update Customer Status to Open
  • Payment end date has expired — Payment End Date for BatchPay Entry has expired. Update Date to a future date
  • Payment option is not BatchPay — Customer's Payment Option needs to be BatchPay in order to be processed. Update Customer Payment Option to BatchPay
  • Customer status does not allow payment processing — Customer Status is invalid. Customer Status must be Open to process payments. Check Status of Customer
  • Invalid payment amount — Payment amount is not valid. Check amount and resubmit
  • Error during payment processing — There was an error while processing payment. Please contact Zenith Payments
  • Technical Error — This Entry has encountered an unhandled error. Please contact Zenith Payments
  • Cancelled — Batch is cancelled
  • DuplicatePaymentUniqueId — Duplicate payment unique id
failureCodestring

Failure code if the payment failed. Please refer: http://tinyurl.com/y6lkmpsv for more details. (Conditional).

failureReasonstring

Failure reason if the payment failed. (Conditional).

isPaymentRecalledboolean

Payment recalled.

isPaymentRefundedboolean

Payment refunded.

isPaymentRetryScheduledboolean

Whether a retry payment is pending. Based on Program/Merchant settings, a failed payment will be retried.

lastDigitsstring

Payment Card No.

merchantCodestring

Merchant code.

merchantFeenumber<double>

Fee charged on Merchant.

merchantNamestring

Merchant trading name.

merchantUniquePaymentIdstring

Unique payment id provided by the merchant. (Conditional).

merchantWithheldAmountnumber<double>

Funds to Merchant.

paymentAmountnumber<double>

Total payment amount including the fees.

paymentCardstring

Payment card used.

paymentDatestring<date-time>

Payment date.

paymentMethodstring

Method was used to process the transaction. ie: Bank Account, Credit Card, etc.

paymentReferencestring

Unique Payment Reference for the payment done.

paymentResourcestring

Link to the actual payment.

paymentStatusstring

One of:

  • Pending — This Payment is waiting to be processed
  • Error — This Payment has encountered an Error
  • Submitted — This Payment was successfully submitted
  • Successful — This Payment was successful
  • Successful (Recalled) — This Payment was Recalled. The System has detected that this Entry potentially has been submitted in another Batch
  • Successful (Refunded) — This Payment was Refunded
  • Successful (Refunded) (Recalled) — This Payment was Refunded and Recalled
  • Failed — This Payment has Failed
  • Cancelled — This Payment was Cancelled
  • Suppressed — This Payment was Suppressed
  • InProgress — This Payment is being processed
processedAmountnumber<double>

Total payment amount including the fees.

processingDatestring<date-time>

Processing Date for the payment. Date Format: yyyy-MM-ddTHH:mm:ssZ, TimeZone: AEST.

processorReferencestring

Processor reference for the payment done.

recalledOnstring<date-time>

Recalled date. Date Format: yyyy-MM-ddTHH:mm:ssZ, TimeZone: AEST (Conditional).

recalledReasonstring

Reason. (Conditional).

refundedOnstring<date-time>

Refunded date. Date Format: yyyy-MM-ddTHH:mm:ssZ, TimeZone: AEST (Conditional).

refundedReasonstring

Reason. (Conditional).

retryPaymentReferencestring

Retry payment reference. (Conditional).

retryPaymentResourcestring

Link to the retry payment.

retryPaymentStatusstring

Retry payment status.

retryScheduledOnstring<date-time>

Retry payment scheduled date. Date Format: yyyy-MM-ddTHH:mm:ssZ, TimeZone: AEST (Conditional).

settlementDatestring<date-time>

Settlement Date for the payment. This is a calculated date and may change until the payment been settled. Date Format: yyyy-MM-ddTHH:mm:ssZ, TimeZone: AEST.

settlementReferencestring

Reference for the settlement this entry was paid out in. Empty until the payment settles.

subCardTypeStringstring

Card sub-type where the scheme has one, as text. Empty when the scheme has none.

subCardTypeValueinteger<int32>

Card sub-type as its numeric code. Pairs with subCardTypeString.

Batch Payment Entry
{
  "additionalReference": "string",
  "baseAmount": 0,
  "cardCategory": "string",
  "cardTypeString": "string",
  "cardTypeValue": 0,
  "companyName": "string",
  "customerFee": 0,
  "customerName": "string",
  "customerReference": "string",
  "entryStatus": "string",
  "failureCode": "string",
  "failureReason": "string",
  "isPaymentRecalled": true,
  "isPaymentRefunded": true,
  "isPaymentRetryScheduled": true,
  "lastDigits": "string",
  "merchantCode": "string",
  "merchantFee": 0,
  "merchantName": "string",
  "merchantUniquePaymentId": "string",
  "merchantWithheldAmount": 0,
  "paymentAmount": 0,
  "paymentCard": "string",
  "paymentDate": "2024-07-29T15:51:28.071Z",
  "paymentMethod": "string",
  "paymentReference": "string",
  "paymentResource": "string",
  "paymentStatus": "string",
  "processedAmount": 0,
  "processingDate": "2024-07-29T15:51:28.071Z",
  "processorReference": "string",
  "recalledOn": "2024-07-29T15:51:28.071Z",
  "recalledReason": "string",
  "refundedOn": "2024-07-29T15:51:28.071Z",
  "refundedReason": "string",
  "retryPaymentReference": "string",
  "retryPaymentResource": "string",
  "retryPaymentStatus": "string",
  "retryScheduledOn": "2024-07-29T15:51:28.071Z",
  "settlementDate": "2024-07-29T15:51:28.071Z",
  "settlementReference": "string",
  "subCardTypeString": "string",
  "subCardTypeValue": 0
}