Merchant API schemas

Label for the account.

Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies api for card.

Customer reference linked to this additional reference.

Full name associated with the additional reference.

Additional reference. (Conditional).

Base amount of the payment is done.

Card category.

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

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

Customer company name.

Fee charged on customer card.

Customer who paid the payment.

Reference of the Customer who paid the payment.

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

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

Failure reason if the payment failed. (Conditional).

Payment recalled.

Payment refunded.

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

Payment Card No.

Merchant code.

Fee charged on Merchant.

Merchant trading name.

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

Funds to Merchant.

Total payment amount including the fees.

Payment card used.

Payment date.

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

Unique Payment Reference for the payment done.

Link to the actual payment.

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

Total payment amount including the fees.

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

Processor reference for the payment done.

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

Reason. (Conditional).

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

Reason. (Conditional).

Retry payment reference. (Conditional).

Link to the retry payment.

Retry payment status.

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

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.

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

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

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

Merchant code.

Merchant name (Trading name).

Unique batch id provided by the merchant.

Batch processed date.

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

Status remarks.

Batch submitted date.

Total batch payment amount.

Total batch items in the batch.

Additional reference for the payment entry.

Base payment amount before fees.

Company name associated with this payment entry.

Fee charged to the customer.

Name of the customer for this payment entry.

Reference identifier for the customer in this payment entry.

Email address for payment notifications.

Current status of this payment entry.

Error code for the payment failure.

Reason the payment failed.

Whether the payment has been recalled.

Whether the payment has been refunded.

Whether a payment retry has been scheduled.

Last digits of the payment card used.

Merchant code.

Fee charged to the merchant.

Merchant trading name.

Amount withheld from the merchant.

Mobile number for payment notifications.

Reference for a one-off payment.

Amount to be paid in this entry.

Card details associated with the payment.

Scheduled date for the payment.

Method used for payment (e.g. card, direct debit).

Unique reference for the payment transaction.

Resource identifier for the payment.

Payment processing status.

Total amount processed including fees.

Date the payment was processed.

Reference assigned by the payment processor.

Date and time the payment was recalled.

Reason the payment was recalled.

Date and time the payment was refunded.

Reason the payment was refunded.

Reference to the parent request-to-pay batch.

Reference for the retry payment transaction.

Resource identifier for the retry payment.

Status of the retry payment.

Date and time the retry is scheduled for.

Date the payment was settled.

Merchant code.

Merchant trading name.

Merchant-assigned unique identifier for the request-to-pay batch.

Date and time the request-to-pay was processed.

Current processing status of the request-to-pay.

Additional remarks about the request-to-pay processing status.

Date and time the request-to-pay was submitted.

Total monetary amount of all entries in the request-to-pay.

Total number of entries in the request-to-pay.

Account Holder name.

Bank Account number.

Bank branch.

Bank Name.

BSB Number. Format: 000000.

Bank account is PayTo if true.

Label for the account.

If PayTo account, this field will let you know the status of the Mandate.

Customer reference in individual payment batch entry.

Unique payment id provided by the merchant. Can be used when Proxy payment is performed. (Optional).

Pass an alternative Proxy if required (Optional). If no Proxy is passed, the nominated card / bank account is used.

Payment amount in individual payment batch entry.

Collection of BatchPayment entry.

Unique batch id provided by the merchant.

Id of BatchPayment.

Merchant code.

Merchant trading name.

Unique batch id provided by the merchant.

WarningMessages after processing batch.

BPAY Biller Code.

BPAY Biller Reference.

Additional reference. This field is returned in reconciliation reports.

Unique payment id provided by the merchant.

One Off Payment reference. This field is returned in reconciliation reports.

Amount to capture.

Flag to send the customer invoice.

ABN for the transaction.

Payment Card No.

Additional reference. (Conditional).

Base amount of the payment is done.

Card category.

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

Reason. (Conditional).

ChargedBackedTransactionReference : If a charge transaction is charged back then this is transaction reference of charged back transaction.(Conditional).

Fee charged on customer card.

Customer who paid the payment.

Reference of the Customer who paid the payment.

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

Failure reason if the payment failed. (Conditional).

Funds to Merchant.

Payment Charge Backed.

Payment recalled.

Payment refunded.

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

Whether the payment has been settled to the merchant.

Merchant code.

Fee charged on Merchant.

Merchant trading name.

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

One Off Payment Reference.

OriginalTransactionReference : For a Recall / Refund transaction, it is the transaction reference of original transaction.

Payment Account by which the payment is done.

Total payment amount including the fees.

Payment card used.

Unique Payment Reference for the payment done.

Payment source of transaction.

Current Status of the payment. Expected Statuses

1. Pending This Payment is waiting be to processed
2. Error - This Payment has encountered an Error
3. Submitted - This Payment was successfully submitted
4. Successful - This Payment was successful
5. Successful(Recalled) - This Payment was Recalled
6. Successful(Refunded) - This Payment was Refunded
7. Successful (Refunded) (Recalled) - This Payment was Refunded and Recalled
8. Failed - This Payment has Failed
9. Cancelled - This Payment was Cancelled
10. Suppressed - This Payment was Suppressed
11. InProgress - This Payment is being processed.

Preauth expiry in minutes.

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

Processor reference for the payment done.

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

Reason. (Conditional).

RecalledTransactionReference : If a charge transaction is recalled then this is transaction reference of recall transaction.(Conditional).

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

Reason. (Conditional).

RefundedTransactionReference : If a charge transaction is refunded then this is transaction reference of refunded transaction.(Conditional).

Remaining preauth amount after one or more captures.

Retry payment reference. (Conditional).

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

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

Transaction type numeric code.

Transaction Type. Possible values:

1. Charge
2. Invoice
3. Refund
4. Chargeback
5. Recall
6. Fixed Term Settlement.

Card holder name.

Credit/Debit Card number.

Customer unique identifier.

Card expiry in MM/yy format.

Amount is optional. If provided, the applicable pricing will be returned in the result.

Conditional. Pass the values if 3DSecure is required.

Obfuscated card number.

Processor token. Used to make payment next time.

Card type (Visa, MasterCard etc.).

Card expiry in MM/yy format.

Failure code in case the authorisation fails.

Failure reason in case the authorisation fails.

Applicable pricing based on provided card and payment details.

3DSecure redirect url to complete the 3DSecure challege if required by the scheme.

Proxy status Expected Statuses

1. Pending This proxy is waiting be to processed
2. Successful - This proxy was successful
3. Failed - This proxy has Failed
4. PendingThreeDS - This proxy needs to complete 3DSecure process using the RedirectUrl.

Card number.

Card Type.

Expiry.

Label for the card.

Card proxy generated by the /cardproxies api.

Label for the card.

Reason the credit request was cancelled.

Credit request amount.

Reference for the credit transaction.

Merchant code.

Merchant trading name.

Reason the credit request was rejected.

Reason for the credit request.

Status code of the credit request.

Status label for the credit request.

Unique identifier for the credit request.

Status code of the credit request.

Payment amount.

Customer name.

Customer reference.

Payment Account Proxy.

Credit reason.

Unique credit id provided by the merchant.

Additional PaymentAccountProxies. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.

Customer bank account details. Provide valid BSB and Account Number.

Customer credit / debit card proxy. Proxy is generated using the /cardProxies API or Payments Plugin.

This replaces the BankAccount and CreditCardProxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.

Customer bank account details.

Customer credit card details.

Address line 1.

Address line 2.

Country.

Postcode.

State / province.

Suburb / city.

BPAY details.

Payment start date.

Notification method used to indicate the communication channel when payment successful or failed.

PayID details.

Payment amount. Set the default amount for auto payments or amount for one-off payment.

Payment end date.

Payment frequency. Applicable to auto pay, email reminder and sms reminder. Returns monthly if frequency is not available.

Payment option. Use the correct payment option which is supported by the merchant.

Australian Business Number.

Customer postal address.

BPay reference number for the customer.

Name of the customer company.

Unique code assigned to the customer.

Unique reference identifier for the customer.

Current status of the customer account.

Date the customer account was closed.

Customer date of birth.

Customer email address.

Whether BPay payment option is enabled for this customer.

Customer fax number.

Customer first name.

Customer last name.

Staff member assigned to the customer.

Customer mobile phone number.

Date the customer account was opened.

Customer phone number.

Customer title (e.g. Mr, Mrs, Ms).

Australian Business Number.

Customer postal address.

Name of the customer company.

Customer date of birth.

Customer email address.

Whether BPay payment option is enabled for this customer.

Customer fax number.

First name.

Last name.

Staff member assigned to the customer.

Customer mobile phone number.

Customer phone number.

Provide the salutation. Eg: Mr or Mrs.

Customer Payment account.

Merchant code.

Merchant trading name.

Customer payment option.

Customer profile.

True to close, false to open.

Reason if the customer is closed.

Australian Business Number.

Customer postal address.

Name of the customer company.

Customer date of birth.

Customer email address.

Whether BPay payment option is enabled for this customer.

Customer fax number.

Customer first name.

Customer last name.

Staff member assigned to the customer.

Customer mobile phone number.

Customer phone number.

Customer title (e.g. Mr, Mrs, Ms).

Gets the request message which led to this result.

Gets or sets the error message.

Gets or sets the exception object.

Gets a ModelErrorCollection object that contains any errors that occurred during model binding.

Gets a ValueProviderResult object that encapsulates the value that was being bound during model binding.

Australian Business Number.

Additional PaymentAccountProxies. Proxy is generated using the Payments Plugin for Bank and Credit/Debit Card or /cardProxies api for Credit/Debit Card.

Additional references if you have more than one references to manage. Eg: Parents paying childcare fee for more than one kid.

Customer address.

Customer bank account details.

Customer credit / debit card proxy. (Token is generated using the /tokens api.

Company name if this is company account.

Customer / Parent Reference. Should be unique and provided by the merchant. If you are paying the merchant by BPAY, this should be your BPAY Reference.

Date of birth. Customer must be atleast 16 years old.

Email address.

Allows to enable BPAY option for the customer / parent.

Fax number.

First name.

Send this as true when customer reference passed if CRN. Default is set to false if not passed.

Last name.

Merchant Staff member assigned to this customer / parent.

Mobile number.

Notification method used to indicate the communication channel when payment successful or failed.

This replaces the BankAccount and Card properties. Proxy is generated using the Payments Plugin for Bank and Credit/Debit Card or /cardProxies api for Credit/Debit Card.

Payment amount. Set the default amount for auto payments or amount for one-off payment.

Payment end date.

Payment frequency. Applicable to auto pay, email reminder and sms reminder.

Payment option. Use the correct payment option which is supported by the merchant.

Payment start date.

Phone number.

Promotion code if any.

Sends welcome email if set to true. Default is set to true if not passed.

Provide the salutation. Eg: Mr or Mrs.

Website URL if any.

Australian Business Number.

Additional PaymentAccountProxies. Proxy is generated using the Payments Plugin for Bank and Credit/Debit Card or /cardProxies api for Credit/Debit Card.

Additional references if you have more than one references to manage. Eg: Parents paying childcare fee for more than one kid.

Customer address.

BPAY details.

Customer bank account details.

If BPAY payment method is enabled, biller code will be returned.

If BPAY payment method is enabled, biller reference can be used by the customer to make BPAY payment.

Customer credit / debit card proxy. (Token is generated using the /tokens api.

Company name if this is company account.

Customer login.

Customer / Parent Reference. Should be unique and provided by the merchant. If you are paying the merchant by BPAY, this should be your BPAY Reference.

Date of birth. Customer must be atleast 16 years old.

Email address.

Allows to enable BPAY option for the customer / parent.

Fax number.

First name.

Send this as true when customer reference passed if CRN. Default is set to false if not passed.

Last name.

Merchant code.

Merchant trading name.

Merchant Staff member assigned to this customer / parent.

Mobile number.

Notification method used to indicate the communication channel when payment successful or failed.

Password generation for customer login.

PayID details.

This replaces the BankAccount and Card properties. Proxy is generated using the Payments Plugin for Bank and Credit/Debit Card or /cardProxies api for Credit/Debit Card.

Payment amount. Set the default amount for auto payments or amount for one-off payment.

Payment end date.

Payment frequency. Applicable to auto pay, email reminder and sms reminder.

Payment option. Use the correct payment option which is supported by the merchant.

Payment start date.

Phone number.

Promotion code if any.

Sends welcome email if set to true. Default is set to true if not passed.

Provide the salutation. Eg: Mr or Mrs.

Website URL if any.

PayID.

PayID Name.

Reference.

Account name (Bank/PayTo accounts).

Account number (Bank/PayTo accounts).

Type of payment account.

BSB code (Bank/PayTo accounts).

Card expiry date (Card accounts only).

Card holder name (Card accounts only).

Masked card number (Card accounts only).

Card type (Card accounts only).

PayId identifier (PayId accounts only).

PayId display name (PayId accounts only).

PayTo status (PayTo accounts only).

3DS payload (Card accounts only).

Processor name (Card accounts only).

Processor token (Card accounts only).

Status description (PayTo accounts only).

Unique identifier (PayTo accounts only).

Authorisation code returned by the card issuer.

Retrieval reference number assigned by the acquirer, used when tracing the transaction with them.

System trace audit number identifying the transaction on the acquirer's network.

Name of the cardholder.

Card number.

Card verification value.

Card expiry month.

Card expiry year.

Customer Australian Business Number.

Additional reference. This field is returned in reconciliation reports.

PAN detail.

Card Proxy (Conditional). Use only if you want to pay using card proxy.

Customer company name.

Customer contact number.

The customer email to which an invoice is sent to.

Customer name.

Customer reference. Required only when payment account proxy or card proxy is not provided.

Unique payment id provided by the merchant.

One Off Payment reference. This field is returned in reconciliation reports.

Override Fee Payer. This field is to determine who is paying transaction fee. 0 Use Set Profile - default 1 Merchant Pays Fee (if allowed) 2 Customer Pays Fee (if allowed).

Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.

Payment amount.

Flag to send the customer invoice.

Optional. 3DSecure details.

ABN for the transaction.

Payment Card No.

Acquirer and issuer references for the transaction, returned for card payments.

Additional reference. (Conditional).

Base amount of the payment is done.

Card category.

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

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

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

Reason. (Conditional).

ChargedBackedTransactionReference : If a charge transaction is charged back then this is transaction reference of charged back transaction.(Conditional).

All chargebacks processed on this payment.

Unique customer code if the customer exists in the system.

Fee charged on customer card.

Customer who paid the payment.

Reference of the Customer who paid the payment.

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

Failure reason if the payment failed. (Conditional).

Funds to Merchant.

Payment Charge Backed.

Payment recalled.

Payment refunded.

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

Whether the payment has been settled to the merchant.

Merchant code.

Fee charged on Merchant.

Merchant trading name.

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

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

One Off Payment Reference.

OriginalTransactionReference : For a Recall / Refund transaction, it is the transaction reference of original transaction.

Payment Account by which the payment is done.

Total payment amount including the fees.

Payment card used.

Unique Payment Reference for the payment done.

Payment source of transaction.

Current Status of the payment. Expected Statuses

1. Pending This Payment is waiting be to processed
2. Error - This Payment has encountered an Error
3. Submitted - This Payment was successfully submitted
4. Successful - This Payment was successful
5. Successful(Recalled) - This Payment was Recalled
6. Successful(Refunded) - This Payment was Refunded
7. Successful (Refunded) (Recalled) - This Payment was Refunded and Recalled
8. Failed - This Payment has Failed
9. Cancelled - This Payment was Cancelled
10. Suppressed - This Payment was Suppressed
11. InProgress - This Payment is being processed.

Preauth expiry in minutes.

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

Processor reference for the payment done.

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

Reason. (Conditional).

RecalledTransactionReference : If a charge transaction is recalled then this is transaction reference of recall transaction.(Conditional).

All recalls processed on this payment.

3DSecure redirect url to complete the 3DSecure challege if required by the scheme.

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

Reason. (Conditional).

RefundedTransactionReference : If a charge transaction is refunded then this is transaction reference of refunded transaction.(Conditional).

All refunds processed on this payment.

Remaining preauth amount.

Retry payment reference. (Conditional).

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

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

How often the merchant is settled, as text. For example: Monthly.

How often the merchant is settled, as its numeric code. Pairs with settlementFrequencyString.

Balance Payment if any is available.

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

Whether the merchant is settled gross or net of fees. For example: Gross.

Stock keeping unit field 1.

Stock keeping unit field 2.

Sub card type.

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

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

Transaction type numeric code.

Transaction Type. Possible values:

1. Charge
2. Invoice
3. Refund
4. Chargeback
5. Recall
6. Fixed Term Settlement.

Build version.

Server Date Time.

DateTime Time Zone.

API version.

Custom label to override default customer name display text.

Custom label to override default customer reference display text.

Hide the plugin header. Defaults to false if not provided.

This will hide the merchant logo if any. Defaults to 'false' if not provided.

Custom label to override default payment amount display text.

Plugin Title. Defaults to 'Process Payment' if not provided.

Conditional if mode is set to 0. Show AliPay+ option only if the option is enable for the merchant.Default is false.

Conditional if mode is set to 0. Show Apple Pay option only if the option is enable for the merchant.Default is false.

Conditional. Required if mode is set to 0 or 2. Show bank account option only if the option is enable for the merchant.Default is false.

Conditional. Required if mode is set to 0 or 2. Show card option only if the option is enable for the merchant.Default is true.

Conditional. Required if mode is set to 0 or 2. Show card tokenise option only if the option is enable for the merchant.Default is true.

Conditional if mode is set to 0. Show Google Pay option only if the option is enable for the merchant.Default is false.

Conditional if mode is set to 0. Show Latitude Pay option only if the option is enable for the merchant.Default is false.

Conditional. Required if mode is set to 0 or 2. Show PayID option only if the option is enable for the merchant.Default is false.

Conditional. Required if mode is set to 0 or 2. Show PayTo option only if the option is enable for the merchant.Default is false.

Conditional if mode is set to 0. Show Slice Pay option only if the option is enable for the merchant.Default is false.

Conditional if mode is set to 0. Show UnionPay option only if the option is enable for the merchant.Default is false.

Conditional if mode is set to 0. Show WeChat Pay option only if the option is enable for the merchant.Default is false.

Customer Australian Business Number.

Additional reference. This field is returned in reconciliation reports.

PAN detail.

Card Proxy (Conditional). Use only if you want to pay using card proxy.

Customer company name.

Customer contact number.

The customer email to which an invoice is sent to.

Customer name.

Customer reference. Required only when payment account proxy or card proxy is not provided.

Unique payment id provided by the merchant.

One Off Payment reference. This field is returned in reconciliation reports.

Override Fee Payer. This field is to determine who is paying transaction fee. 0 Use Set Profile - default 1 Merchant Pays Fee (if allowed) 2 Customer Pays Fee (if allowed).

Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.

Preauth amount.

Optional. 3DSecure details.

ABN for the transaction.

Payment Card No.

Additional reference. (Conditional).

Base amount of the payment is done.

Card category.

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

Reason. (Conditional).

ChargedBackedTransactionReference : If a charge transaction is charged back then this is transaction reference of charged back transaction.(Conditional).

Fee charged on customer card.

Customer who paid the payment.

Reference of the Customer who paid the payment.

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

Failure reason if the payment failed. (Conditional).

Funds to Merchant.

Payment Charge Backed.

Payment recalled.

Payment refunded.

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

Whether the payment has been settled to the merchant.

Merchant code.

Fee charged on Merchant.

Merchant trading name.

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

One Off Payment Reference.

OriginalTransactionReference : For a Recall / Refund transaction, it is the transaction reference of original transaction.

Payment Account by which the payment is done.

Payment card used.

Payment source of transaction.

Total payment amount including the fees.

Preauth Expires at.

Unique Payment Reference for the payment done.

Current Status of the payment. Expected Statuses

1. Pending This Payment is waiting be to processed
2. Error - This Payment has encountered an Error
3. Submitted - This Payment was successfully submitted
4. Successful - This Payment was successful
5. Successful(Recalled) - This Payment was Recalled
6. Successful(Refunded) - This Payment was Refunded
7. Successful (Refunded) (Recalled) - This Payment was Refunded and Recalled
8. Failed - This Payment has Failed
9. Cancelled - This Payment was Cancelled
10. Suppressed - This Payment was Suppressed
11. InProgress - This Payment is being processed.

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

Processor reference for the payment done.

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

Reason. (Conditional).

RecalledTransactionReference : If a charge transaction is recalled then this is transaction reference of recall transaction.(Conditional).

3DSecure redirect url to complete the 3DSecure challege if required by the scheme.

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

Reason. (Conditional).

RefundedTransactionReference : If a charge transaction is refunded then this is transaction reference of refunded transaction.(Conditional).

Remaining preauth amount after one or more captures.

Retry payment reference. (Conditional).

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

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

Transaction type numeric code.

Transaction Type. Possible values:

1. Charge
2. Invoice
3. Refund
4. Chargeback
5. Recall
6. Fixed Term Settlement.

Error code.

Error message.

Fee paid by the customer.

Fee paid by the merchant.

Payment amount i.e. base amount excluding any fee.

Total amount charged to the card, including any fee.

Applicable pricing based on provided card and payment details.

Refund Amount (Conditional). Amount is required when Refund Value is 'Partial' (2).

Reason for the refund request.

Refund Request Unique Id.

Refund value - Defaults to 'BaseAmount' (1) if not passed.

Additional Reference.

Reason for the refund request cancellation. This field will returned only if the status is 'Canceled'.

Merchant code.

Merchant trading name.

Payment Reference.

Refund Amount.

Refund Request Unique Id.

Refund value.

Refund value (Human readable).

Reason for the refund request rejected. This field will returned only if the status is 'Rejected'.

Reason for the refund request.

Refund request status.

Refund request status (Human readable).

Unique batch id provided by the merchant.

Collection of RequestPayment entry.

Customer reference in individual payment request entry.

Customer email in individual payment request entry. Use comma or semicolon to provide more than one email address for a customer.

First name of the customer.

Last name of the customer.

Unique payment id provided by the merchant. Can be used when Proxy payment is performed. (Optional).

Customer mobile in individual payment request entry.

Payment amount in individual payment request entry.

Merchant code.

Merchant trading name.

Unique request pay batch id provided by the merchant.

Id of RequestPay for call to Uploading.

WarningMessages after processing batch.

Additional reference for reconciliation reports.

Optional. This will allow to save the card information. Defaults to 'false' if not provided. This option will only work if 'Enable Plugin Pay & Save Card' option is enabled at program or merchant level.

Allowed Payment methods.

Set by the plugin. Leave it out of your request.

Optional. Business Number (For example: ABN). Used for reward programs if the Program is enabled to provide reward points.

Optional. The URL will be called with HTTP POST method to submit the result. Refer to Payment Plugin documentation for payment response payload.

Optional. Customer company name.

Optional. Contact number.

Required. Email address to which invoice will be emailed if the merchant is configured. It is mandatory from V4.

Conditional. Required if mode is set to 0 or 2.

Conditional. Required if mode is set to 0 or 2.

Optional. Fields to customize the plugin fields.

Conditional. DepartureDate is required for Slice Pay. Provide date in UTC ISO 8601 format as departureDate. format: yyyy-MM-dd.

Optional. Must be one of the following two values 0 - Default(Modal) 1 - Redirect Url. Defaults to 0 if not provided. *Google Pay and Apple Pay works if Modal or Redirect Url with iframe is used.

Endpoint url of the plugin. Just provide the base url. For example: https://pay.travelpay.com.au.

Set by the plugin. Leave it out of your request.

Optional. This will hide the Terms and Conditions. Defaults to 'false' if not provided.

Is JS Plugin. Default is true. Set to false if you want to use without iframe.

Merchant code. Make sure the merchant code is related to the API credentials.

Required. Payment id provided by the merchant. Must be unique and can not be reused if a transaction is processed using this id. This field also work as IdempotencyKey for request for successful requests.

Optional. Must be one of the following three values 0 - Make Payment 1 - Tokenise 2 - Custom Payment 3 - Preauthorization. Defaults to 0 if not provided.

Optional. Must be one of the following three values 0 - Default(based on pricing profile) 1 - Merchant(Merchant will pay the fee regardless of pricing profile setting) 2 - Customer(Customer will pay the fee regardless of pricing profile setting) Defaults to 0 if not provided.

Conditional. Use this parameter to make a payment using a payment account proxy which is generated using mode '1'.

Conditional. Required if mode is set to 0 or 2. Returns applicable fee if provided with mode 1.

All errors/exceptions will be return back the caller using the redirect url.

Required. The page will redirect to this URL with the result in the query string. Refer the return parameters section below.

Optional. This will send confirmation email to customer. Defaults to 'false' if not provided.

Optional. This will send confirmation email to merchant. Defaults to 'false' if not provided.

Optional if mode is set to 1. Show the applicable failed payment fees for the token at the end of the process.Default is false.

Required if mode is set to 1. Show the applicable fees for the token at the end of the process.Default is false.

Optional. Stock Keeping Unit - Optional text fields, allowing up to 50 alphanumeric characters. If the value exceeds 50 characters, only the first 50 characters will be retained and the rest discarded.

Optional Stock Keeping Unit - Optional text fields, allowing up to 50 alphanumeric characters. If the value exceeds 50 characters, only the first 50 characters will be retained and the rest discarded.

Required. Timestamp is required from v4. Provide current datetime in UTC ISO 8601 format as timestamp. format: yyyy-MM-ddTHH:mm:ss.

Optional. Must be one of the following two values 0 - Customer Facing - default (cardholder must enter CCV or 3DS) 1 - Merchant Facing(for merchant use only - no CCV or 3DS) - if supported by merchant options.

Required. Plugin version. Always use the latest.

Payment plugin endpoint url.

Expiry of the secure token.

Token used to initialize the payment plugin.

Amount to be settled to the merchant.

Date payment will be settled to the merchant.

Processing date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST.

Current Status of the balance payment. Expected Statuses

1. Pending
2. Error
3. Submitted
4. Successful
5. Failed
6. Cancelled
7. Suppressed
8. InProgress.

TransactionReference.

Fee charged on Customer.

Fee charged on Merchant.

Total payment amount including the fees.

Refund/Recall date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).

Reason. (Conditional).

Current Status of the refund/recall. Expected Statuses

1. Pending This refund/recall is waiting be to processed
2. Error - This refund/recall has encountered an Error
3. Submitted - This refund/recall was successfully submitted
4. Successful - This refund/recall was successful
5. Failed - This refund/recall has Failed
6. Cancelled - This refund/recall was Cancelled
7. Suppressed - This refund/recall was Suppressed
8. InProgress - This refund/recall is being processed.

TransactionReference : If a charge transaction is refunded/recalled then this is transaction reference of that transaction.(Conditional).

Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder's browser.

Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property. Possible values: 1, 4, 8, 15, 16, 24, 32, 48.

IP address of the browser as returned by the HTTP headers to the 3DS Requestor.

Value representing the browser language as defined in IETF BCP47. The value is limited to 1-8 characters. Value is returned from navigator.language property.

Total height of the Cardholder's screen in pixels. Value is returned from the screen.height property.

Total width of the Cardholder's screen in pixels. Value is returned from the screen.width property.

Time difference between UTC time and the Cardholder browser local time, in minutes. The field is limited to 1-5 characters where the value is returned from the getTimezoneOffset() method.

Exact content of the HTTP user-agent header. The field is limited to maximum 2048 characters. Obtained from Cardholder browser using the navigator.userAgent property.

Cardholder's browser data. Mandatory if UseThreeDSecure is true.

Endpoint to receive status notifications once 3DSecure is completed. Use [uniqueId] (case sensitive) in URL to differentiate different payments and 3DS statuses For example: CallbackUrl https://www.yourdomain.com.au/3dsecure/[uniqueId] will be translated to https://www.yourdomain.com.au/callbacks/123456 assuming uniqueId is 123456.

Redirect URL used to redirect once the 3DSecure process is completed. Use [uniqueId], [status] (case sensitive) in URL to differentiate different payments and 3DS statuses For example: RedirectUrl https://www.yourdomain.com.au/3dsecure/[uniqueId]?status=[status] will be translated to https://www.yourdomain.com.au/3dsecure/123456?status=Success assuming uniqueId is 123456 Possible 3DSecure statuses: Success, Failed, Cancelled.

Will trigger 3DSecure process if enabled or valid for the card.

Obfuscated card number.

Card proxy that can be used to process payment.

Card type (Visa, MasterCard etc.).

Card expiry in MM/yy format.

Proxy status.

Gets or sets the raw value that is converted to a string for display.

Gets or sets the culture.

Gets or set the raw value that is supplied by the value provider.

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

Failure reason if the payment failed. (Conditional).

Unique Payment Reference for the payment done.

Current Status of the void. Expected Statuses

1. Pending This Payment is waiting be to processed
2. Error - This Payment has encountered an Error
3. Submitted - This Payment was successfully submitted
4. Successful - This Payment was successful
5. Successful(Recalled) - This Payment was Recalled
6. Successful(Refunded) - This Payment was Refunded
7. Successful (Refunded) (Recalled) - This Payment was Refunded and Recalled
8. Failed - This Payment has Failed
9. Cancelled - This Payment was Cancelled
10. Suppressed - This Payment was Suppressed
11. InProgress - This Payment is being processed.