POLi Link is a method for merchants to collect payments.

POLi Links are ideal for billing and instances where payment is required outside of traditional online checkouts!

This method enables merchants to request payment from an individual outside of the ‘checkout’ scenario.
Merchants are able to generate a POLi Link which takes the form of a short URL, send this to the customer via email or place it for example within a pdf invoice.
When the POLi Link is clicked the user is taken to a POLI payment page prepopulated with relevant reference and amount data, as specified by the merchant when creating the POLi Link.

POLi Links can be created via Console one-by-one and in batches. They can also be created through automated integration with POLi Link API



Once you have an account with POLi, you will be able to access the console to create POLi Links.
Click here to go to the POLi Console!

1. Request Type – this can be Manual or Email. Selecting ‘Email’ requires additional information (customer name and customer email address) and triggers an email to the specified email address when the Payment URL is generated.
2. Amount – this is the amount of the POLi Link. This must be a valid currency value with up to two decimal points. The amount must be between 1.00 and 10000.00.
3. Your Reference – this is the Merchant reference for the payment. This field is displayed on your reports under the Merchant Reference column. This is a mandatory field and can contain up to 50 characters.
4. Merchant Data – this field can be used to specify additional transaction information or reference data. This field is displayed on your reports under the Merchant Data column. This is an optional field and can contain up to 100 characters.
5. Confirmation Email – check this box if you wish to receive a confirmation email when successful payment is made. The email is sent to your support email address as specified in your merchant configuration.
6. Customer Reference – check this box if you require the customer to enter reference details for the payment. This field is displayed on your reports under the Merchant Data column.
7. Multiple Payment – check this box if you wish to allow this POLi Link to be used multiple times. This link will not expire when used by a customer (however it can be set to expire on a specific date or manually via Manage POLi Links).
8. Payment URL Expiry – if you want to set an expiry date for a POLi Link request, it can be specified here. The generated POLi Link cannot be used on or after this expiry date.
If this field is left blank, no expiry date is set against the POLi Link.
9. Payment URL result field – when the Generate URL button is clicked and all data is successfully validated, the resulting Payment URL is displayed here. This URL can be copied using the copy icon below the field.
10. Clear button – clicking this button clears all data and URL information from the page
11. Generate URL button –clicking this button will validate the data entered in the fields on the page, and if successfully validated, will generate the Payment URL. The Email Request Type contains two further fields (see below):
12. Recipient Name – The name of the customer receiving the POLi Link. This information is included in the email sent to the customer. This can only contain letters, spaces, dashes and apostrophes, and is mandatory if Request Type is email.
13. Recipient Email - The email address of the customer receiving the POLi Link. This must be in a valid email format (e.g. abc@abcdef.com), and is mandatory if Request Type is email.



The Multiple POLi Link function can be used to generate a one or more POLi Links via uploading a batch file, in either Excel or CSV format.
Validation rules for each item in the batch file is as per the Single POLi Link.
See below for the details of each item on the Multiple POLi Link page:
1. Download Templates – these two icons link to downloadable templates in Excel and CSV format.
2. Select a File – to upload a Multiple POLi Link batch file, click “Browse…”, locate the file and click the Upload File button. Once upload is complete, the Last File Uploaded field will display the filename.
3. Clear button – clicking this button clears all data from the page, including URL information
4. Upload File button – Once a filename is displayed in the Select A File field, clicking this button will initiate file upload of the selected filename.
When a file has been successfully uploaded and validated, a successful message is displayed and the Generate URLs button is shown:
5. Successful validation message – when upload is complete and all data in the uploaded file has been successfully validated, this message is displayed
6. Valid POLi Link data notification – a green tick is displayed next to each successfully validated line item in the batch file
7. Generate URLs button – this button is displayed when all data has been successfully validated. Clicking this button will generate the Payment URL for each line item in the batch file. On clicking the Generate URLs button, the Payment URL for each line item in the batch file is displayed, and an email is sent to the Recipient Email Address for each POLi Link Type of Email.
8. Payment URL – the generated URL for the POLi Link is displayed here
9. Copy URL button – to copy the Payment URL for an individual line item to the clipboard, for pasting into a document or email, select the relevant line item and click this button
10. Export – click the icons to export the complete list of POLi Links displayed, including the generated Payment URLs, in either Excel or CSV format.

If any line item within the batch file contains invalid data, an error message is displayed and the details of the invalid data is displayed:
11. Validation Error message – this message will display if any of the data contained within the file does not pass validation on upload
12. Invalid data notification – this icon will display in the Status column for each line item that contains invalid data
13. Invalid data detail – the specific data that has failed validation will be displayed as crossed-out red text. This data will require correction and the file will need to be reuploaded with the corrected data.

The Multiple POLi Link function can be used to generate a one or more POLi Links via uploading a batch file, in either Excel or CSV format.



The Manage POLi Links page can be used to track all existing POLi Link requests for your merchant. This includes both active POLi Links and those that have expired, either due to being used, passing their expiry date, or by being manually expired.
See below for the details of each item on the Manage POLi Links page:

1. Request Type – The type of POLi Link request you are searching for. Can be selected from “All”, “Manual” or “Email”.
2. Payment Amount – The amount of the POLi Link(s) you are searching for. Can be any currency value. Only the specified amount will be returned in the search results
3. Payment Reference – The Payment Reference of the POLi Link(s) you are searching for. Some or all of the Reference can be specified and all POLi Links containing the search term will be returned.
4. Link Status – The status of the POLi Link request you are searching for. Can be selected from “All”, “Active” or “Expired”.
5. Expiry Date – The expiry date of the POLi Link(s) you are searching for. Can be any valid date value. Only the specified date will be returned in the search results. For expired POLi Links, this will be the date the Link expired (as opposed to any originally specified expiry date)
6. Recipient Name – The Recipient Name of the POLi Link(s) you are searching for. Some or all of the Name can be specified and all POLi Links containing the search term will be returned. Note this field will only be applicable to Email requests.
7. Recipient Email – The Recipient Email address of the POLi Link(s) you are searching for. Some or all of the Email address can be specified and all POLi Links containing the search term will be returned. Note this field will only be applicable to Email requests.
8. Date Created – The creation date of the POLi Link(s) you are searching for. Can be any valid date value. Only the specified date will be returned in the search results.
9. Expire Selected Links button – clicking this button will manually expire any currently selected POLi Links. Note that once a POLi Link is expired it cannot be made active again.
10. Search button – clicking this button submits the specified search criteria and returns all matching transactions.
11. Clear button – clicking this button clears all search filters and displays the complete list of POLi Links.
12. Select Payment checkbox – Check this box to select one or more POLi Links that you want to manually expire
13. Expired POLi Link icon – This icon indicates which POLi Links in the list have expired.

There is also a POLi Link Report available in Reporting. The search fields are as per the above but the report details are read-only, and the data can be exported.

polilink.txt · Last modified: 2017/05/16 16:04 (external edit)