POLi
POLi is a real-time online payment service used in Australia. It integrates with major banks throughout Australia and enables consumers to make direct payment through their internet banking accounts. POLi is available only for the consumers available in Australia.
POLi is a supported browser payment method in the Mastercard Gateway. This page describes integration details specific to POLi. It is recommended that you read the integration guidelines for browser payments, before building a POLi integration.
POLi browser payments are supported for transactions in the AUD currency.
Prerequisites
To offer POLi as a payment method via the Mastercard Gateway:
- You must be registered with your browser payments service provider.
- Your merchant profile on the gateway must be configured using the details of your account with the browser payments service provider.
- You must have a bank account in one of the supported currencies registered against your merchant account at your browser payments service provider.
POLi Integration
With Hosted Checkout integrations version 52 and later, POLi is automatically available to your payers when you are enabled and configured for it by your payment service provider.
For details, see Browser Payments via Hosted Checkout Integration.
Direct Payment integration allows you to offer POLi payment method on your own checkout page.
In addition to the standard fields required in a browser payment request, provide the following fields in the Initiate Browser Payment request:
sourceOfFunds.type=POLIbrowserPayment.operation=PAY(the Authorize operation is not supported by POLi)sourceOfFunds.provided.poli.bankAccountHolder: The name of the bank account holder for the payer's bank account.
Preferred Language
You can set the language that you prefer POLi to use for pages displayed to the payer by providing the browserPayment.preferredLanguage field in the Initiate Browser Payment request. However, the language will be used only if POLi supports it.
{
"apiOperation":"INITIATE_BROWSER_PAYMENT",
"browserPayment":{
"operation":"PAY",
"returnUrl":"https://<return_url>"
},
"order": {
"amount": "10.00",
"currency": "AUD"
},
"sourceOfFunds": {
"type": "POLI",
"provided": {
"poli": {
"bankAccountHolder": "John Smith"
}
}
}
}
How to Interpret the Transaction Result
The table below shows the transaction response codes for the possible scenarios you may encounter after initiating a POLi payment.
Initiate Browser Payment Response |
What This Means... |
|---|---|
response.gatewayCode=SUBMITTEDresult=SUCCESS |
Redirect the payer using the URL provided in the response. |
Retrieve Transaction/Retrieve Order Response |
What This Means... |
response.gatewayCode=APPROVEDresult=SUCCESSsourceOfFunds.provided.poli.bankAccountHolder
|
The payment is successful. |
response.gatewayCode=PENDINGresult=PENDING |
The Mastercard Gateway is waiting for a notification from the acquirer about the payment result. Try RETRIEVE_TRANSACTION again later or listen to notifications from the Mastercard Gateway. |
response.gatewayCode=CANCELLEDresult=FAILURE |
The payer has cancelled the interaction for this payment. Offer the payer the option to try another payment method. |
response.gatewayCode=DECLINED or ACQUIRER_SYSTEM_ERRORresult=FAILURE |
The payment was declined. Offer the payer the option to try another payment method. In the case of an ACQUIRER_SYSTEM_ERROR you may want to inquire with the acquirer the reason for payment failure, or you can try RETRIEVE_TRANSACTION again. |
response.gatewayCode=TIMED_OUTresult=FAILURE |
Treat this as a declined payment. The Mastercard Gateway will make any attempt to ensure the transaction was not successful or will revert the transaction. |
Testing Your Integration
The Mastercard Gateway provides a browser payments emulator that allows you to test your POLi integration.