This solution allows the merchant to have an embedded iFrame within their website that will load eComms Hosted Payments page. The merchants developer can choose to embed the iFrame within a checkout page or create a pop-up modal that will contain the iFrame.

The consumers data is collected on the merchants website where it is posted to either the RegisterToken or RegisterPayByToken API. The response from the RegisterPayByToken or PayByToken will contain the URL which will be used to load into the iFrame. The consumer must then input their card details and submit the form, if the consumers card is 3D Secure, the consumer must enter their unique secure code and submit in order to authenticate themselves, if successful the consumer will be redirected to a success page which was pre-determined in the initial request. Our Hosted Payments Page handles the flow of 3D Secure.

Within this section you can find three of our Token APIs, below lists all three. Please note that the consumers card details are required to be entered the first time around when processing a transaction, for future transactions, the card holders CVV is only required.

1. RegisterToken - Allows the merchant to generate their own unique token and register this, this token will be used with the PayByToken to process transactions.
2. PayByToken - Allows the merchant to process transactions while providing the generated token received from the RegisterToken or from the RegisterPayByToken. The transaction result inside the confirmation notification will be sent to the merchants Notification URL.
3. RegisterPayByToken - Used to register a new token and process a transaction at the same time. The transaction result inside the confirmation notification will be sent to the merchants Notification URL.

This sections demonstrates what the consumer can expect when they load the Hosted Payments Page, this demonstration can help assist merchants with answers relating the token process.

Sample Hosted Payments Page Form (First Transaction):

In this sample, the merchant must enter their card details for the first time. Once the information is submitted, the information is stored using the provided token.

Future payments will auto fill some of the information the next time around which will help speed up the transaction process.

In this sample, the merchant must only enter their card CVV. The other information is auto filled.

In this sample, the merchant must enter their card details for the first time. This sample also demonstrates how DCC is displayed. Once the information is submitted, the information is stored using the provided token.

Future payments will auto fill some of the information the next time around which will help speed up the transaction process.

In this sample, the merchant must only enter their card CVV. This sample also demonstrates how DCC is displayed. The other information is auto filled.

The process of the Hosted Payments Page (Token) API is similar to the standard Hosted Payments Page however, the token solution allows merchants to save consumer card information in a token in order to help speed up the transaction process, once the token is used, the Hosted Payments Page will already have most of the card information automatically filled into the fields. Below demonstrates the steps required in order to successfully cater for our Hosted Payments Page (Token) APIs.

1. The merchant sends a request to our RegisterToken API while providing consumer information and a unique token, the response will contain "0060 - Token Registered" which indicates the provided token is now registered. This token will be used with the PayByToken.
2. Supply the generated token when using the PayByToken to successfully process a transaction.

1. The merchant sends a request to our PayByToken API while also providing some data including the generated token which the merchant registered with the RegisterToken request.
2. If the request passes validations, the response will contain "0061 - Pay Token Received", included will also contain the Hosted Payments Page URL which must be passed into the iFrame where once loaded, the card holder must enter some information to process the transaction.

1. The merchant sends a request to our RegisterPayByToken API while providing consumer information and a unique token.
2. If the request passes validations, the response will contain "0061 - Pay Token Received", included will also contain the Hosted Payments Page URL which must be passed into the iFrame where once loaded, the card holder must enter some information to process the transaction.

Making The Request

HTTP is used as the request-response protocol between a merchants site and the eCOMM API. In the back end, a merchant submits a HTTP POST request to the eCOMM server, the server will then return an XML document where the merchant must then cater for the action listed. The response contains key information about the request and also contains the requested content.

1. Username = SomeName
2. Password = SomePassword
3. MessageID = *GUID (e.g. 30dd879c-ee2f-11db-8314-0800200c9a66)
4. APISignature = RegisterToken
5. Data = Form data in XML format (See sample here)

The above parameters are required when sending HTTP POST data to our API in order to receive a successful response. The data parameter must be composed of the collected information you gathered from the customer while using our Available Form Data fields.

https://staging.ecomm365.com/acqapi/service.ashx?Username=SomeName&Password=SomePassword&MessageID=30dd879c-ee2f-11db-8314-0800200c9a66&APISignature=registertoken&Data=<R>...</R>

<?php
function httpPost($url, $params) //Post method
{
	$params = urldecode(http_build_query($params)); //Convert our array of params into query string, URL decode the result to prevent data corruption
	
	$ch = curl_init($url); //create a new cURL resource
	
	//set appropriate options
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
	curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
	curl_setopt($ch, CURLOPT_HEADER, 0);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	
	$response = curl_exec($ch); //grab URL and pass it to the browser while assigning the response to `$response`
	
	curl_close($ch); //close cURL resource, and free up system resources
	
    return $response;
}

$APIURL = "https://staging.ecomm365.com/acqapi/service.ashx"; //Set API URL to eComm staging environment
$params = array(
"APISignature" => "RegisterToken", //API Signature - Please notice the `RegisterToken` signature here for the RegisterToken request
"MessageID" => GUID(), //A new GUID is required for every new API Call
"Username" => "SomeName", //API Username
"Password" => "SomePassword", //API Password
"Data" => "<R>...</R>" //Data fields required for request
);

$Response = httpPost($APIURL, $params); //User defined function used to POST data to API and assign the response to `$Response` variable
$XMLDataArray = simplexml_load_string($Response); //Used to parse XML at ease
//...

/* Obtain information from response fields */
$ResponseR1 = (string)$XMLDataArray->R1;
$ResponseR2 = (string)$XMLDataArray->R2;
//... etc

//Or loop through the elements
/* END */

//More Code...
?>

[HttpPost]
public IActionResult index()
{
	HttpWebRequest httpWReq = (HttpWebRequest)WebRequest.Create("https://staging.ecomm365.com/acqapi/service.ashx"); //Create webrequest while setting the API URL to eComm staging environment
	UTF8Encoding encoding = new UTF8Encoding(); //Represents a UTF-8 encoding of Unicode characters.

	string pData = "username=SomeName"; //API Username
	pData += "&password=SomePassword"; //API Password
	pData += "&messageId=" + System.Guid.NewGuid().ToString();  //A new GUID is required for every new API Call
	pData += "&ApiSignature=RegisterToken"; //API Signature - Please notice the `RegisterToken` signature here for the RegisterToken request

	pData += "&Data=" + WebUtility.UrlEncode(@"<R>...</R>"); //Data fields required for request

	byte[] data = encoding.GetBytes(pData); //Getting Bytes for data

	httpWReq.Method = "POST"; //HTTP Method - POST
	httpWReq.ContentType = "application/x-www-form-urlencoded"; //Setting the correct Content Type
	httpWReq.ContentLength = data.Length; //Getting Content Length

	//Create POST data and convert it to a byte array.
	byte[] byteArray = Encoding.UTF8.GetBytes(pData);

	// Get the request stream.
	Stream dataStream = httpWReq.GetRequestStream();

	// Write the data to the request stream.
	dataStream.Write(byteArray, 0, byteArray.Length);

	// Close the Stream object.
	dataStream.Close();

	HttpWebResponse response = (HttpWebResponse)httpWReq.GetResponse(); //Assign response to `response` variable
	string responseString = new StreamReader(response.GetResponseStream()).ReadToEnd(); //Obtain response from post

	/* Parse XML from response */
	XmlDocument xDoc = new XmlDocument();
	xDoc.LoadXml(responseString);
	/* END */

	/* Obtain information from response fields */
	XmlNodeList ResponseR1 = xDoc.GetElementsByTagName("R1");
	XmlNodeList ResponseR2 = xDoc.GetElementsByTagName("R2");
	//... etc

	//Or loop through the elements
	/* END */

	//More code...
	
	return View();
}

Available Form Data Fields

Below is a table containing all the available fields for passing POST data into the data parameter within the `RegisterToken` request. These fields should be filled using collected data from the consumer on a Form Level.

Available Form Data Fields - Validation

Below is a table containing all the available fields for the data parameter within the `RegisterToken` request including its validation. These are used when constructing the data.

Sample `RegisterToken` XML Document

The below sample demonstrates what is expected when passing POST data into the data parameter.
When forming the data parameter, please refer to our guidelines above.

<!-- RegisterToken Request Demonstration -->
<R>
	<R1>0074F9EF-BF5C-4A46-AF62-3994AC0F12BA</R1>
	<R2>Billing First Name</R2>
	<R3>Billing Middle Name</R3>
	<R4>Billing Last Name</R4>
	<R5>IDA Business and Technology Park</R5>
	<R6>Johnstown</R6>
	<R7>Navan</R7>
	<R8>Billing State or Province</R8>
	<R9>IE</R9>
	<R10>Meath</R10>
</R>

Data Returned

Below are the expected XML fields returned from the request.

Expected XML Documents

This section demonstrates the expected XML document responses returned from the HTTP POST once the request has passed validations.

Expected error code responses:

1. 0060 - Token Registered, the response indicates a successful registration of a token, you may now use this token to process transactions.

Sample XML Response (0060):

<!-- Sample XML Document -->
<R>
	<R1>0060</R1>
	<R2>Token Registered</R2>
</R> 

Making The Request

HTTP is used as the request-response protocol between a merchants site and the eCOMM API. In the back end, a merchant submits a HTTP POST request to the eCOMM server, the server will then return an XML document where the merchant must then cater for the action listed. The response contains key information about the request and also contains the requested content.

1. Username = SomeName
2. Password = SomePassword
3. MessageID = *GUID (e.g. 30dd879c-ee2f-11db-8314-0800200c9a66)
4. APISignature = PayByToken
5. Data = Form data in XML format (See sample here)

The above parameters are required when sending HTTP POST data to our API in order to receive a successful response. The data parameter must be composed of the collected information you gathered from the customer while using our Available Form Data fields.

https://staging.ecomm365.com/acqapi/service.ashx?Username=SomeName&Password=SomePassword&MessageID=30dd879c-ee2f-11db-8314-0800200c9a66&APISignature=paybytoken&Data=<R>...</R>

<?php
function httpPost($url, $params) //Post method
{
	$params = urldecode(http_build_query($params)); //Convert our array of params into query string, URL decode the result to prevent data corruption
	
	$ch = curl_init($url); //create a new cURL resource
	
	//set appropriate options
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
	curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
	curl_setopt($ch, CURLOPT_HEADER, 0);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	
	$response = curl_exec($ch); //grab URL and pass it to the browser while assigning the response to `$response`
	
	curl_close($ch); //close cURL resource, and free up system resources
	
    return $response;
}

$APIURL = "https://staging.ecomm365.com/acqapi/service.ashx"; //Set API URL to eComm staging environment
$params = array(
"APISignature" => "PayByToken", //API Signature - Please notice the `PayByToken` signature here for the PayByToken request
"MessageID" => GUID(), //A new GUID is required for every new API Call
"Username" => "SomeName", //API Username
"Password" => "SomePassword", //API Password
"Data" => "<R>...</R>" //Data fields required for request
);

$Response = httpPost($APIURL, $params); //User defined function used to POST data to API and assign the response to `$Response` variable
$XMLDataArray = simplexml_load_string($Response); //Used to parse XML at ease
//...

/* Obtain information from response fields */
$ResponseR1 = (string)$XMLDataArray->R1;
$ResponseR2 = (string)$XMLDataArray->R2;
//... etc

//Or loop through the elements
/* END */

//More Code...
?>

[HttpPost]
public IActionResult index()
{
	HttpWebRequest httpWReq = (HttpWebRequest)WebRequest.Create("https://staging.ecomm365.com/acqapi/service.ashx"); //Create webrequest while setting the API URL to eComm staging environment
	UTF8Encoding encoding = new UTF8Encoding(); //Represents a UTF-8 encoding of Unicode characters.

	string pData = "username=SomeName"; //API Username
	pData += "&password=SomePassword"; //API Password
	pData += "&messageId=" + System.Guid.NewGuid().ToString();  //A new GUID is required for every new API Call
	pData += "&ApiSignature=PayByToken"; //API Signature - Please notice the `PayByToken` signature here for the PayByToken request

	pData += "&Data=" + WebUtility.UrlEncode(@"<R>...</R>"); //Data fields required for request

	byte[] data = encoding.GetBytes(pData); //Getting Bytes for data

	httpWReq.Method = "POST"; //HTTP Method - POST
	httpWReq.ContentType = "application/x-www-form-urlencoded"; //Setting the correct Content Type
	httpWReq.ContentLength = data.Length; //Getting Content Length

	//Create POST data and convert it to a byte array.
	byte[] byteArray = Encoding.UTF8.GetBytes(pData);

	// Get the request stream.
	Stream dataStream = httpWReq.GetRequestStream();

	// Write the data to the request stream.
	dataStream.Write(byteArray, 0, byteArray.Length);

	// Close the Stream object.
	dataStream.Close();

	HttpWebResponse response = (HttpWebResponse)httpWReq.GetResponse(); //Assign response to `response` variable
	string responseString = new StreamReader(response.GetResponseStream()).ReadToEnd(); //Obtain response from post

	/* Parse XML from response */
	XmlDocument xDoc = new XmlDocument();
	xDoc.LoadXml(responseString);
	/* END */

	/* Obtain information from response fields */
	XmlNodeList ResponseR1 = xDoc.GetElementsByTagName("R1");
	XmlNodeList ResponseR2 = xDoc.GetElementsByTagName("R2");
	//... etc

	//Or loop through the elements
	/* END */

	//More code...
	
	return View();
}

Available Form Data Fields

Below is a table containing all the available fields for passing POST data into the data parameter within the `PayByToken` request. These fields should be filled using collected data from the consumer on a Form Level.

Available Form Data Fields - Validation

Below is a table containing all the available fields for the data parameter within the `PayByToken` request including its validation. These are used when constructing your data.

Sample `PayByToken` XML Document

The below sample demonstrates what is expected when passing POST data into the data parameter.
When forming the data parameter, please refer to our guidelines above.

<!-- PayByToken Request Demonstration -->
<R>
    <R1>0074F9EF-BF5C-4A46-AF62-3994AC0F12BA</R1>
    <R2>1000596</R2>
    <R3>500</R3>
    <R4>http://domain.com/HostedPaymentsPage/Success/</R4>
    <R5>http://domain.com/HostedPaymentsPage/Failure/</R5>
    <R6>6f74f6f2-3537-49d9-b009-8ddb2590f903</R6>
	<udf>
	  <I>eCOMM</I>
	  <I>435</I>
	</udf>
</R>

Data Returned

Below are the expected XML fields returned from the request. The confirmation notification will be sent if the request passes validations.

Confirmation Notification:

Expected XML Documents

This section demonstrates the expected XML document responses returned from the HTTP POST once the request has passed validations.

Expected error code responses:

1. 0061 - Successful request, the response includes the URL required to pass into the iFrame in the R3 field.

Sample XML Response (0061):

<!-- Sample XML Document -->
<R>
	<R1>0061</R1>
	<R2>Pay Token Received</R2>
	<R3>https://www.somewebsite.com/acs?id=43DAAL4B-78CF-4000-AC6B-EBA1F1116229</R3>
</R> 

Sample XML Response (Confirmation Notification):

The below is expected to return to the Notification URL if your notification method is setup to do so.

<!-- Sample Confirmation Notification, XML Document -->
<?xml version="1.0"?>
<R>
	<R1>0000</R1>
	<R2>Successful</R2>
	<R3>6f74f6f2-3537-49d9-b009-8ddb2590f903</R3>
	<R4>Successful</R4>
	<R5>Data Not Checked</R5>
	<R8>Match</R8>
	<R9>Ok</R9>
	<R10>Confirm</R10>
	<TKN>0074F9EF-BF5C-4A46-AF62-3994AC0F12BA</TKN>
	<TKNCN>5424*********0819</TKNCN>
	<TKNCardType>VSD</TKNCardType>
	<TKNCardExpMM>12</TKNCardExpMM>
	<TKNCardExpYYYY>2018</TKNCardExpYYYY>
	<udf>
		<I>eCOMM</I>
		<I>435</I>
	</udf>
</R>

Making The Request

HTTP is used as the request-response protocol between a merchants site and the eCOMM API. In the back end, a merchant submits a HTTP POST request to the eCOMM server, the server will then return an XML document where the merchant must then cater for the action listed. The response contains key information about the request and also contains the requested content.

1. Username = SomeName
2. Password = SomePassword
3. MessageID = *GUID (e.g. 30dd879c-ee2f-11db-8314-0800200c9a66)
4. APISignature = RegisterPayByToken
5. Data = Form data in XML format (See sample here)

The above parameters are required when sending HTTP POST data to our API in order to receive a successful response. The data parameter must be composed of the collected information you gathered from the customer while using our Available Form Data fields.

https://staging.ecomm365.com/acqapi/service.ashx?Username=SomeName&Password=SomePassword&MessageID=30dd879c-ee2f-11db-8314-0800200c9a66&APISignature=registerpaybytoken&Data=<R>...</R>

<?php
function httpPost($url, $params) //Post method
{
	$params = urldecode(http_build_query($params)); //Convert our array of params into query string, URL decode the result to prevent data corruption
	
	$ch = curl_init($url); //create a new cURL resource
	
	//set appropriate options
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
	curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
	curl_setopt($ch, CURLOPT_HEADER, 0);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	
	$response = curl_exec($ch); //grab URL and pass it to the browser while assigning the response to `$response`
	
	curl_close($ch); //close cURL resource, and free up system resources
	
    return $response;
}

$APIURL = "https://staging.ecomm365.com/acqapi/service.ashx"; //Set API URL to eComm staging environment
$params = array(
"APISignature" => "RegisterPayByToken", //API Signature - Please notice the `RegisterPayByToken` signature here for the RegisterPayByToken request
"MessageID" => GUID(), //A new GUID is required for every new API Call
"Username" => "SomeName", //API Username
"Password" => "SomePassword", //API Password
"Data" => "<R>...</R>" //Data fields required for request
);

$Response = httpPost($APIURL, $params); //User defined function used to POST data to API and assign the response to `$Response` variable
$XMLDataArray = simplexml_load_string($Response); //Used to parse XML at ease
//...

/* Obtain information from response fields */
$ResponseR1 = (string)$XMLDataArray->R1;
$ResponseR2 = (string)$XMLDataArray->R2;
//... etc

//Or loop through the elements
/* END */

//More Code...
?>

[HttpPost]
public IActionResult index()
{
	HttpWebRequest httpWReq = (HttpWebRequest)WebRequest.Create("https://staging.ecomm365.com/acqapi/service.ashx"); //Create webrequest while setting the API URL to eComm staging environment
	UTF8Encoding encoding = new UTF8Encoding(); //Represents a UTF-8 encoding of Unicode characters.

	string pData = "username=SomeName"; //API Username
	pData += "&password=SomePassword"; //API Password
	pData += "&messageId=" + System.Guid.NewGuid().ToString();  //A new GUID is required for every new API Call
	pData += "&ApiSignature=RegisterPayByToken"; //API Signature - Please notice the `RegisterPayByToken` signature here for the RegisterPayByToken request

	pData += "&Data=" + WebUtility.UrlEncode(@"<R>...</R>"); //Data fields required for request

	byte[] data = encoding.GetBytes(pData); //Getting Bytes for data

	httpWReq.Method = "POST"; //HTTP Method - POST
	httpWReq.ContentType = "application/x-www-form-urlencoded"; //Setting the correct Content Type
	httpWReq.ContentLength = data.Length; //Getting Content Length

	//Create POST data and convert it to a byte array.
	byte[] byteArray = Encoding.UTF8.GetBytes(pData);

	// Get the request stream.
	Stream dataStream = httpWReq.GetRequestStream();

	// Write the data to the request stream.
	dataStream.Write(byteArray, 0, byteArray.Length);

	// Close the Stream object.
	dataStream.Close();

	HttpWebResponse response = (HttpWebResponse)httpWReq.GetResponse(); //Assign response to `response` variable
	string responseString = new StreamReader(response.GetResponseStream()).ReadToEnd(); //Obtain response from post

	/* Parse XML from response */
	XmlDocument xDoc = new XmlDocument();
	xDoc.LoadXml(responseString);
	/* END */

	/* Obtain information from response fields */
	XmlNodeList ResponseR1 = xDoc.GetElementsByTagName("R1");
	XmlNodeList ResponseR2 = xDoc.GetElementsByTagName("R2");
	//... etc

	//Or loop through the elements
	/* END */

	//More code...
	
	return View();
}

Available Form Data Fields

Below is a table containing all the available fields for passing POST data into the data parameter within the `RegisterPayByToken` request. These fields should be filled using collected data from the consumer on a Form Level.

Available Form Data Fields - Validation

Below is a table containing all the available fields for the data parameter within the `RegisterPayByToken` request including its validation. These are used when constructing the data.

Sample `RegisterPayByToken` XML Document

The below sample demonstrates what is expected when passing POST data into the data parameter.
When forming the data parameter, please refer to our guidelines above.

<!-- RegisterPayByToken Request Demonstration -->
<R>
	<R1>0074F9EF-BF5C-4A46-AF62-3994AC0F12BA</R1>
	<R2>Billing First Name</R2>
	<R3>Billing Middle Name</R3>
	<R4>Billing Last Name</R4>
	<R5>IDA Business and Technology Park</R5>
	<R6>Johnstown</R6>
	<R7>Navan</R7>
	<R8>Billing State or Province</R8>
	<R9>IE</R9>
	<R10>Meath</R10>
	<R11>1000596</R11>
	<R12>500</R12>
	<R13>http://domain.com/HostedPaymentsPage/Success/</R13>
	<R14>http://domain.com/HostedPaymentsPage/Failure/</R14>
	<R15>6f74f6f2-3537-49d9-b009-8ddb2590f903</R15>
</R>

Data Returned

Below are the expected XML fields returned from the request. The confirmation notification will be sent if the request passes validations.

Confirmation Notification:

Expected XML Documents

This section demonstrates the expected XML document responses returned from the HTTP POST once the request has passed validations.

Expected error code responses:

1. 0061 - Successful request, the response includes the URL required to pass into the iFrame in the R3 field.

Sample XML Response (0061):

<!-- Sample XML Document -->
<R>
	<R1>0061</R1>
	<R2>Pay Token Received</R2>
	<R3>https://www.somewebsite.com/acs?id=43DAAL4B-78CF-4000-AC6B-EBA1F1116229</R3>
</R> 

Sample XML Response (Confirmation Notification):

The below is expected to return to the Notification URL if your notification method is setup to do so.

<!-- Sample Confirmation Notification, XML Document -->
<?xml version="1.0"?>
<R>
	<R1>0000</R1>
	<R2>Successful</R2>
	<R3>6f74f6f2-3537-49d9-b009-8ddb2590f903</R3>
	<R4>Successful</R4>
	<R5>Data Not Checked</R5>
	<R8>Match</R8>
	<R9>Ok</R9>
	<R10>Confirm</R10>
	<TKN>0074F9EF-BF5C-4A46-AF62-3994AC0F12BA</TKN>
	<TKNCN>5424*********0819</TKNCN>
	<TKNCardType>VSD</TKNCardType>
	<TKNCardExpMM>12</TKNCardExpMM>
	<TKNCardExpYYYY>2018</TKNCardExpYYYY>
	<udf>
		<I>eCOMM</I>
		<I>435</I>
	</udf>
</R>