POLi Link Report


It is possible to get a wide variety of information through the POLi Link reporting features provided by the POLi API. The Status command is a reporting feature but provides minimal information. Through the usage of the list and payments commands listed below, you can acquire information to help you reconcile customer payments.

Command Usage
List Provides a full list of POLi Links created by the merchant. It is effectively the same as the Status command but returns a batch of statuses and other basic information about the POLi Link
Payments Provides a comprehensive transaction history for a single POLi Link. Great for reconciling payments, especially when extended features like partial payments is enabled. It can also be used to resolve customer issues through access to their attempts to pay with a POLi Link

POLi Link List Request


To get a full list of POLi Links created by the merchant:

https://publicapi.apac.paywithpoli.com/api/POLiLink/List

Download our API collection to generate code snippets of your preferred language


POLiLink List Response


An array of basic information on all the POLi Links
Name Description Type Values
TotalAmount The total amount the customer(s) pay when using the POLiLink Decimal Zero if the POLi Link is Variable, non-zero otherwise
TotalPaidAmount The cumulative amount paid towards the POLi Link over all transactions Decimal Must be zero for Variable link-type.Must be less than the merchant's individual transaction limit
Status The value returned by the API method Status String One of the statuses listed here
Transactions The transaction history of this POLi Link An array of LinkPayment objects

POLi Link Payments Request


To get a transaction history of a single POLi Link created by the merchant:

https://publicapi.apac.paywithpoli.com/api/POLiLink/Payments/[urlToken]

Download our API collection to generate code snippets of your preferred language


POLiLink Payments Response


An object that contains a transaction history for the specified POLi Link.
Name Description Type Values
TransactionRefNo The transaction reference number of the transaction (unique POLi ID) String
BankReceiptNo The number issued by the customer's bank for a completed payment String
BankReceiptDateTime The date/time the transaction was completed String
Status The final status of the transaction (differs from the POLi Link Status) String
AmountPaid The amount paid for that transaction Decimal Zero if the transaction was not completed
CompletionTime The date/time the transaction was completed Decimal Must be zero for Variable link-type.Must be less than the merchant's individual transaction limit
MerchantReference The MerchantReference specified when the POLiLink was created String
CustomerReference Data entered by the customer at the time of payment which uniquely identifies the customer and/or their payment String

POLi Link Report Example


                            
https://publicapi.apac.paywithpoli.com/api/POLiLink/List
                    
                
                            
https://publicapi.apac.paywithpoli.com/api/POLiLink/Payments/Tnxbd
                    
                

POLi Link Report Response Example


                            
[{
        "Created": "01/03/2018",
        "Reference": "CustomerRef12345",
        "Amount": 1.2,
        "MerchantData": "CustomerRef12345",
        "UrlToken": "https://poli.to/Tnxbd",
        "Status": "Completed"
    },
    {
        "Created": "01/03/2018",
        "Reference": "CustomerRef12345",
        "Amount": 1.2,
        "MerchantData": "CustomerRef12345",
        "UrlToken": "https://poli.to/5JJJJ",
        "Status": "Unused"
    },
    {
        "Created": "01/03/2018",
        "Reference": "CustomerRef12345",
        "Amount": 1.2,
        "MerchantData": "CustomerRef12345",
        "UrlToken": "https://poli.to/RV6Wn",
        "Status": "Future"
    },
    {
        "Created": "01/03/2018",
        "Reference": "CustomerRef12345",
        "Amount": 1.2,
        "MerchantData": "CustomerRef12345",
        "UrlToken": "https://poli.to/wsWnx",
        "Status": "PartPaid"
    },
    {
        "Created": "16/08/2017",
        "Reference": "MyRef01",
        "Amount": 1,
        "MerchantData": "",
        "UrlToken": "https://poli.to/PV6Wn",
        "Status": "Activated"
    }]
                    
                
                            
{
"TotalAmount": 1.2,
"TotalPaidAmount": 1.2,
"Status": "Completed",
"Transactions": [
    {
        "TransactionRefNo": "996108109899",
        "BankReceiptNo": "43822579-271770",
        "BankReceiptDateTime": "01 March 2018 12:19:26",
        "Status": "Activated",
        "AmountPaid": 1.2,
        "CompletionTime": "2018-03-01T12:19:26.303",
        "MerchantReference": "CustomerRef12345",
        "CustomerReference": null
    }
]
}