Payment Request
Payment request including customer reference or card proxy, amount, and optional 3D Secure details.
Customer Australian Business Number.
Additional reference. This field is returned in reconciliation reports.
card object
PAN detail.
Name of the cardholder.
Card number.
Card verification value.
Card expiry month.
Card expiry year.
Length: >= 4 characters and <= 4 characters
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.
Max length: <= 50 characters
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).
| Enum Value | Description |
|---|---|
| 0 | Default |
| 1 | Merchant |
| 2 | Customer |
paymentAccountProxy object
Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.
Label for the account.
Max length: <= 80 characters
Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies api for card.
Max length: <= 40 characters
Payment amount.
Flag to send the customer invoice.
threeDSecureData object
Optional. 3DSecure details.
browserData object
Cardholder's browser data. Mandatory if UseThreeDSecure is true.
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.
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.
{
"abn": "string",
"additionalReference": "string",
"card": {
"cardHolder": "string",
"cardNumber": "string",
"cvv": "string",
"expiryMonth": "string",
"expiryYear": "string"
},
"cardProxy": "string",
"companyName": "string",
"contactNumber": "string",
"customerEmail": "string",
"customerName": "string",
"customerReference": "string",
"merchantUniquePaymentId": "string",
"oneOffPaymentReference": "string",
"overrideFeePayer": 0,
"paymentAccountProxy": {
"label": "string",
"proxy": "string"
},
"paymentAmount": 0,
"sendPaymentConfirmation": true,
"threeDSecureData": {
"browserData": {
"acceptHeader": "string",
"colorDepth": 0,
"ipAddress": "string",
"language": "string",
"screenHeight": 0,
"screenWidth": 0,
"timezone": "string",
"userAgent": "string"
},
"callbackUrl": "string",
"redirectUrl": "string",
"useThreeDSecure": true
}
}