The GetTransaction web service is used to enquire about the details of a transaction and can be used to obtain the current status of a transaction. When supplied with a valid transaction token, GetTransaction web service returns all current details relating to a transaction.
Merchants may call this web service at any time once a transaction has been initiated. The subsequent action to be taken by merchants upon receiving the GetTransaction response will depend on the transaction status returned. Centricom recommends that merchants log transaction enquiries and flag unexpected responses.
Common scenarios where GetTransaction web service is called are when a merchant is:
For an example of how to implement this functionality, click here.
For an overview of how POLi works, click here.
This API endpoint is a “GET” method.
To formulate a GetTransaction call, you must append the token to the query string like so:
To authenticate the request, you must use Basic Authorization. Click here to find out more.
|Field||Description||Data Type||Possible Values|
|TransactionRefNo||The POLi ID associated with the transaction.||String||A unique 12 digit reference to a POLi™ transaction.|
|CurrencyCode||The code of the currency used in the transaction.||String||Possible values are commensurate with ISO Standard ISO 4217.|
|CountryName||The plain text name of the country the transaction was per||String|
|CountryCode||The code of the country where the transaction takes place.||String||Possible values are commensurate with ISO Standard ISO 3166-1.|
|PaymentAmount||The Amount of the transaction||Decimal||Attempted payment amount|
|AmountPaid||The actual amount paid for the transaction||Decimal||Actual paid amount|
|EstablishedDateTime||The date and time of the POLi™ server when the InitiateTransaction request was received.||Datetime|
|MerchantEstablishedDateTime||The date and time in the entity's timezone that the transaction was established.||Datetime|
|StartDateTime||The date and time the transaction was started.||Datetime|
|EndDateTime||The date and time the transaction was completed.||Datetime|
|BankReceipt||The internet banking receipt number harvested from internet banking receipt page.||String nvarchar(100)||Not all banks provide bank receipt number for successful payment. This value will be null if the bank doesn’t provide a receipt number. If it is null, merchant can use ‘TransctonStatusCode’ and ‘ErrorCode’ to determine the payment outcome.|
|BankReceiptDateTime||The date and time of the bank receipt.||String|
|TransactionStatusCode||A code that indicates the current status of the transaction.||String||Possible values are:
|ErrorCode||An error code associated with the transaction, if any.||String||See Error Codes|
|ErrorMessage||A description of the error associated with the transaction, if any.||String|
|FinancialInstitutionCode||The code of the financial institution the payment was made from.||String||Consult the POLi™ Console for a complete listing of supported Financial Institutions Codes and Financial Institution names in your country|
|FinancialInstitutionCountryCode||The code of the financial institution and county the payment was made from.||String||Consult the POLi™ Console for a complete listing of supported Financial Institutions Codes and Financial Institution names in your country|
|FinancialInstitutionName||The name of the financial institution the payment was made from.||String||Consult the POLi™ Console for a complete listing of supported Financial Institutions Codes and Financial Institution Names in your country|
|MerchantReference||The merchant reference passed in the InitiateTransaction request.||String|
|MerchantData||The merchant data that was passed in the InitiateTransaction request for round trip purposes.||String|
|MerchantAccountName||The merchant’s account name where the funds were to be paid.||String|
|MerchantAccountSortCode||The merchant’s account sort code where the funds were to be paid.||String|
|MerchantAccountSuffix||The merchant’s account suffix where the funds were to be paid. Note: This is only applicable to New Zealand merchants.||String|
|MerchantAccountNumber||The merchant’s account number where the funds were to be paid.||String|
|PayerFirstName||The first name of the user who paid (if available)||String|
|PayerFamilyName||The last name of the user who paid (if available)||String|
|PayerAccountSortCode||The BSB of the user who paid (if available)||String|
|PayerAccountNumber||The account number of the user who paid (if available)||String|
|PayerAccountSuffix||The suffix of the user who paid (if available)||String|
|TransactionID||The GUID of the Transaction||GUID|
|14050||Transaction was initiated by another merchant or another transaction-based error|
|14051||The transaction was not found|
|14052||The token provided was incomplete, corrupted or doesn't exist|