• POLi API Workflow
• InitiateTransaction
• CancellationURL and MerchantHomepageURL
• InitiateTransaction Example

InitiateTransaction API

The InitiateTransaction web service is used to initiate a POLi transaction with details specified by the merchant. POLi will authenticate the merchant's request and validate the data passed.

To initiate to our production environment, use: https://poliapi.apac.paywithpoli.com/api/v2/Transaction/Initiate

To initiate to our UAT test environment, use: https://poliapi.uat3.paywithpoli.com/api/v2/Transaction/Initiate

POLi API workflow

InitiateTransaction Request

CancellationURL and MerchantHomepageURL

A user is redirected back to the CancellationURL or MerchantHomepageURL if the user has the ability to proceed with the transaction but chooses not to. There are 2 different scenarios where this can occur:

• User chooses to return to the merchant on POLi bank selection page,
• User chooses to cancel the payment,

The MerchantHomepage URL will be used if the CancellationURL is not supplied. The MerchantHomepageURL and CancellationURL will be used as is, that is, POLi will not append the transaction token to the URLs specified.

InitiateTransaction Example

This code example show you how to use the InitiateTransaction API.

Visit API Introduction to generate code snippets of your preferred language.

PHP

$json_builder = '{
    "Amount":"5",
    "CurrencyCode":"NZD",
    "MerchantReference":"CustomerRef12345",
    "MerchantHomepageURL":"https://www.mycompany.com",
    "SuccessURL":"https://www.mycompany.com/Success",
    "FailureURL":"https://www.mycompany.com/Failure",
    "CancellationURL":"https://www.mycompany.com/Cancelled",
    "NotificationURL":"https://www.mycompany.com/nudge" 
}';

$auth = base64_encode('SS64xxxxx:AuthCode123'); //ADD YOUR CREDENTIALS
$header = array();
$header[] = 'Content-Type: application/json';
$header[] = 'Authorization: Basic '.$auth;

$ch = curl_init("https://poliapi.apac.paywithpoli.com/api/v2/Transaction/Initiate");
//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);

header('Location: '.$json["NavigateURL"]);

C Sharp

var json = System.Text.Encoding.UTF8.GetBytes(@"{
    'Amount':'5',
    'CurrencyCode':'NZD',
    'MerchantReference':'CustomerRef12345',
    'MerchantHomepageURL':'https://www.mycompany.com',
    'SuccessURL':'https://www.mycompany.com/Success',
    'FailureURL':'https://www.mycompany.com/Failure',
    'CancellationURL':'https://www.mycompany.com/Cancelled',
    'NotificationURL':'https://www.mycompany.com/nudge'
}");
var auth = System.Convert.ToBase64String(System.Text.Encoding.UTF8.GetBytes("SS64xxxxx:AuthCode12345")); //ADD YOUR CREDENTIALS

var myRequest = System.Net.WebRequest.Create("https://poliapi.apac.paywithpoli.com/api/v2/Transaction/Initiate");
myRequest.Method = "POST";
myRequest.ContentType = "application/json";
myRequest.Headers.Add("Authorization", "Basic "+auth);
myRequest.ContentLength = json.Length;

System.IO.Stream dataStream = myRequest.GetRequestStream();
dataStream.Write(json, 0, json.Length);
dataStream.Close();

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 = Newtonsoft.Json.JsonConvert.DeserializeObject(outputData);
    Response.Redirect(latest["NavigateURL"].Value);
}
response.Close();
data.Close();
streamRead.Close();

JAVA

import java.io.*;
import java.net.*;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.Base64;

public class POLiTransaction 
{ 
    public static void main(String[] args) {
        SendPoliInitiateRequest();
    }

    public static void SendPoliInitiateRequest()
    {
        try{

            String query = "https://poliapi.apac.paywithpoli.com/api/v2/Transaction/Initiate";

//Use Your Own JSON builder (example like GSON), Or make sure this string is in one line
            String json = "{ 'Amount':'5',
                             'CurrencyCode':'NZD',
                             'MerchantReference':'CustomerRef12345',
                             'MerchantHomepageURL':'https://www.mycompany.com',
                              'SuccessURL':'https://www.mycompany.com/Success', 
                              'FailureURL':'https://www.mycompany.com/Failure',
                              'CancellationURL':'https://www.mycompany.com/Cancelled',
                              'NotificationURL':'https://www.mycompany.com/nudge'}";    

            URL url = new URL(query);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setConnectTimeout(5000);

            String accesscode  = "SS64xxxxx:AuthCode12345"; //ADD YOUR CREDENTIALS 
            String encodedAuthString = Base64.getEncoder().encodeToString(accesscode.getBytes());

            conn.setRequestProperty("authorization", "Basic " + encodedAuthString); 
            conn.setRequestProperty("Content-Type", "application/json; charset=UTF-8");

            conn.setDoOutput(true);
            conn.setDoInput(true);
            conn.setRequestMethod("POST");

            OutputStream os = conn.getOutputStream();
            os.write(json.getBytes("UTF-8"));
            os.close();

            // read the response
           InputStream in = new BufferedInputStream(conn.getInputStream());

           byte[] contents = new byte[1024];
           int bytesRead = 0;

           String poliResponse = ""; 

            while((bytesRead = in.read(contents)) != -1)
            { 
              poliResponse += new String(contents, 0, bytesRead);              
            }

            System.out.print(poliResponse);//Process the JSON Response and Redirect to NavigateURL

           in.close();
           conn.disconnect();

        }
        catch(IOException ex)
        {
            System.out.print(ex);
        }       
    }   
} 

InitiateTransaction Response Example

{
    "Success": true,
    "NavigateURL": "https://txn.apac.paywithpoli.com/?Token=uo3K8YA7vCojXjA1yuQ3txqX4s26gQSh",
    "ErrorCode": 0,
    "ErrorMessage": null,
    "TransactionRefNo": "996417408041"
}

Continue to The Nudge