The GETDailyTransactions web service is used to obtain a list of all transactions for a merchant on a particular date, this is presented in a JSON format. Whereas, the GETDailyTransactionsCSV web service obtains a list of all transactions on a particular date in a CSV format. These are normally used for reconciliation purposes and can be called at any time.
The common request parameters used for the API call are:
Name | Type & Length | Examples |
---|---|---|
Date | ISO 8601 Date/Time as a string of format YYYY-MM-DDTHH:mm:SS+HH | 2014-06-30T19:45:00+11 |
StatusCodes | Comma separated list of status codes to filter by. Specifying nothing will return all transactions | Completed,Initiated,Failed |
To formulate a GETDailyTransactions/GETDailyTransactionsCSV call, you must append date
to the query string like so:
//Retrieves all the transactions for the day
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactions?date=2018-02-26
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactionsCSV?date=2018-02-26
Merchants can optionally specify statuscodes
to narrow the report
//Merchants interested in Completed Transactions
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactions?date=2018-01-01&statuscodes=Completed
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactionsCSV?date=2018-01-01&statuscodes=Completed
//Merchants interested in Completed and ReceiptUnverified Transactions
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactions?date=2018-02-26&statuscodes=Completed,ReceiptUnverified
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactionsCSV?date=2018-02-26&statuscodes=Completed,ReceiptUnverified
You can specify a time range with use of the endDate
parameter only for the GETDailyTransactions call :
//all transactions between 5:45PM on 01/01/01, and 8PM on 01/01/01.
https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactions?date=2001-01-01T17:45:00&endDate=2001-01-01T20:00:00
Name | Description | Data Type | JSON Data Type | Possible Values |
---|---|---|---|---|
AmountPaid | The actual amount paid for the transaction | Decimal.Value upto 2 decimal places. | Number | 12.24 |
BankReceiptNo | The internet banking receipt number provided from the internet banking receipt page | String | String | |
CurrencyCode | The currency of the transaction | String | String | Possible values are aligned with ISO Standard ISO 4217 |
EndDateTime | The date and time the transaction was completed | Datetime | String | |
EstablishedDateTime | The date and time of the POLi server when the InitiateTransaction request was received | Datetime | String | |
FinancialInstitutionCode | The code of the Financial Institution the payment was made from | String | String | |
FinancialInstitutionName | The name of the Financial Institution the payment was made from | String | String | |
MerchantCode | Merchant code provided to you by POLi | String | String | |
MerchantCommonName | The merchant common name | String | String | |
MerchantData | The merchant data that was passed in the InitiateTransaction request for round trip purposes | String | String | |
MerchantReference | The merchant reference passed in the InitiateTransaction request | String | String | |
PaymentAmount | The amount of the transaction | Decimal.Value upto 2 decimal places. | Number | |
TransactionRefNo | The POLi ID associated with the transaction | String | String | A unique 12 digit reference to a POLi transaction |
TransactionStatusCode | A status code that indicates the outcome of the transaction | String | String |
$token = $_POST["Token"];
if(is_null($token)) {
$token = $_GET["token"];
}
$auth = base64_encode("S61xxxxx:AuthCode12345");
$header = array();
$header[] = 'Authorization: Basic '.$auth;
$date = "14/08/2014";
$ch = curl_init("https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactions?date=".$date);
//See the cURL documentation for more information: http://curl.haxx.se/docs/sslcerts.html
//We recommend using this bundle: https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt
curl_setopt( $ch, CURLOPT_CAINFO, "ca-bundle.crt");
curl_setopt( $ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt( $ch, CURLOPT_HTTPHEADER, $header);
curl_setopt( $ch, CURLOPT_HEADER, 0);
curl_setopt( $ch, CURLOPT_POST, 1);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $json_builder);
curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, 0);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec( $ch );
curl_close ($ch);
$json = json_decode($response, true);
print_r($json);
var auth =
System.Convert.ToBase64String
(System.Text.Encoding.UTF8.GetBytes('S61xxxxx:AuthCode12345'));
var myRequest =
System.Net.WebRequest.Create
("https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactions?date=01-01-2001");
myRequest.Method = "GET";
myRequest.Headers.Add("Authorization", "Basic "+auth);
var response = (System.Net.HttpWebResponse)myRequest.GetResponse();
var data = response.GetResponseStream();
var streamRead = new StreamReader(data);
Char[] readBuff = new Char[response.ContentLength];
int count = streamRead.Read(readBuff, 0, (int)response.ContentLength);
while (count > 0)
{
var outputData = new String(readBuff, 0, count);
Console.Write(outputData);
count = streamRead.Read(readBuff, 0, (int)response.ContentLength);
dynamic latest = JsonConvert.DeserializeObject(outputData);
}
response.Close();
data.Close();
streamRead.Close();
$token = $_POST["Token"];
if(is_null($token)) {
$token = $_GET["token"];
}
$auth = base64_encode("S61xxxxx:AuthCode12345");
$header = array();
$header[] = 'Authorization: Basic '.$auth;
$date = "14/08/2014";
$ch = curl_init("https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactionsCSV?date=".$date);
//See the cURL documentation for more information: http://curl.haxx.se/docs/sslcerts.html
//We recommend using this bundle: https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt
curl_setopt( $ch, CURLOPT_CAINFO, "ca-bundle.crt");
curl_setopt( $ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt( $ch, CURLOPT_HTTPHEADER, $header);
curl_setopt( $ch, CURLOPT_HEADER, 0);
curl_setopt( $ch, CURLOPT_POST, 1);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $json_builder);
curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, 0);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec( $ch );
curl_close ($ch);
$json = json_decode($response, true);
print_r($json);
var auth =
System.Convert.ToBase64String
(System.Text.Encoding.UTF8.GetBytes('S61xxxxx:AuthCode12345'));
var myRequest =
System.Net.WebRequest.Create
("https://poliapi.apac.paywithpoli.com/api/v2/Transaction/GetDailyTransactionsCSV?date=01-01-2001");
myRequest.Method = "GET";
myRequest.Headers.Add("Authorization", "Basic "+auth);
var response = (System.Net.HttpWebResponse)myRequest.GetResponse();
var data = response.GetResponseStream();
var streamRead = new StreamReader(data);
Char[] readBuff = new Char[response.ContentLength];
int count = streamRead.Read(readBuff, 0, (int)response.ContentLength);
while (count > 0)
{
var outputData = new String(readBuff, 0, count);
Console.Write(outputData);
count = streamRead.Read(readBuff, 0, (int)response.ContentLength);
dynamic latest = JsonConvert.DeserializeObject(outputData);
}
response.Close();
data.Close();
streamRead.Close();
{
"AmountPaid": 0,
"BankReceiptNo": null,
"CurrencyCode": "AUD",
"EndDateTime": "2018-02-26T07:48:00",
"EstablishedDateTime": "2018-02-26T07:48:29.433",
"FinancialInstitutionCode": "iBankAU01",
"FinancialInstitutionName": "iBank AU 01",
"MerchantCode": "PriceBusterDVD_AU",
"MerchantCommonName": "Pricebuster AU",
"MerchantReference": "MyRef01",
"MerchantData": "MyDefinedData",
"PaymentAmount": 2.82,
"TransactionRefNo": "996108109874",
"TransactionStatusCode": "Cancelled",
"CurrencyName": "Australian Dollar",
"CustomerReference": null,
"PayerAcctNumber": null,
"PayerAcctSortCode": null,
"PayerAcctSuffix": "",
"TransactionStatus": "Cancelled"
}
AmountPaid,BankReceiptNo,CurrencyCode,EndDateTime,EstablishedDateTime,FinancialInstitutionCode,FinancialInstitutionName,MerchantCode,MerchantCommonName,MerchantReference,PaymentAmount,TransactionReference,TransactionStatusCode,MerchantData
0,,AUD,2018-02-26T07:48:00,2018-02-26T07:48:29,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.82,996108109874,Cancelled,MyDefinedData
0,,AUD,2018-02-26T07:51:34,2018-02-26T07:51:12,ANZ,ANZ,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.66,996108109875,Cancelled,MyDefinedData
0,,AUD,2018-02-26T08:00:52,2018-02-26T08:00:27,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,1.13,996108109876,Cancelled,MyDefinedData
0,,AUD,2018-02-26T08:08:01,2018-02-26T08:07:51,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.71,996108109877,Cancelled,MyDefinedData
0,,AUD,2018-02-26T08:12:35,2018-02-26T08:10:45,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.58,996108109878,Cancelled,MyDefinedData
0,,AUD,2018-02-26T08:27:35,2018-02-26T08:26:33,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,1.13,996108109879,Cancelled,MyDefinedData
0,,AUD,2018-02-26T08:31:51,2018-02-26T08:31:41,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.31,996108109880,Cancelled,MyDefinedData
0,,AUD,2018-02-26T08:45:52,2018-02-26T08:45:11,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,1.27,996108109881,Cancelled,MyDefinedData
0,,AUD,2018-02-26T09:33:34,2018-02-26T09:33:22,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.7,996108109882,Cancelled,MyDefinedData
2.94,"01478400-270157",AUD,2018-02-26T09:42:42,2018-02-26T09:42:15,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.94,996108109883,Completed,MyDefinedData
0,,AUD,2018-02-26T10:13:42,2018-02-26T10:13:33,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.4,996108109884,Cancelled,MyDefinedData
0,,AUD,2018-02-26T10:18:01,2018-02-26T10:17:43,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,1.64,996108109885,Cancelled,MyDefinedData
2.03,"84479587-270160",AUD,2018-02-26T10:19:28,2018-02-26T10:19:11,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.03,996108109886,Completed,MyDefinedData
0,,AUD,,2018-02-26T10:47:34,CBA,Commonwealth Bank,PriceBusterDVD_AU,Pricebuster AU,MyRef01,0.01,996108109888,InProcess,MyDefinedData
0,,AUD,2018-02-26T11:11:46,2018-02-26T11:11:21,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,1.95,996108109889,Cancelled,MyDefinedData
2.16,"64084976-270164",AUD,2018-02-26T11:16:38,2018-02-26T11:16:04,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.16,996108109891,Completed,MyDefinedData
0,,AUD,2018-02-26T12:34:16,2018-02-26T12:34:03,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.65,996108109892,Cancelled,MyDefinedData
1.29,"46274049-270173",AUD,2018-02-26T12:34:39,2018-02-26T12:34:18,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,1.29,996108109893,Completed,MyDefinedData
0,,AUD,2018-02-26T02:53:32,2018-02-26T02:52:38,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,0.01,996108109894,Cancelled,MyDefinedData
0,,AUD,,2018-02-26T02:54:29,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.94,996108109895,InProcess,MyDefinedData
0,,AUD,,2018-02-26T03:14:01,iBankAU01,iBank AU 01,PriceBusterDVD_AU,Pricebuster AU,MyRef01,2.35,996108109896,InProcess,MyDefinedData