Payment request

Request File

Specification

Additional details of the field specifications can be found in API documentation for Create a Payment Request.

Field	Type and Length	Description
clientId	string [ 5 .. 50 ] characters	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.
clientTransactionId	string [ 5 .. 100 ] characters	Unique Id for the transaction created by the merchant system
payID	string [ 5 .. 50 ] characters	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.
paymentExpiryDatetime	string <date-time>	Timestamp when the payment request expires and is no longer able to accept payments. The associated PayID is also de-registered at this time. Cannot be set if multiPayment is set to true.
paymentAmount	number	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.
paymentDescription	string [ 5 .. 140 ] characters	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.
multiPayment	boolean	When set to true, allows adhoc payments to a PayID. If true paymentExpiryDatetime can not be set. Defaults to false.

Example

clientId,clientTransactionId,payID,paymentExpiryDatetime,paymentAmount,paymentDescription,multiPayment
CLIENT1,INV3442345,[email protected],2021-09-31T10:00:00Z,123.45,Water bill April to July 2021,true
CLIENT1,INV3442346,[email protected],2021-09-31T10:00:00Z,166.45,"Water bill April to July 2021",true
CLIENT1,INV3442347,[email protected],,178.95,Water bill April to July 2021,false