The POLi API is a RESTful Web API that hosts various web services, including POLi Link integration.
You are required to encode your merchant code and authentication code as the username and password to be supplied with the 'Authorization' header in each request you make to the POLi API, Learn More. When supplied, the POLi API web service generates a short Payment URL.
{info} Note:
Your codes are protected by the security of SSL.
When performing POST and GET actions, you have the following content options:
| Request Header | Description | Supported Values |
|---|---|---|
| Content-Type | When performing a POST action, you are telling the POLi API what format the provided data is | application/json or application/xml |
| Accept | When the POLi API is providing a response, this tells the POLi API what format you would like the data to be packaged as | application/json or application/xml |
If you have your merchant and authentication codes ready, you can use them to login and view the POLi Public API Reference help page.
All POLi Link API methods have the following URL format:
https://poliapi.apac.paywithpoli.com/api/POLiLink/[Command]?[Parameters]
| Name | Parameters | Details |
|---|---|---|
| Echo | Any string value | The method returns the string that was provided. This method is useful for doing basic REST communication tests with our service, from your implementation |
| Create | A NewPaymentLink object that defines the payment | Creates a POLi Link payment with the specified payment details which can be used by a customer to initiate a transaction |
| Status | A string containing the POLi Link URL token | Returns a string that contains the overall transaction status of the POLi Link |
| Payments | A string containing the POLi Link URL token | Returns a collection of transactions initiated by this specified POLi Link. Useful for reconciling payments made to a POLi Link |
| FromToken | A string containing a transaction token | Returns a POLi Link URL token if the specified transaction was initiated by a POLi Link. This is useful for custom receipt pages |
| List | No parameters | Returns a full list of POLi Links with basic information |
For more information about POLi Link, please see the relevant pages:
To find a POLi Link for a TransactionReference:
https://publicapi.apac.paywithpoli.com/api/POLiLink/FromToken?token=[transactionToken]
Visit API Introduction to generate code snippets of your preferred language.
| Method | Parameters | Details |
|---|---|---|
| GET | A string containing a transaction token. The merchant would normally receive this via a nudge | A string containing a POLi Link urlToken associated with the specified transaction token. An empty string indicating the transaction was not associated with a POLi Link |
This will mark a POLi Link as expired and stops future transactions from being initiated against it:
https://poliapi.apac.paywithpoli.com/api/POLiLink/Expire?urlToken=[urlToken]
Visit API Introduction to generate code snippets of your preferred language.
| Method | Parameters | Details |
|---|---|---|
| GET | 'urlToken' - The 5 character POLi Link Token, e.g.: aBcDe | HTTP Code 200 for success HTTP Code 400 for failure |