Payment request - Batch

clientId

Id of the client creating the request for payment. This is supplied by azupay and only changes between environments. For example, you might be allocated CLIENT1TEST for the UAT environment and CLIENT1 for production.

string [ 5 .. 50 ] characters

Mandatory

clientTransactionId

Unique Id for the transaction created by the merchant system

string [ 5 .. 100 ] characters

Mandatory

payID

Unique email PayID for this transaction. Value supplied here is the PayID used by your customer to make payment. If not supplied, Azupay will generate one automatically. The PayID's domain must match one of the configured domains for the client.

string [ 5 .. 50 ] characters

Not mandatory Generated if not provided

paymentExpiryDatetime

Timestamp when the payment request expires and is no longer able to accept payments. The associated PayID is also de-registered at this time. If blank, the PayID will not expire.

string (datestamp in ISO 8601 format)

Not mandatory if multiPayment is true.

paymentAmount

Amount in AUD requested to pay for the transaction. Not mandatory if multiPayment is true. If multiPayment is true then it can be set to accept adhoc payments up to this amount.

string [number to two decimal places]

Not mandatory if multiPayment is true

paymentDescription

Description of this transaction. First 140 characters becomes the PayID name that appears in the customer's OLB when they lookup the PayID. Must not contain any of the customer's personal information.

string [ 5 .. 140 ] characters

Mandatory

multiPayment

When set to true, allows adhoc payments to a PayID. Defaults to false.

boolean (true, false)

Not mandatory. Defaults to false if not provided.