Documentation

iFrame HTML Guide

  • HostedPCI Express Solution is designed to integrate with any e-commerce site that requires a credit card and CVV information captured.
  • iFrame module is installed on the e-commerce site payment pages. iFrame only displays the credit card fields which are in scope for PCI compliance, which is Credit Card# and CVV. The rest of the page is presented by the eCommerce site as usual.
  • the iFrame module will use the eCommerce sites payment form to submit credit card information to HostedPCI and returns the token back to the eCommerce site.
  • Creating a Token is the First step in maintaining PCI compliant environment using HostedPCI toolset.
  • The HostedPCI token provided back by the iFrame can be stored within your system for future use. The token will remain active for 18 months from the last time it is used.

Prerequisites

ParametersValue
hpciSiteIdThe site id (a number) configured and provided by HPCI after the activation of the HPCI account. There will be a different Site Id for staging and live sites.
locationThe location reference within the HPCI application. Locations are configured through the HPCI customer portal.
fullParentHostIs the full hostname where the parent e-commerce site resides (not the iframe).
fullParentQStrIs the query string currently used by the payment page where the iframe resides. This parameter is required for backward compatibility with browsers that do not support “post” frame messages. This string has to match the current URL that appears on the browser address bar.

Parameters for iFrame URL

VariablesValue
jqVersionThis setting is optional, allows control on the JQuery version of the iFrame that is being used. Available versions are 1.11.2 or 2.1.3 or 1.4.1. Values can be [jq1 | jq2 | jqdef] respectively. This parameter needs the V2 iFrame to be enabled in order for it to work.
browserTypeThis setting is optional sets the iFrame for mobile or desktop use. Values can be [mobile | def]
cvvValidateSet the value of the parameter to Y if basic CVV form validation is required. Basic validation will report an error if the entered value is not numbers only and is not between 3 and 4 characters regardless of credit card type.
reportCCTypeSet the value of the parameter to Y if the preliminary credit card and CVV data needs to be reported once the user has entered the details and moves the focus from the respective fields. Credit card type, credit card, and CVV length and credit card validity using the Mod 10 check is reported.
reportCCDigitsThis function is optional and requires iFrame V2 to be enabled on the account. This function enables keypress feedback from the ccNum field within the iFrame. Set to Y if CC data needs to be reported back during key press.
formatCCDigitsCredit card formatting feature, automatically add delimiter while customer types the card in, for example, “4444333322221111” will be turned to “4444-3333-2222-1111”. Turn on or off [Y/N].
formatCCDigitsDelimiterCredit card formatting feature, set the delimiter value which can be space, dash, or tab, just need to remember that the value has to be URL encoded [%20/-/%09].
reportCVVDigitsThis function is optional and requires iFrame V2 to be enabled on the account. This function enables keypress feedback from the ccCVV field within the iFrame. Set to Y if CVV data needs to be reported back during key press.
enableTokenDisplaySet to “Y” if you want the iFrame to show the pre-populated masked value that is stored inside. It applies to both credit card and CVV fields. If it’s not empty, it means there is already a value stored inside.
ccNumTokenIdxThis parameter is used to define which iFrame index is going to be used. Used mainly for instances where you would need to load multiple iFrames on the same page. Set to “1” unless there is a need for multiple iFrames on the same page. Required for CVV only iFrame.
ccNumTokenIs the credit card token that is associated with the CVV iFrame. To re-tokenize CVV for token 4111-1111-1111-1111 set this parameter to “4111111111111111”.
enable3DSecThis parameter is required to enable 3DS V2 iFrame. The possible value depends on the 3DS provider. Possible value cruise1/wpflex1.
selected3DSecPayNameName of the 3DSecure payment profile Name.
selected3DSecPayCCTypeParameter required to specify CCType. Can be set to ‘any’.
selected3DSecPayCurISOParameter required to specify Ccurrency Type. Can be set to ‘any’.
enableEarlyTokenSet to ‘Y’ to enable early Tokenization. Allows token to be generated beore submitting form.
reportFormFieldsSet value to the nameOfField. It returns value of field inside the iFrame.
formatCCMaskModeValue [S6X6]. Required to mask the credit card number in the iFrame.
formatCCMaskCharValue [*] or [X]. Will replace some of the card numbers with the selected values.

iFrame Callback Method / SuccessHandler

Callback MethodDescription
hpciSiteSuccessHandlerThe reference to the function that handles successful credit card mapping. This function will typically copy the mappedCCValue, mappedCVVValue parameter values to form hidden fields that need to contain the credit card and CVV values respectively. Finally, this function should submit the order processing form that encloses the credit card entry fields.
hpciSiteSuccessHandlerV2V2 of site successhandler. It returns ccBINvalue along with mappedCCvalue and mappedCVVvalue.
hpciSiteSuccessHandlerV3Includes everything in hpciSiteSuccessHandlerV2 but also returns hpciGtyTokenValue.
hpciSiteSuccessHandlerV4Includes everything in hpciSiteSuccessHandlerV3 but also returns hpciCCLast4Value, hpciGtyTokenAuthRespValue, hpciTokenRespEncrypt.
hpciSiteSuccessHandlerV5Requires V4 iframe. Includes everything in hpciSiteSuccessHandlerV4 plus it also returns hpciReportedFormFieldsObj, which contains value of extra iFrame form obkects.
hpciSiteErrorHandlerThe reference to the function that displays the credit card mapping errors. Typically the following function uses DHTML/DOM to display the error.
hpciSetup3DSSuccessHandlerInvokes when 3DS iFrame is successfully populated.
hpci3DSitePINSuccessHandlerThis function is optional and needs to be implemented only for sites that use 3D Secure functionality. The reference to the function that handles successful PIN validation. This function will typically submit the order processing form that encloses the credit card entry fields and the PIN validation iFrame.
hpci3DSitePINErrorHandlerThis function is optional and needs to be implemented only for sites that use 3D Secure functionality. The reference to the function that displays the PIN validation errors. Typically the following function uses DHTML/DOM to display the error.
hpciCCPreliminarySuccessHandlerThis function is optional and needs to be implemented only for sites that use reportCCType functionality. The function signature should accept credit card type, BIN, validity flag, and length in that order.
hpciCCPreliminarySuccessHandlerV2Includes hpciCCPreliminarySuccessHandler plus it returns hpciCCEnteredLengthValue.
hpciCCPreliminarySuccessHandlerV3Requires iframe to enable early Tokenization. Includes hpciCCPreliminarySuccessHandlerV2 plus it returns hpciMappedCCValue, hpciMappedCVVValue and more.
HpciCCPreliminarySuccessHandlerV4Requires V4 iFrame. Includes up to hpciCCPreliminarySuccessHandlerV3 plus it returns hpciReportedFormFieldsObj which returns the value of the new iFrame form object.
hpciCVVPreliminarySuccessHandlerThis function is optional and needs to be implemented only for sites that use reportCCType functionality. The function signature should accept CVV length.
hpciCVVPreliminarySuccessHandlerV2Includes hpciCVVPreliminarySuccessHandlerV2 plus it returns hpciCVVValidValue.
hpciCVVPreliminarySuccessHandlerV3Requires early Tokenization funcationality enabled. Includes hpciCVVPreliminarySuccessHandlerV2 plus it returns hpciMappedCCValue, hpciMappedCVVValue, hpciCCBINValue, hpciGtyTokenValue, hpciCCLast4Value, hpciGtyTokenAuthRespValue and hpciTokenRespEncrypt.
hpciCVVPreliminarySuccessHandlerV4Requires V4 iFrame. Includes up to hpciCVVPreliminarySuccessHandlerV3 plus it returns hpciReportedFormFieldsObj which returns the value of the new iFrame form object.
hpciCCDigitsSuccessHandlerThis function is optional and requires iFrame V2 to be enabled on the account and needs to be implemented for sites that use keypress functionality. The function signature should accept credit card type, BIN, validity flag, and length in that order.
hpciCCDigitsSuccessHandlerV2Includes hpciCCDigitsSuccessHandler plus it returns hpciCCEnteredLengthValue.
hpciCVVDigitsSuccessHandlerThis function is optional and requires iFrame V2 to be enabled on the account and needs to be implemented for sites that use keypress functionality. The function signature should accept CVV length.
hpciInitCompleteSuccessHandlerRequires reportInit to be set to ‘Y’. Invokes the method once iFrame has been initiated into the checkout page.

Other Key Terms

Variables / FunctionDescription
hpciCCFrameNameThe name of the iframe used for displaying the credit card entry fields.
sendHPCIChangeClassMsgThis function is optional and requires iFrame V2 to be enabled on the account and needs to be implemented for sites that require changes to the class of the fields inside the iFrame based on interactive feedback during customer keypress of CC/CVV data. The function signature expects elementId of ccNum/ccCVV from within the iFrame and replaces the class with the new class value that can correspond to the classes from the style header of the iFrame.
sendHPCIChangeStyleMsgThis function is optional. It is required to change the style of the iFrame elements. In order to change the message it requires 3 parameters (elementId, propName, propValue);
sendHPCIChangeTextMsgThis function is optional. It is required to change the message of the iFrame elements such as labels. In order to change the message it requires 2 parameters (elementId, textValue);

HOSTEDPCI IFRAME

HostedPCI iFrame is available in multiple versions to fit your needs:

Installing iFrame:

In order to Install iFrame some JavaScript is required.

Required Javascript (in order):



JavaScript in HEAD section:

iFrame V4 – Latest Version

iFrame V4 is the latest version of the HPCI iFrame that is available.

The V4 iFrame supports features to:

  • Returns hpciMappedCCValue and hpciMappedCVVValue.
  • Return hpciCCBINValue
  • Keypress feedback: returns hpciCCTypeValue, hpciCCBINValue, hpciCCValidValue, hpciCCLengthValue.
  • Returns hpciCCLast4Value
  • Format Credit Card Number in the iFrame (space, tabs or dashes)
  • Mask the credit card number and the CVV in the iFrame.
  • TLS 1.2 protocol.
  • Early Tokenization
  • Report Form Fields

HPCI iFrame V4

 

<iframe id="ccframe" src="https://ccframe.hostedpci.com/iSynSApp/showPxyPage!ccFrame.action?pgmode1=prod&locationName=[Location]&sid=[hpciSiteId]&reportCCType=Y&reportCCDigits=Y&formatCCDigits=Y&formatCCDigitsDelimiter=-&reportCVVDigits=Y&formatCCMaskMode=S6X6&formatCCMaskChar=*&enableEarlyToken=Y&reportFormFields=nameoncard&reportInit=Y&fullParentHost=[ecommerceSiteHostName]&fullParentQStr=[ecommerceURLQueryString]" onload="receiveHPCIMsg()" name="ccframe" width="480" height="150" frameborder="0" scrolling="NO"> If you can see this, your browser doesn't understand IFRAME. </iframe>

 

enableTokenDisplay=Y will enable early Tokenization feature on the iFrame. With Early Tokenization, once users enter a valid credit card number and leave the field the hpciCCCPreliminarySuccessHandlerV4 or hpciCVVPreliminarySuccessHandlerV4 will be invoked which will return the CCToken back to the checkoutPage from HPCI.

reportformfields is the name of the additional form field in the iFrame. In this example reportformfields=nameoncard.

formatCCMaskMode and formatCCMaskChar will mask the ccnum and cccvv. Accepted value for formatCCMaskMode=S6X6. Accepted value for formatCCMaskChar=* or X.

Basic iFrame

To install the HostedPCI iFrame, you will need to place the code where the credit card field will be in your checkout process.

HPCI iFrame V2

You can omit onload=”receiveHPCIMsg()” call if preliminary messages are not required.
If the primary eCommerce site has checkout page URL where HPCI iFrame is displayed as ( https://checkout.myecommercesite.com/MyApp/checkout.asp?param1=value1 ) and if the location name is checkout1 and HCPI site ID is 400001, then HPCI iFrame URL will be as follows:

*Other iframe parameters such as width, height, and borders are adjustable as required for the implementation.

https://ccframe.hostedpci.com/iSynSApp/showPxyPage!ccFrame.action?pgmode1=prod&locationName=checkout1&sid=400001&fullParentHost=https%3A%2F%2Fcheckout.myecommercesite.com&fullParentQStr=%2FMyApp%2Fcheckout.asp%3Fparam1%3Dvalue1

Interactive iFrame (V2)

  • Interactive iFrame provides prompts and feedback during the keypress of credit card# and CVV.
  • It also gives prompt informing of which card type is being used.
  • To use the full functionality of the iFrame additional parameters needs to be added to iFrame URL, as well as making some small changes to the back -end.
  • Format credit card number 3 different ways, dashes, spaces, or tabs.

3 Types of Interactive iFrames

HPCI interactive iFrame Tabs

Key Parameters and Values

reportCCTypeRequires iFrame V2 to be enabled on the account. This function enables keypress feedback for the credit card type within the iFrame. Set to Y if CC data needs to be reported back during key press.
reportCCDigitsRequires iFrame V2 to be enabled on the account. This function enables key press feedback from the ccNum field within the iFrame. Set to Y if CC data needs to be reported back during key press.
reportCVVDigits Requires iFrame V2 to be enabled on the account. This function enables key press feedback from the ccCVV field within the iFrame. Set to Y if CVV data needs to be reported back during key press.
formatCCDigitsCredit card formatting feature, automatically add delimiter while customer types the card in, for example, “4444333322221111” will be turned to “4444-3333-2222-1111”. Turn on or off [Y/N].
formatCCDigitsDelimiterCredit card formatting feature, set the delimiter value which can be space, dash or tab, just need to remember that the value has to be URL encoded [%20/-/%09].
hpciCCDigitsSuccessHandlerV2This parameter needs to be set on the Host Page in order to utilize the keystroke feedback.

Credit Card Field Only iFrame

  • For companies that only require Credit Card Numbers, they can hide the CVV input field in their Basic and Interactive iFrame.
  • Do not delete the CVV field but rather just hide it from being visible so it does not cause any functionality issues.
  • Please insert the code within the iFrame body styling section.


CVV field Only iFrame

  • Sometimes it’s useful to load an iFrame with only the CVV field. That iFrame will be associated with an existing token.
  • Credit Card Token is valid for 18 months but CVV token is only valid for 20 min. If you would like to bill a token that is in the system, but we also want to pass the CVV along with it and it’s been more than 20 minutes, we would need to load a CVV only iFrame that will re-tokenize the CVV to an existing credit card token.
  • When installing CVV only iFrame, please hide the Credit Card field instead of completely removing it
https://ccframe.hostedpci.com/iSynSApp/showPxyPage!ccFrame.action?pgmode1=prod&locationName=checkout1cvvonly&sid=400001&enableTokenDisplay=Y&ccNumTokenIdx=1&ccNumToken=4000000000000001&fullParentHost=[ecommerceSiteHostName]&fullParentQStr=[ecommerceURLQueryString]

Key Parameters and Values

enableTokenDisplaySet to “Y” if you want the iFrame to show the pre-populated masked value that is stored inside. It applies to both credit card and CVV fields. If it’s not empty, it means there is already a value stored inside.
ccNumTokenIdx This parameter is used to define which iFrame index is going to be used. Used mainly for instances where you would need to load multiple iFrames on the same page. Set to “1” unless there is a need for multiple iFrames on the same page. Required for CVV only iFrame.
ccNumTokenIs the credit card token that is associated with the CVV iFrame. To re-tokenize CVV for token 4111-1111-1111-1111 set this parameter to “4111111111111111”.

Multiple iFrames

  • Some instances require loading multiple iFrames on the same page.
  • For example, if there is a requirement to split the payment into multiple credit cards. Another example would be for an agent to have multiple iFrames available to him on a single page load. This way there is no need to reload the page to select a different customer/credit card.
https://ccframe.hostedpci.com/iSynSApp/showPxyPage!ccFrame.action?pgmode1=prod&locationName=checkout1&sid=400001&ccNumTokenIdx=1

Key Parameter

ccNumTokenIdx This parameter is used to define which iFrame index is going to be used. Set to “1” or increment by 1 for every additional iFrame that is required for the same page.

Checkout Page

  • Once information is submitted to iFrame, the credit card token will be returned from HPCI iframe to the main form hosted on the parent page.
  • The following form elements are required.

Fields in the forms

FieldDescription
ccNumCredit Card Number field.
ccCVVCVV field.
ccBINField to display BIN (Bank Identification Number) of the card.
action3DSecOnly required if the 3D Secure functionality is used. Pass the action value to HPCI API in field pxyThreeDSecAuth.actionName so that credit card enrolment in 3D Secure Service is verified.
SubmitJavaScript embedded in the onClick() event will be used to send a message to the iFrame, to submit the credit card info and return token info back to the main form. Use the JavaScript function sendHPCIMsg() to initiate the mapping and submission process.

* ccNum and ccCVV are minimum fields required for an iFrame. Other fields required to process a payment consist of the expiry date, billing info, and more.

Submitting information to your Ecommerce Application

  • Once Credit card token information is returned to the main form the JavaScript provided will submit the main form to the eCommerce application. Token will be submitted along with the rest of the form information.
  • Once the server-side application has the credit card token, all of the credit card operations such as SALE, AUTH, CAPTURE, VOID, and CREDIT will be available to the application through the HCPI server-side API
  • please see Web Service API guide 

How to Handle Tokens

  • Tokens can be stored in the eCommerce application database without risk of compromising PCI compliance.
  • Tokens are designed to look similar to credit card numbers in length and structure without actual valid credit card numbers.
  • The first 4 digits and last 3-4 digits of token match the credit card number but the Tokens are guaranteed NOT to be MOD-10 compatible.

Modifying iFrame CSS

Basic iFrame CSS

  • It may be necessary to update CSS / Style within the iFrame to highlight the error field for example.
  • The following method can be used to initiate style updates for an element within the iFrame. This method can be invoked multiple times to update the style parameters with the iFrame.
  • Make sure ‘hpci-cciframe-1.0.js’ file is included from HPCI servers before making the call.
  • Call signature as follows: sendHPCIChangeStyleMsg(htmlElementID, cssTagName, cssTagValue);
  • Here’s an example of a call to update the credit card number field to red. sendHPCIChangeStyleMsg(“ccNum”, “color”, “red”);

Interactive iFrame(V2) CSS

  •  There is another function available to change CSS class at run time within the iFrame. It is specifically useful to create interactive iFrame experience using the keypress functions that were introduced for iFrame V2.
  • The call signature is as follows: sendHPCIChangeClassMsg(elementId, classValue);
  • For example, to change the class of credit card field inside the iFrame which has the id “ccNum” from the existing class into class “.input-text”, one has to use the following parameters: sendHPCIChangeClassMsg(“ccNum”, “input-text”);

Updating iFrame CSS using Query String Parameters

To use query string parameters to update CSS within the IFRAME, place any of the following place holders in the style tag within the iFrame code:

${pageParam1} / ${pageParam2} / ${pageParam3} / ${pageParam4} / ${pageParam5} / ${pageParam6} / ${pageParam7} / ${pageParam8} / ${pageParam9} 
e.g: style="margin: ${pageParam1} auto;background: ${pageParam2} repeat scroll 0 0 white;

To use query string parameters to update CSS within the iFrame, place any of the following place holders in the style tag within the iFrame code:

https://ccframe.hostedpci.com/iSynSApp/showPxyPage!ccFrame.action?pgmode1=prod&locationName=test1&…….&pageParam1=0&pageParam2=none

Installing the iFrame for 3D Secure PIN Validation (Optional)

Prerequisite
ParametersValues
hpciSiteIdThe site id (a number) configured and provided by HPCI after the activation of the HPCI account. There will be a different Site Id for staging and live sites.
authTxnIdThe unique reference provided by the 3D Secure enrolment verification call.
fullParentHostThe full hostname where the parent e-commerce site resides (not the iframe).
fullParentQStrThe query string currently used by the payment page where the iframe resides. This parameter is required for backward compatibility with browsers that do not support “post” frame messages. This string has to match the current URL that appears on the browser address bar.
  • This is an optional iFrame implementation only for sites that use 3D Secure functionality.
  • The HPCI PIN Validation iFrame can be installed into any form that is required to accept credit card information.
  • This form should be displayed after receiving a response status of “3dsecure” from the HPCI PaymentAuth or PaymentSale call.
  • The returned response should also contain authorization transaction ID (authTxnId)

Example of 3D Secure Pin Validation

  • The following example from the “PCI Direct” website shows the credit card PIN validation from within the My Account section of the website.
  • To install PIN validation iFrame, the following code Should be placed where the credit card field is required.
  • The highlighted top portion of the screenshot shows the portion of the page that is delivered through the iframe. The remainder of the form is provided by the e-commerce site itself, all the user entered data along with tokenized credit card and CVV should be populated in the form for resubmission after the PIN validation completes.

HPCI 3D Verify iFrame

3D Secure Hidden Field / Form Information

  • Once the information is submitted to the iFrame and pin validation is complete, the form is resubmitted to perform the AUTH or SALE operation:
  • The ccNum and ccCVV fields are populated by the eCommerce sites from the previous call when the credit card tokenization iFrame was displayed.
  • The hpci3DSitePINSuccessHandler present in the header section is called once the PIN verification is complete. This handler should initiate the resubmission of the form, this handler can be customized to do any other validation prior to submission if required.

Required parameters to be sent back to HostedPCI (3D Secure only)

Once 3D Secure information has been validated inside the 3D Secure iFrame, the following parameters must be returned back to HPCI:

ParameterValue
pxyThreeDSecAuth.actionNamemust contain “verifyresp”.
pxyThreeDSecAuth.authTxnIdcontains authTxnId that was received from HPCI in the previous call.
pxyThreeDSecAuth.authSignComboList[0] optional, for example “YY”.
pxyThreeDSecAuth.authSignComboList[1] optional, for example “AY”.
pxyThreeDSecAuth.authSignComboList[2]optional, for example “UY”.

Payment API Guide

  • A HostedPCI checkout Web Services API can be accessed by any e-commerce system that needs to process credit card transactions with the use of the HPCI credit card token.
  • HPCI Web Service API can be used in any programming language that supports HTTPS calls. Examples include Java, PHP, and C #.Net.

Two things to keep in mind when making requests with parameters:

  • Parameter values should be UTF-8
  • Requests to the endpoints can be sent as NVP (Name-Value Pair)

Prerequisite

API UserID
Provided by HPCI after the activation of the HPCI account.
API PasskeyProvided by HPCI after the activation of the HPCI account.
HPCI TokensHave been generated and ready to use (implementation of HPCI iFrame Checkout Web Service )
HPCI HOST NAME Provided by HPCI after the activation of the HPCI account.

Setting up API calls

  • API calls to HPCI are made over HTTPS to the provided endpoint URL.
  • Parameters are passed through the standard HTTP POST method.
  • Name-Value pairs are separated by ‘&’ character and are URL Encoded.
  • The  java code will set up and call HPCI API URLs.
  • PHP and C# .Net have similar methods for POSTing HTTP URLs.
  • Full source code is available on file ‘ProxyHPCIProcessorApp.java’
public static String callUrl(String urlString, Map paramMap) { 
  String urlReturnValue = "";
  try {
    // Construct data
    StringBuffer dataBuf = new StringBuffer();
    boolean firstParam = true;
    for (String paramKey : paramMap.keySet()) {
      if (!firstParam) dataBuf.append("&");
      dataBuf.append(URLEncoder.encode(paramKey, "UTF-8")).append("=")
      .append(URLEncoder.encode(paramMap.get(paramKey), "UTF-8"));
      firstParam = false;
    }
    String data = dataBuf.toString();
    // Send data
    URL url = new URL(urlString);
    URLConnection conn = url.openConnection();
    conn.setDoOutput(true);
    OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
    wr.write(data);
    wr.flush();
    // Get the response
    BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
    String line;
    while ((line = rd.readLine()) != null) {
      urlReturnValue = urlReturnValue + line;
    }
    wr.close();
    rd.close();
  } catch (Exception e) {
    e.printStackTrace();
    urlReturnValue = "";
  } 
  return urlReturnValue;
 } //END: callUrl

Required Parameters for Setting up API Calls:

apiVersion[ 1.0.1]
apiType[pxyhpci]
userName[API UserId]
userPassKey[API Passkey]
pxyTransaction.txnPayName[Name of the Payment profile in use]

Some advanced configuration allows multiple payment gateways to be set up with HPCI and specified over API Calls. The above parameter can be used to specify the name. Default value is [DEF]. Profile names must be pre-arranged with the HPCI team.

Reading Results from API Calls

  • The result is returned in Name-Value pair format with URL Encoded Values
  • The java code on the side will read the result from HPCI API Calls and convert to String Map container object.
public static Map parseQueryString(String queryStr) {
 Map map = new HashMap();
 if (queryStr == null)
   return map;
 String[] params = queryStr.split("&"); 
 for (String param : params) {
   String name = "";
   String value = "";
   String[] paramPair = param.split("=");
   if (paramPair != null && paramPair.length > 0) {
     name = paramPair[0];
     if (paramPair.length > 1 && paramPair[1] != null) {
       try {
         value = URLDecoder.decode(paramPair[1], "UTF-8");
       } catch (UnsupportedEncodingException e) {
         logMessage("Could not decode:" + paramPair[1]);
       }
     }
   }
   map.put(name, value);
 } 
 return map;

Credit Card Authorization Transaction (AUTH)

API Endpoint: http://HPCI_API_HOSTNAME/iSynSApp/paymentAuth.action
Additional Required Parameters:
Card Number Related Parameters:
ParametersValues
pxyCreditCard.cardType [Type of Credit Card Used]
pxyCreditCard.creditCardNumber[HPCI Token Representing Credit Card]
pxyCreditCard.expirationMonth[Credit Card Expiry Month]
pxyCreditCard.expirationYear [Credit Card Expiry Year]
pxyCreditCard.cardCodeVerification[HPCI Token Representing CVV Code]
Transaction Amount Related Parameters:
ParametersValues
pxyTransaction.txnAmount[Amount to Authorize]
pxyTransaction.txnCurISO[ “USD” or “CAD” or other ISO Currency Code]
pxyTransaction.merchantRefId [Merchant Reference Number (order Id?)]
pxyTransaction.txnPayName[“DEF” or a payment profile name]
pxyTransaction.txnComment[Empty string or short comment not longer than 50 characters]
pxyTransaction.txnExtraParam1[Not required for all gateways, please ask HPCI support for more details]
pxyTransaction.txnExtraParam2[ Not required for all gateways, please ask HPCI support for more details]
pxyTransaction.txnExtraParam3[Not required for all gateways, please ask HPCI support for more details]
pxyTransaction.txnExtraParam4[Not required for all gateways, please ask HPCI support for more details]
pxyTransaction.txnExtraParam5[Not required for all gateways, please ask HPCI support for more details]
pxyTransaction.txnInstallmentCount[For installment count for the transaction amount not required for all gateways, optional for Global Collect gateway]
pxyTransaction.txnLangCode[For language code for transaction, not required for all gateways, optional for Global Collect gateway]
pxyTransaction.txnDuplicateWindowSeconds[For defining duplicate transaction validation window in seconds, not required for all gateways, optional for Authorize.net]
User Related Parameters:
ParametersValues
pxyCustomerInfo.email[Customer Email Address]
pxyCustomerInfo.customerId[Customer User ID]
Billing Address Related Parameters:
ParametersValues
pxyCustomerInfo.billingLocation.firstName [Customer First Name]
pxyCustomerInfo.billingLocation.lastName [Customer Last Name]
pxyCustomerInfo.billingLocation.address[Customer Billing Street Address]
pxyCustomerInfo.billingLocation.city [Customer Billing City]
pxyCustomerInfo.billingLocation.state [Customer Billing State]
pxyCustomerInfo.billingLocation.zipCode [Customer Billing Zipcode]
pxyCustomerInfo.billingLocation.country [Customer Billing Country]
pxyCustomerInfo.billingLocation.phoneNumber[Customers Billing Phone Number]
Shipping Address Related Parameters:
ParametersValues
pxyCustomerInfo.shippingLocation.firstName [Customer First Name for Shipping]
pxyCustomerInfo.shippingLocation.lastName [Customer Last Name for Shipping]
pxyCustomerInfo.shippingLocation.address[Customer Shipping Street Address]
pxyCustomerInfo.shippingLocation.city [Customer Shipping City]
pxyCustomerInfo.shippingLocation.state [Customer Shipping State]
pxyCustomerInfo.shippingLocation.zipCode [Customer Shipping Zipcode]
pxyCustomerInfo.shippingLocation.country [Customer Shipping Country]
pxyCustomerInfo.shippingLocation.phoneNumber[Customers Shipping Phone Number]
Other Optional Parameters:
ParametersValues
pxyCustomerInfo.customerIP[Customer IP Address]
pxyOrder.invoiceNumber[Additional Merchant Identifier (order Id)]
pxyOrder.description [Order Description]
pxyOrder.totalAmount[Total Amount of Order]
AUTH Request example:
pxyTransaction.txnPayName=DEF_WIRE&apiVersion=1.0.1&apiType=pxyhpci&userName=[API-USER]&userPassKey=[API_PASSKEY]&pxyCreditCard.creditCardNumber=[4200********1542].&pxyCreditCard.expirationMonth=10&pxyCreditCard.expirationYear=2024&pxyCreditCard.cardCodeVerification=200&pxyTransaction.txnAmount=0.95&pxyTransaction.txnCurISO=EUR&pxyTransaction.merchantRefId=[Merchant-ID]&pxyCustomerInfo.billingLocation.firstName= &pxyCustomerInfo.billingLocation.lastName=Livecareer&pxyCustomerInfo.customerId=2188000&pxyCustomerInfo.profileAction=add&pxyCustomerInfo.billingLocation.address=&pxyCustomerInfo.billingLocation.city=&pxyCustomerInfo.billingLocation.state=&pxyCustomerInfo.billingLocation.zipCode=&pxyCustomerInfo.billingLocation.country=&pxyTransaction.merchantPhoneNum=1800283878&pxyCustomerInfo.customerIP=52.242.23.44
AUTH Response example:
status=success&operId=&saleId=527389371&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=5756ea78-19a8-41ba-8fad-27a1bc559da8&pxyResponse.processorType=wirecardResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst=VISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=&pxyResponse.responseAVS1=&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=3d-acquirer:The resource was successfully created.&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=status-code=201.0000&status-description=3d-acquirer%3AThe+resource+was+successfully+created.&merchant-account-id=1b3be510-a992-48aa-8af9-6ba4c368a0ac&transaction-id=5756ea78-19a8-41ba-8fad-27a1bc559da8&request-id=2657335642007935744&transaction-type=purchase&transaction-state=success&completion-time-stamp=2020-05-05T15%3A32%3A16.000Z&requested-amount=0.95&account-holder=Livecareer&ip-address=52.242.23.44&descriptor=1800283878&payment-methods=&authorization-code=792301&api-id=elastic-api&provider-account-id=70010&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_WIRE&pxyResponse.responseStatus.code=201.0000&pxyResponse.threeDSSRS=

Credit Card Capture Transaction (CAPTURE)

API End point: HPCI_API_HOSTNAME/iSynSApp/paymentCapture.action
Additional Required Parameters:
Transaction Amount Related Parameters:
ParametersValue
pxyTransaction.txnAmount[Transaction Amount to Capture]
pxyTransaction.txnCurISO[ “USD” or other ISO Currency Code]
pxyTransaction.merchantRefId[Merchant Reference Number (order Id)]
Processor ID Parameters:
ParametersValue
pxyTransaction.processorRefId[Processor ID provided from Authorization or Sale]
The pxyTransaction.processorRefId is returned from AUTH (authorization) transaction and must be provided for funds to be captured.
CAPTURE Request example:
apiVersion=1.0.1&pxyTransaction.processorRefId=[AUTH_REF_ID]&userPassKey=[API-PASSKEY]&pxyTransaction.txnAmount=45.45&userName=[API-USERNAME]&pxyTransaction.txnCurISO=USD&apiType=pxyhpci&pxyTransaction.merchantRefId=[MerchantID]
CAPTURE Response example:

status=success&operId=&captureId=[CAPTURE_REF_ID]&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=[AUTH_REF_ID]&pxyResponse.processorType=anetResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DMASTER_CARD&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=APPROVED&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=&pxyResponse.responseAVS1=P&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=This+transaction+has+been+approved.&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=1&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=txnResponse.target.transactionId%3D40048550306%26txnResponse.declined%3DN%26txnResponse.review%3DN%26txnResponse.responseReasonCode.notes%3D%26txnResponse.approved%3DY%26txnResponse.responseReasonCode.reasonText%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.responseText%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.responseCode.name%3DAPPROVED%26txnResponse.error%3DN%26txnResponse.responseCode.code%3D1%26txnResponse.responseCode.description%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.target.authorizationCode%3D3KG7PD%26txnResponse.responseReasonCode.responseReasonCode%3D1&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF&pxyResponse.responseStatus.code=1&pxyResponse.threeDSSRS=






Credit Card Sale Transaction (SALE)

API End point: HPCI_API_HOSTNAME/iSynSApp/paymentSale.action

The SALE API call is performed exactly the same way as an AUTH, with a different API endpoint. The funds from a SALE operation will be immediately captured and a CAPTURE operation will not need to follow a SALE operation. However, CAPTURE operations should always follow AUTH operations in order to fully complete a credit card transaction when using AUTH

Credit Card Void Transaction (VOID)

API Endpoint: HPCI_API_HOSTNAME/iSynSApp/paymentVoid.action
Additional Required Parameters:
Transaction Amount Related Parameters
ParametersValue
pxyTransaction.txnAmount[Transaction Amount to VOID]
pxyTransaction.txnCurISO[“USD” or other ISO Currency Code]
pxyTransaction.merchantRefId[Merchant Reference Number (order Id)]
Processor ID Parameters:
ParametersValue
pxyTransaction.processorRefId[Processor ID provided from Authorization or Sale]

The pxyTransaction.processorRefId is returned from AUTH (authorization) transaction and must be provided for funds specified (partial or full) to be voided and funds relinquished back to the original credit card in question.

VOID Request example:
apiVersion=1.0.1&pxyTransaction.processorRefId=[AUTH_REF_ID]&userPassKey=[API-PASSKEY]&pxyTransaction.txnAmount=45&userName=[API-USER_NAME]&pxyTransaction.txnCurISO=USD&apiType=pxyhpci&pxyTransaction.merchantRefId=[MERCHANT-ID]
VOID Response example:
status=success&operId=&voidId=[VOID_REF_ID]&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=[AUTH_REF-ID]&pxyResponse.processorType=anetResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3D&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=APPROVED&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=&pxyResponse.responseAVS1=P&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=This+transaction+has+been+approved.&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=1&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=txnResponse.target.transactionId%3D40048550306%26txnResponse.declined%3DN%26txnResponse.review%3DN%26txnResponse.responseReasonCode.notes%3D%26txnResponse.approved%3DY%26txnResponse.responseReasonCode.reasonText%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.responseText%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.responseCode.name%3DAPPROVED%26txnResponse.error%3DN%26txnResponse.responseCode.code%3D1%26txnResponse.responseCode.description%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.target.authorizationCode%3D3KG7PD%26txnResponse.responseReasonCode.responseReasonCode%3D1&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF&pxyResponse.responseStatus.code=1&pxyResponse.threeDSSRS=

Credit Card Credit Transaction (CREDIT)

API End point URL: HPCI_API_HOSTNAME/iSynSApp/paymentCredit.action
Additional Required Parameters:
Transaction Amount Related Parameters:
ParametersValue
pxyTransaction.txnAmount [Transaction Amount to Credit]
pxyTransaction.txnCurISO[ “USD” or other ISO Currency Code]
pxyTransaction.merchantRefId[Merchant Reference Number (order Id)]
Processor ID Parameters:
ParametersValue
pxyTransaction.processorRefId [Processor ID provided from Authorization or Sale]
The pxyTransaction.processorRefId is returned from AUTH (authorization) transaction and must be provided for funds specified (partial or full) to be credited back to the original credit card in question.
CREDIT Request example:
apiVersion=1.0.1&pxyTransaction.processorRefId=[AUTH_REF_ID]&userPassKey=[API_PASSKEY]&pxyTransaction.txnAmount=22&userName=[API_USERNAME]&pxyTransaction.txnCurISO=USD&apiType=pxyhpci&pxyTransaction.merchantRefId=[MERCHANT_ID]
CREDIT Response example:
status=success&operId=&creditId=529326875&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=40048764072&pxyResponse.processorType=anetResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DMASTER_CARD&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=APPROVED&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=&pxyResponse.responseAVS1=P&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=This+transaction+has+been+approved.&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=1&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=txnResponse.target.transactionId%3D40048764072%26txnResponse.declined%3DN%26txnResponse.review%3DN%26txnResponse.responseReasonCode.notes%3D%26txnResponse.approved%3DY%26txnResponse.responseReasonCode.reasonText%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.responseText%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.responseCode.name%3DAPPROVED%26txnResponse.error%3DN%26txnResponse.responseCode.code%3D1%26txnResponse.responseCode.description%3DThis%2Btransaction%2Bhas%2Bbeen%2Bapproved.%26txnResponse.target.authorizationCode%3D%26txnResponse.responseReasonCode.responseReasonCode%3D1&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF&pxyResponse.responseStatus.code=1&pxyResponse.threeDSSRS=

Gateway Tokenization

API endpoint: HPCI_API_HOSTNAME/iSynSApp/paymentGatewayToken.action
Tokenization Related Parameters:
ParametersValue
pxyCreditCard.creditCardNumber [HostedPCI Token]
pxyCreditCard.cardCodeVerification[HostedPCI CVV place holder]
pxyCreditCard.expirationMonth [Credit Card expire month]
pxyCreditCard.expirationYear[Credit Card expire year]
pxyTransaction.txnPayName[Profile Name provided by HostedPCI]
pxyCustomerInfo.billingLocation.firstName[Client’s first name as it appears on the card]
pxyCustomerInfo.billingLocation.lastName[Client’s last name as it appears on the card]

API Response Variables

The API will call responds with the following name-value pairs.

NameValueAdditional Info.
Status[success | error]The Status response variable indicates if the API call is well-formed, with an appropriate result. An error result will indicate that either the request was not well-formed or that the transaction was not successful. A success result will indicate that the request was well-formed and that the attempted transaction was successful.
pxyResponse.responseStatus
[approved I declined | error | review | 3dsecure]The only transaction response considered successful for pxyResponse.responseStatus is the approved status. Any other response should be considered an error. In case of a successful transaction, the authorization code may be obtained as per the following response variable:
pxyResponse.processorRefId[Valid Authorization Code from Credit Card Processor]
Once the authorization code is obtained through pxyResponse.processorRefId it should be used for subsequent calls for the following operations: CAPTURE, CREDIT, and VOID. See the documentation for these operations below.
pxyResponse.processorType [name of payment processor or gateway processing the transaction]The response value will be one of:
pflResponse – Paypal Payflow Processor
cybResponse – CyberSource Processor
strResponse – Star Card Processor
anetResponse – Authorize.Net Processor
monResponse – Moneris Response
psiResponse – PSiGate Response
ponResponse – Paymentech Orbital Processor
wproResponse – Paypal Website PaymentPro Processor
snetResponse – SecureNet Processor
ipayResponse – Planet Payment iPay Processor
prismpayResponse – Prism Pay Processor
worldpayResponse – WorldPay Processor
optimalResponse – Optimal Processor
globalcResponse – Global Collect Processor
rakutenResponse – Rakuten Processor
ogoneResponse – Ogone Processor
3dsecResponse – 3D Secure response
msgDispatchResponse – Message Dispatch response
fileDispatchResponse – File Dispatch response

The following response values are used to determine why a particular transaction has failed for approval (decline, error, or review states).

NameValue
pxyResponse.responseStatus.name[short description of response]
pxyResponse.responseStatus.code[alphanumeric code representing response]
pxyResponse.responseStatus.description[long description and informational text of response]
pxyResponse.responseStatus.reasonCode[Gateway specific reason code]

This field contains the reason code for a successful or unsuccessful transaction reported by the payment gateway. This field is populated if available.

NameValue
pxyResponse.fullNativeResp[Gateway specific result set, URL encoded]

This field returns the entire result set from the payment processor or gateway. The actual gateway used can be found by inspecting the pxyResponse.processorType response field. The native response is flattened into name-value pairs, separated with & and URL encoded.

Fraud Detection Service Parameters (Optional)

  • The Authorization (and Sale) API’s also allows for passing fraud detection service parameters.
  • Please Enable ‘Fraud Detection Service’ before passing the fraud detection parameters.
  • Fraud Detection parameters are passed in an array, notated by [] array syntax.
  • Repeat the following parameters pairs for each parameter that is required by the service.
Parameters
Value
fraudChkParamList[x]. name[Parameter Name]
fraudChkParamList[x]. value[Parameter Value]
fraudChkParamList[x]. type[Optional [Parameter Type, either “data” or “map”]
fraudChkParamList[x]. mappedValue[optional [Parameter Mapped Value]
fraudChkParamList[x]. groupIdx[optional [Parameter Group Index]

Where [x] starts at 0 and increases with each parameter name and value added. Please refer respective documentation provided by the supported fraud detection service (Kount, Retail Decision, MaxMind) to find the required parameters for a successful call.

Fraud Service Related Response Fields

The following response values are used to determine the status of a fraud verification call if fraud management was enabled.

ParametersValue
frdChkResp.fullNativeResp[full response of a call to fraud checking service]

Kount Related Service Parameters (Optional)

As Part of our Kount Integration, Hosted PCI allows us to pass mapped values for AVST, AVSZ, CVVR, UDF according to the Kount documentation.

AVST, AVSZ, CVVR

AVST, AVSZ, CVVR are used to pass address verification and CVV verification codes from the payment gateway to Kount.

Because the codes from the gateway are going to be different from the possible code values for Kount (possible values are “M” or “N”), you need to create a mapping for every call that will define the relationship between gateway codes and the kount codes.

Example: If you are using PayPal Payflow pro and they are reporting back AVS1 code Y and AVS2 code Y and CVV1 code Y (avs1= Y, avs2 = Y, cvv1=Y) and you want those values to be passed to Kount as a match then you are going to populate the following in your request to HostedPCI.

ParameterValue
fraudChkParamList[x].name[AVST]
fraudChkParamList[x].value[Y]
fraudChkParamList[x].type[map]
fraudChkParamList[x].mappedValue[M]
fraudChkParamList[y].name[AVSZ]
fraudChkParamList[y].value[Y]
fraudChkParamList[y].type[map]
fraudChkParamList[y].mappedValue[M]
fraudChkParamList[z].name[CVVR]
fraudChkParamList[z].value[Y]
fraudChkParamList[z].type[map]
fraudChkParamList[z].mappedValue[M]

All possible mapping combinations that are applicable to your use case and your payment gateway should be included in the request.

UDF

Kount also allows for User Defined Field (UDF) which can be added to the request similar to the way we did the AVS mapping.

– If we want to pass to Kount 2 UDF’s, one for BILL_COMPANY_NAME, and the second SHIP_COMPANY_NAME, we can pass the following.

ParameterValue
fraudChkParamList[x].groupIdx[1]
fraudChkParamList[x].name[UDFN]
fraudChkParamList[x].value[BILL_COMPANY_NAME]
fraudChkParamList[x].groupIdx[1]
fraudChkParamList[x].name[UDFV]
fraudChkParamList[x].value[HostedPCI]
fraudChkParamList[x].groupIdx[2]
fraudChkParamList[x].name[UDFN]
fraudChkParamList[x].value[SHIP_COMPANY_NAME]
fraudChkParamList[x].groupIdx[2]
fraudChkParamList[x].name[UDFV]
fraudChkParamList[x].value[HostedPCI]

It’s also possible to pass some values from the gateway response dynamically to a UDF, please contact HostedPCI if you need it.

Credentials on File

HostedPCI’s Credentials on File feature allows merchants the ability to store the issuer ID alongside the credit card to be used for a later date. With Credentials on File, Merchants will be able to charge a customer’s card even when the customer is not present. The Credentials on File can be used along with the 3D Secure feature or as a feature on its own.

The following parameters are required to set up a transaction with the credentials on file feature.

ParameterValue
pxyTransaction.cardOnFileTxnType[TxnType]
pxyTransaction.cardOnFileTxnRef[TxnRedID]
pxyTransaction.cardOnFileIssuerId[IssuerID]
pxyTransaction.cardOnFileOrigAmt[Original Amount]
pxyTransaction.cardOnFileFraudIndicator[FraudIndicator]

3D Secure (Verified by Visa and MasterCard securecode) Parameters (Optional)

  • The Authorization (and Sale) API also allows for passing payer authentication information.
  • 3D Secure information is OPTIONAL and will be required only if the 3D Secure service has been SUBSCRIBED with the payment gateway.
ParametersValue
pxyThreeDSecAuth.actionName
[Empty string when no 3D Secure action is requested. Pass “verifyenroll” when card enrollment needs to be verified. Pass “verifyresp” when an authentication response needs to be verified.]
pxyThreeDSecAuth.authTxnId
[Authentication id received from “verifyenroll” call.]
pxyThreeDSecAuth.paReq[The payer authentication request value received from “verifyenroll” call]
pxyThreeDSecAuth.paRes[The payer authentication response value received from pin verification call]
pxyThreeDSecAuth.authSignComboList[x]
[The combined statuses of Authentication Result + Signature Result that are acceptable. The results are received after the verification call is completed by HPCI service before requesting an Authorization from the payment gateway. Typical values are “YY”, “AY” and “UY”. Where [x] starts at 0 and increases with each item added.]
Item Related Parameters (Optional)
  • The Authorization (and Sale) API’s also for the passing of individual order item information.
  • Line item information is Optional.
  • Order Items are passed as parameters in an array, notated by [] array syntax. Repeat the following parameters for each order in the order that is being processed.
ParametersValue
pxyOrder.orderItems[x].itemId[Merchant Item ID]
pxyOrder.orderItems[x].itemName[Merchant Item Name]
pxyOrder.orderItems[x]. itemDescription[Merchant Item Description]
pxyOrder.orderItems[x]. itemQuantity[item Quantity Ordered]
pxyOrder.orderItems[x]. itemPrice[item Price per Unit]
pxyOrder.orderItems[x]. itemTaxable[Is Item Taxable Y/N]

Where [x] starts at 0 and increases with each item added.

3D Secure Related Response Fields
  • If the response Status is 3D Secure then the 3D Secure PIN verification is required to proceed with authorization.
  • Please review the ‘3D Secure PIN verification’ section for details. Use the following parameters to initiate the PIN verification call:
ParametersValue
pxyResponse.threeDSAcsUrl[ACS Url received from the “verifyenroll” call]
pxyResponse.threeDSTransactionId[Transaction Id received from the “verifyenroll” call]
pxyResponse.threeDSPARequest[Payer Authentication Request received from the “verifyenroll” call]

These 3 response variables will be provided verbatim from the payment gateway configured for the HPCI API account. Documentation from the payment gateway should be used to discern the error in question.

3D Secure 1.0 Cardinal Commerce Implementation

  • HostedPCI offers ThreeD Secure 1.0 implementation with Cardinal Commerce.
  • The following parameters are required to make a successful 3D secure 1.0 authentication with Cardinal Commerce.
  • The table below contains parameters required to make a ‘verifyenroll’ call to ensure the credit card is eligible for 3d secure.
ParametersValue
pxyThreeDSecAuth.actionName
verifyenroll
pxyTransaction.txnPayName3dsPayProfile – Name of the 3d secure payment profile.
pxyThreeDSecAuth.callModereportall- will return once 3d secure has been authenticated with credentials for second API call
  • If the ‘verifyenroll’ call was successful it will return some parameters with data needed for the second API call (verifyresp).
  • The table below lists the parameters required to make a successful pin verification call for 3DS 1.0 with cardinal commerce.
ParametersValue
pxyThreeDSecAuth.actionName
verifyresp
pxyTransaction.txnPayName3dsPayProfile – Name of the 3d secure payment profile.
pxyThreeDSecAuth.authTxnIdthreeDSTransactionId – returned from the ‘verifyenroll’ call.

3d Secure 1.0 WorldPay Implementation

  • HostedPCI offers 3dSec 1.0 implementation with WorldPay.
  • In Order to make a successful verifyenroll call the following parameters are required.
ParameterValue
pxyTransaction.txnPayName[3dsPayProfile] – Name of the 3d secure payment profile.
pxyThreeDSecAuth.actionName[verifyenroll]
pxyCustomerInfo.browserAcceptHeader[browserAcceptHeader]
pxyCustomerInfo.browserUserAgentHeader[browseruserAgentHeader]
pxyThreeDSecAuth.callMode[reportall] – will return once 3d secure has been authenticated with credentials for second API call
pxyCustomerInfo.sessionId[sessionID] – also needed in the verifyresp call
pxyCustomerInfo.billingLocation.firstName[3D] – to initiate world pay 3DSec 1.0
  • If verifyenroll call was successful it will return parameters required to make verifyresp call.
  • The following parameters are required for PIN verification call.
ParameterValues
pxyTransaction.txnPayName[3dPayProfileName]
pxyThreeDSecAuth.actionName[verifyresp]
pxyThreeDSecAuth.authTxnId[threeDSTransactionId] – returned from the ‘verifyenroll’ call.
pxyCustomerInfo.sessionId[sessionID] – same as the verifyenroll call

3D Secure 2.0

  • HostedPCI offers 3DS 2.0 implementation with Cardinal Commerce and World Pay.
  • With 3DS 2.0 implementation the 3ds setup needs to occur during the iFrame setup.
  • The following parameters are required in the iFrame SRC in order to set up 3DS 2.0.
iFrame ParametersValues
enable3DSec[cruise1 / wpflex1] – cruise1 for cardinal commerce 2.0 and wpflex1 for worldpay 2.0.
selected3DSecPayNamename of the 3d secure payment profile.
selected3DSecPayCCTypeCredit Card Type. can be set to [any] if not specified.
selected3DSecPayCurISOThe currency of the transaction. can be set to [any] if not specified.

3D Secure 2.0 implementation with Cardinal Commerce

  • In Order to implement ThreeDSec 2.0 with CardinalCommerce following parameters are required.
  • The below table contains parameters required for ‘verifyenroll’ call.
ParametersValue
pxyTransaction.txnPayName[3ds payment profile name]
pxyThreeDSecAuth.actionName[verifyenroll]
pxyThreeDSecAuth.callModereportall
pxyThreeDSecAuth.authSessionId[cruiseSessionId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
pxyThreeDSecAuth.authOrderId[threeDSOrderId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
  • If verifyenroll call was successful it will return parameters required to make verifyresp call.
  • The following parameters are required for the verification call.
ParameterValues
pxyTransaction.txnPayName[3dPayProfileName]
pxyThreeDSecAuth.actionName[verifyresp] – not required for frictionless transaction
pxyThreeDSecAuth.authTxnId[threeDSTransactionId] – returned from the ‘verifyenroll’ call.
pxyThreeDSecAuth.authSessionId[SessionID] – same as verifyenroll call

3D Secure 2.0 Implementation with World Pay

  • In Order to implement ThreeDSecure 2.0 with WorldPay the following parameters are required.
  • The table below contains the parameter required for the verifyenroll call.
ParametersValues
pxyThreeDSecAuth.authSessionId[cruiseSessionId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
pxyThreeDSecAuth.authOrderId[threeDSOrderId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
pxyCustomerInfo.billingLocation.firstName[ 3DS_V2_CHALLENGE_IDENTIFIED] – to initiate 3ds challange process
pxyCustomerInfo.browserAcceptHeader[browserAcceptHeader]
pxyCustomerInfo.browserUserAgentHeader[browserUserAgentHeader]
pxyThreeDSecAuth.callMode[reportall]
pxyTransaction.txnPayName[3dsecProfileName]
  • If ‘verifyenroll’ was successful it will return parameters required for verification call.
  • The table below contains parameters required to make the second auth call with worldpay 3ds 2.0.
ParametersValues
pxyThreeDSecAuth.authTxnId[threeDSTransactionId] – returned from the ‘verifyenroll’ call]
pxyTransaction.txnPayName[3dPayProfileName]
pxyThreeDSecAuth.authSessionId[same as the verifyenroll call]
pxyThreeDSecAuth.authSessionId[same as the verifyenroll call]

Delayed Bin (3DS 2.0)

  • At HostedPCI we offer delayedBin feature with 3ds 2.0 implementation.
  • DelayedBin feature allows clients to delay the 3ds setup process.
  • To enable the Delay Bin feature the iFrame SRC needs to declare “enable3DSec=waitbin”.
  • The client can declare the 3ds setup parameters after receiving CC Bin.
  • Invoking 3DS setup parameter within a successhandler : sendHPCISet3DSecParamMsg(“cruise1”, “DEF_3DSEC”, “any”, “any”);
There are two ways to implement DelayedBin feature with EarlyTokenization and without EarlyTokenization.

With Early Tokenization.

  • Can reduce the processing time significantly by generating token and receiving bin info before submitting the form
  • If 3DS implementation is required, it can reduce the time it takes to initiate a 3D secure setup.

HPCI Early Token Network

The image above is the network call of the page containing iFrame with delayedbin and earlytokenization. This process took 1600 ms to complete meaning in 1600ms the form was filled, submitted, returned tokens and card information, and submitted that info. In this process, a token was generated and returned while the user was still filling out the form.

Without Early Token:

  • Allows clients to change the credit card number until the form is submitted.
  • Token and card numbers are processed and returned after the form has been submitted.

HPCI Late Token Network

The image above is the network call of the page containing iFrame with delayedbin but not earlytokenization. This process took almost 7000 ms to complete as the Tokenization process does not begin until the form is submitted. In this process, a token was generated and returned while the user was still filling out the form. This process took 4 times longer than the process with earlyTokenization.

3D Secure 2.0 Implementation with Stripe Pay Intent

  • In order to implement 3Dsecure 2.0 with stripe pay intent, the following parameters are required.
  • The table below contains the additional required parameters during the first 3Ds API call (‘verifyenroll’).
ParameterValues
pxy.Transaction.txnPayName[NameofStripePayProfile]
pxyThreeDSecAuth.callMode[reportall]
pcyThreeSecAuth.actionName[verifyenroll]
  • If verifyenroll call was successful it will return parameters required to make the second API call (‘verifyresp’).
  • The table below contains parameters required for the ‘veriresp’ call.
ParameterValues
pxy.Transaction.txnPayName[NameofStripePayProfile]
pcyThreeSecAuth.actionName[verifyresp]
pxyThreeDSecAuth.authTxnId[threeDSTransactionId – returned from the ‘verifyenroll’ call]

3D secure 2.0 implementation with Sage Payment

  • In order to implement 3D secure 2.0 with sage pay, the following parameters are required.
  • The table below contains the additional required parameters for the first API call (verifyenroll).
ParametersValues
pxyCustomerInfo.browserAcceptHeader[browser accept header]
pcyCustomerInfo.browserUserAgentHeader[browser user agent header]
pxyThreeDSecAuth.actionName[verifyenroll]
pcyThreeDSecAuth.callMode[reportall]
pxyCustomerInfo.sessionId[sessionId]
  • If ‘verifyenroll’ call was successful and 3ds was enrolled the response will return some parameters required for the second API call (verifyresp).

  • The table below contains parameters required for the ‘verifyresp’ call.

ParametersValues
pxyThreeDSecAuth.actionName[verifyresp]
pcyThreeDSecAuth.authTxnId[threeDsTransactionID – response of verifyenroll call]
pxyCustomerInfo.sessionId[sessionId]-same as verifyenroll call

Phone Session API Guide

  • This guide provides implementation details to set up a telephonic call session and get the mapped credit card for the credit card entered via the telephone.
  • The HostedPCI token provided back by the IVR can be stored within your system for future use. The token will remain active for 18 months from the last time it is used.

Prerequisite

API UsernameProvided by HPCI after the activation of the HPCI account.
API PasskeyPass-Keys are created for individual telephone agent Username through the HostedPCI portal.
API URLProvided by HPCI after the activation of the HPCI account.

* The individual UserName / PassKey combination of the agent in question should be used to create each session.

Call Session Setup Service

  • HostedPCI phone session setup service is called to initiate a session on the online portal so that it can be used by the telephonic call.
  • This call should be made only once for every phone call.

A session setup service call to HostedPCI requires the following parameters posted to the URL:

http:///iSynSApp/manageCCMapPhoneAPI.action?cmd=createsession&userName=&userPassKey=&promptLang=&cvvEntry=&sessionKeyType=&userMarker1=&userMarker2=&userMarker3=
Parameter NameParameter value
Username[API username from HostedPCI]
userPassKey[API passkey from HostedPCI]
cmd[createsession]
promptLang[en_US]
cvvEntry[Default value: request, possible values request | skip]
sessionKeyType[Default value: user, possible values user | venue]
userMarker1[Optional parameter for the user-based session key, the required parameter for venue based session key. Setup user identifying marker for venue based session key to assign sessions handled by a client user.]
userMarker2[Optional parameter. Setup user identifying marker for venue based session key to assign sessions handled by a client user.]
userMarker3[Optional parameter. Setup user identifying marker for venue based session key to assign sessions handled by a client user.]
  • The venue-based phone sessions can be created by the phone session API user ID/passkey combination.
  • AT least one user marker is necessary to successfully create a venue session and assign the phone session to the user handling the call bridge.
  • The API user-id caller handles the responsibility of assigning suitable unique user markers using available user marker fields 1,2, or 3 on the phone session setup API.

If the call is successful the following return parameters will be provided in a URL encoded result set:

status=success&sessionId=125040&sessionType=ccmap&sessionStatus=open&sessionKey=2034025040&sessionTaskCount=1&sessionTask[1].type=sessionsetup&sessionTask[1].status=created&sessionTask[1].promptCode=created_entersession&sessionTask[1].completionCode=waiting&sessionTask[1].completionCode=waiting&sessionTask[1].exceptionMsg=&sessionTask[1].comment=&sessionTask[1].paramName=&sessionTask[1].paramValue=&sessionTask[1].createTS=
Parameter NameParameter value
Status[success|error]
Sessionid[7 digit session id that is used to identify the IVR session]
sessionType[Ccmap]
sessionStatus[open]
sessionKey[Session key to be entered by the telephone operator over the phone call]
sessionTaskCount[Task count list for the session]
sessionTask.type [sessionsetup| ccmapsetup | cccvvsetup]
sessionTask.status[Created | success | failed]
sessionTask.promptCode[Created_session | created_enterccnum | created_entercccvv]
sessionTask.completionCode[waiting | success | error]
sessionTask.exceptionMsg[Message for the exception]
sessionTask.comment[Comments]
sessionTask.createTS[Create time for the session]

Call Session Status Service

  • HostedPCI phone session status service is called to check the progress of a session so the interaction on the phone service can be reported Periodically.
  • This can be invoked multiple times per phone session.

A Session status update service call to HostedPCI requires the following parameters posted to the URL:

http:///iSynSApp/manageCCMapPhoneAPI.action?cmd=showprogress&userName=&userPassKey=&selectedPcsId=
Required Parameters:
Parameter NameParameter value
userNameAPI username from HostedPCI
userPassKeyAPI passkey from HostedPCI
cmdshowprogress
selectedPcsId7 digit session-id that was received when IVR session was created

If the call is successful the following return parameters will be provided based on the progress of the session:

status=success&sessionId=&sessionType=ccmap&sessionStatus=complete&sessionKey=&sessionTaskCount=3&sessionTask[1].type=sessionsetup&sessionTask[1].status=success&sessionTask[1].promptCode=created_entersession&sessionTask[1].completionCode=success&sessionTask[1].completionCode=success&sessionTask[1].respToken1=&sessionTask[1].respToken2=&sessionTask[1].respToken3=&sessionTask[1].exceptionId=&sessionTask[1].exceptionMsg=&sessionTask[1].comment=&sessionTask[1].paramName=&sessionTask[1].paramValue=&sessionTask[1].createTS=&sessionTask[2].type=ccmapsetup&sessionTask[2].status=success&sessionTask[2].promptCode=created_enterccnum&sessionTask[2].completionCode=success&sessionTask[2].completionCode=success&sessionTask[2].respToken1=&sessionTask[2].respToken2=&sessionTask[2].respToken3=&sessionTask[2].exceptionId=&sessionTask[2].exceptionMsg=&sessionTask[2].comment=&sessionTask[2].paramName=mappedcc&sessionTask[2].paramValue=&sessionTask[2].createTS=<>createTime&sessionTask[3].type=cccvvsetup&sessionTask[3].status=success&sessionTask[3].promptCode=created_entercccvv&sessionTask[3].completionCode=success&sessionTask[3].completionCode=success&sessionTask[3].respToken1=100&sessionTask[3].respToken2=&sessionTask[3].respToken3=&sessionTask[3].exceptionId=&sessionTask[3].exceptionMsg=&sessionTask[3].comment=Masked+CVV%3A100&sessionTask[3].paramName=&sessionTask[3].paramValue=&sessionTask[3].createTS=
Parameter NameParameter value
Status[success|error]
Sessionid[7 digit session id that is used to identify the IVR session]
sessionType[Ccmap]
sessionStatus[open|closed|terminate]
sessionKey[Session key to be entered by the telephone operator over the phone call]
sessionTaskCount[Task count list for the session]
sessionTask.type [sessionsetup| ccmapsetup | cccvvsetup]
sessionTask.status[Created | success | failed]
sessionTask.promptCode[Created_session | created_enterccnum | created_entercccvv]
sessionTask.completionCode[waiting | success | error]
respToken1[Extra details for the response. This field will contain the mapped CVV token for task type cccvvsetup]
respToken2[Extra details for the response.]
respToken3[Extra details for the response]
sessionTask.exceptionMsg[Message for the exception]
sessionTask.exceptionId[ID for the exception]
sessionTask.comment[Comments]
sessionTask.createTS[Create time for the session]
sessionTask.paramName[Mappedcc]
sessionTask.paramValue[Tokenized credit card number]
Clear Call CVV Service
  • HostedPCI phone CVV clearing service is called to clear any stored CVV values for the session.
  • This call should be made only once for every phone call.
  • This call is not required, the CVV will be cleared after it is used for the Authorize or Sale call or at the end of session expiry.

A CVV clearing service call to HostedPCI requires the following parameters posted to the URL:

http:///iSynSApp/manageCCMapPhoneAPI.action?cmd=clearcvv&userName=&userPassKey=&selectedPcsId=

Required Parameters:
Parameter NameParameter value
userNameAPI username from HostedPCI
userPassKeyAPI passkey from HostedPCI
cmdclearcvv
selectedPcsId7 digit session-id that was received when IVR session was created

If the call is successful the following return parameters will be provided in a URL encoded result set:

status=success&sessionId=125040&sessionType=ccmap&sessionStatus=open&sessionKey=2034025040&
sessionTaskCount=1&sessionTask[1].type=sessionsetup&sessionTask[1].status=created&
sessionTask[1].promptCode=created_entersession&sessionTask[1].completionCode=waiting&
sessionTask[1].completionCode=waiting&sessionTask[1].exceptionMsg=&sessionTask[1].comment=&
sessionTask[1].paramName=&sessionTask[1].paramValue=&sessionTask[1].createTS=
Parameter NameParameter value
Status[success|error]
Sessionid[7 digit session id that is used to identify the IVR session]
sessionType[Ccmap]
sessionStatus[open|closed|terminate]
sessionKey[Session key to be entered by the telephone operator over the phone call]
sessionTaskCount[Task count list for the session]
sessionTask.type [sessionsetup| ccmapsetup | cccvvsetup]
sessionTask.status[Created | success | failed]
sessionTask.promptCode[Created_session | created_enterccnum | created_entercccvv]
sessionTask.completionCode[waiting | success | error]
sessionTask.exceptionMsg[Message for the exception]
sessionTask.comment[Comments]
sessionTask.createTS[Create time for the session]

Terminate Call Session Service

  • HostedPCI phone session terminates service is called to terminate the phone session by administrator request.
  • The Phone session will be terminated when ‘#’ Key is entered on the phone session.
  • This call should be made only once for every call.
  • This call is not required, the call can progress to a natural completion.

A session termination service call to HostedPCI requires the following parameters posted to the URL:

http:///iSynSApp/manageCCMapPhoneAPI.action?cmd=terminatesession&userName=&userPassKey=&selectedPcsId=
Required Parameters
Parameter NameParameter value
userNameAPI username from HostedPCI
userPassKeyAPI passkey from HostedPCI
cmdterminatesession
selectedPcsId7 digit session-id that was received when IVR session was created

If the call is successful the following return parameters will be provided in a URL encoded result set:

status=success&sessionId=125040&sessionType=ccmap&sessionStatus=terminate&sessionKey=2034025040&
sessionTaskCount=1&sessionTask[1].type=sessionsetup&sessionTask[1].status=created&
sessionTask[1].promptCode=created_entersession&sessionTask[1].completionCode=waiting&
sessionTask[1].completionCode=waiting&sessionTask[1].exceptionMsg=&sessionTask[1].comment=&
sessionTask[1].paramName=&sessionTask[1].paramValue=&sessionTask[1].createTS=
Parameter NameParameter value
Status[success|error]
Sessionid[7 digit session id that is used to identify the IVR session]
sessionType[Ccmap]
sessionStatus[terminate]
sessionKey[Session key to be entered by the telephone operator over the phone call]
sessionTaskCount[Task count list for the session]
sessionTask.type [sessionsetup| ccmapsetup | cccvvsetup]
sessionTask.status[Created | success | failed]
sessionTask.promptCode[Created_session | created_enterccnum | created_entercccvv]
sessionTask.completionCode[waiting | success | error]
sessionTask.exceptionMsg[Message for the exception]
sessionTask.comment[Comments]
sessionTask.createTS[Create time for the session]

Phone API Error Codes

The following status or error codes may be returned by HPCI Phone API calls. Errors will be returned in the sessionTask.exceptionMsg field.

Status Codes / Messages

  • MCMP_ACT_1 – Session created
  • MCMP_ACT_3 – Session cleared, CVV removed from cache on request

Errors Codes / Messages

  • MCMP_ACT_2 – Packet replay error
  • MCMP_ACT_4 – Phone session not found
  • MCMP_ACT_5 – Unknown command

Creating an API Passkey Through the HPCI Portal

To create an individual user passkey, login to the production HPCI portal for the user name in question (the phone agent) and navigate to account  Update Passkey

HPCI Phone_Sess create_passkey

Enter the password of the agent again and click “Generate key”. You will get a success message.

To view the passkey, enter the agent password again and click on “View key”. The key can be stored and used in the application used to generate call sessions through the API for the HostedPCI IVR solution.

Dispatch Web Services API Guide

  • The HostedPCI Dispatch Web Services API can be accessed by any eCommerce system that needs to submit credit card transactions to a 3rd party web service with the use of the HPCI credit card tokens.
  • Tokens can be obtained through the implementation of the HPCI Express iFrame solution or the mobile page proxy solution.
  • This document assumes that HPCI tokens have been generated and available for use with the HPCI Dispatch Web Service API.
  • API Transaction services included in this document: DISPATCH

Implementation Platforms



HPCI Dispatch Web Service API can be used in any programming language that supports HTTPS calls. Examples include Java, PHP, and C #.Net.

Setting up API Calls

All API calls to HostedPCI are made over HTTPS to an HPCI hostname that will be provided to you during the account setup. Parameters are passed to HCPI through standard the HTTPS POST method. Name-Value pairs are separated by & characters and are URL Encoded.

Required Parameters for All API Calls

  • apiVersion, value “1.0.1”
  • apiType, value “pxyhpci”
  • userName, value [API UserId]
  • userPassKey, value [API Passkey]

Specifying the Dispatch Profile Name

Multiple dispatch endpoints can be set up with HPCI and specified per API call. Dispatch profile names can be specified with the parameter below. This parameter is required. Dispatch profile names must be pre-arranged with the HPCI team.

  • dispatchRequest.profileName, value [Name of Dispatch Profile to use]

Reading Results from API Calls

Once an HTTPS call is made to an HPCI Web Service API, results will be returned in standard Name-Value pair format with URL Encoded values.

Credit Card Dispatch Transaction (DISPATCH)

API Endpoint: http://HPCI_API_HOSTNAME/iSynSApp/paymentMsgDispatch.action

Additional Required Parameters:

Dispatch Content Related Parameters

  • dispatchRequest.contentType, value [Content type for the dispatch request to destination e.g: urlencode / xml / html / plain / json ]
  • dispatchRequest.request, value [Fully prepared message for delivery to destination with place holders for Credit Card and CVV tokens]
  • dispatchRequest.prefixRequest, value [Any prefix that needs to be prefixed to the request data e.g: Softvoyage needs xml as the prefix]

Credit Card Token Related Parameters

Token details are passed as parameters in an array, notated by [ ] array syntax. Repeat the following parameters for each token that is being processed.

Where [x] starts at 0 and increases with each item added.

  • ccParamList[x].ccMsgToken, value  [Name of the place holder token for credit card number in the request message, e.g: %%CC1%%]
  • ccParamList[x].ccToken, value  [Tokenized CC value for the place holder value, this value is retrieved from the iframe]
  • ccParamList[x].cvvMsgToken, value [Name of the place holder token for CVV in the request message, e.g: %%CVV1%%]
  • ccParamList[x].cvvToken, value  [Tokenized CVV value for the place holder CVV]

Header Related Parameters (Optional)

HTTP Header values may also be sent to the destination along with the message payload. Details are passed as parameters in an array, notated by [ ] array syntax. Repeat the following parameters for each token that is being processed.

Where [x] starts at 0 and increases with each item added.

  • headerList[x].strValue1, value  [Name of the header for destination]
  • headerList[x].strValue2, value  [Value of the header for destination]

API Response Variables

This API call responds with the following name-value pairs.

  • status, value [success | error]

The Status response variable indicates if the API call is well-formed, with an appropriate result. It does not guarantee a successful credit card transaction with a complete authorization or capture if the status is returned as a success. Other parameters must be checked, see below

  • pxyResponse.responseStatus, value [approved I declined | error | review | dispatched]

The transaction response considered successful for pxyResponse.responseStatus is the approved or dispatched status. Any other response should be considered an error. In case of an error transaction, the error code may be obtained as per the following response variable:

  • pxyResponse.responseStatus.code, value [alphanumeric code representing response]
  • pxyResponse.responseStatus.description, value [long description and informational text of response]
  • pxyResponse.dispatchResp, value [Dispatch response]

The dispatch response variable contains the scrubbed response from the dispatch endpoint.

File Dispatch Web Services API Guide

The hostedPCI File Dispatch Web Services API can be accessed by any ecommerce or call centre system that need to submit files of credit card transactions to a 3rd party web service or processors with the use of the HPCI credit card token. Tokens can be obtained through the implementation of the HPCI Iframe solution or the HPCI IVR solution. This document assumes that HPCI tokens have been generated and available for use with the HPCI File Dispatch Web Service API.

Implementation Platforms

HPCI Dispatch Web Service API can be used in any programming language that supports HTTPS calls. Examples include Java, PHP, and C #.Net.

Setting up API Calls

All API calls to HostedPCI are made over HTTPS to an HPCI hostname that will be provided to you during account setup. Parameters are passed to HCPI through standard the HTTPS POST method. Name-Value pairs are separated by & characters and are URL Encoded.

File Dispatch API Action URL

“https://api-[venue name].c1.hostedpci.com/iSynSApp/paymentFileDispatch.action

apiVersionThis parameter is required for making API calls to HPCI, and should be set to the value “1.0.1”
apiTypeThis parameter is required for making API calls to HPCI, and this parameter should be set as “pxyhpci”
userNameThis information is provided by HPCI and is required in order to determine which vault is being used.
userPassKeyThis information is provided by HPCI and is required to confirm the vault that is being used.

Specifying the File Dispatch Profile Name

HostedPCI allows for multiple endpoints to be configured using our solution, and are specified using the profile name. The parameter listed below is required for all File Dispatch API calls made to HostedPCI.

dispatchRequest.profileNamehis parameter is required for making API calls regardless of the number of profiles, and the “profile name ” must be pre-arranged with the HostedPCI team.

Additional Required Parameters

When using the File Dispatch API it is important to ensure that all required parameters are being used, if a required parameter is missing the API action will result in an error.

File Dispatch Related Parameters

dispatchRequest.contentTypeThis parameter provides details about the content type for the File Dispatch the request to the destination. Example: urlencode / xml / html / plain / json
dispatchRequest.requestThis parameter is the fully prepared message for delivery to destination with place holders for Credit Card and CVV tokens

Preparing and Sending Files to HostedPCI

Sample File

The layout and contents of a file will be decided between the customer and the 3rd party processor. HostedPCI only cares about the token field for mapping. Below is a basic example of a possible file. The type of file being sent also does not matter to HostedPCI as long as we know where to grab the token and place the credit card.

Sample

Card Number, Expiry, Amount
4242000000104242, 05/16, 45.45
4111000000301111, 09/17, 65.23
4444000000051111, 10/18, 56.79

Front End Processing

Once the file is prepared it must be uploaded to the companies server in order to be sent to HostedPCI.

jQuery("#filedispatchBtn").click(function(){
          
          var file = jQuery("#filedispatch_file").val();
          var blob = new Blob([file], { type: "text/plain"});
          
          var formData = new FormData();
          formData.append("tokenFile", blob, "data.csv");
          formData.append("dispatchRequest.destFileName", "data.csv");
          formData.append("dispatchRequest.profileName" , jQuery("#paymentProfile_filedispatch").val());
          
          jQuery.ajax({
          url: "FileDispatchServlet",
          type: "POST",
          data: formData,
          processData: false,  // tell jQuery not to process the data
          contentType: false   // tell jQuery not to set contentType
        }).done(function(data) {
          //Process the ajax call result..
        });  
  });

Server to Server Call

private static final String PXY_MSGDISPATCH = "/iSynSApp/paymentFileDispatch.action";
private static final String PXYPARAM_APIVERSION = "apiVersion";
private static final String PXYPARAM_APIVERSION_NUM = "1.0.1”;
private static final String PXYPARAM_APITYPE = "apiType";
private static final String PXYPARAM_APITYPE_PXYHPCI = "pxyhpci";
private static final String PXYPARAM_DISPATCHREQUEST_PROFILENAME = "dispatchRequest.profileName";
private static final String PXYPARAM_DISPATCHREQUEST_DESTFILENAME = "dispatchRequest.destFileName";
private static final String PXYPARAM_USERNAME = "userName";
private static final String PXYPARAM_USERPASSKEY = "userPassKey";
public static String callUrl(String urlString, Map paramMap, String fileName,
      File dispatchFile) {
    
    String urlReturnValue = "";
    String charset = "UTF-8";
    
    String boundary = Long.toHexString(System.currentTimeMillis()); // Just generate some unique random value.
    String CRLF = "\r\n"; // Line separator required by multipart/form-data.
    try {
      URLConnection connection = new URL(urlString).openConnection();
      connection.setDoOutput(true);
      connection.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + boundary);
      PrintWriter writer = null;
      try {
          OutputStream output = connection.getOutputStream();
          writer = new PrintWriter(new OutputStreamWriter(output, charset), true);
  
          // Send normal param.
          for (Entry paramEntry : paramMap.entrySet()) {
  
            writer.append("--" + boundary).append(CRLF);
            writer.append("Content-Disposition: form-data; name=\"" + paramEntry.getKey() + "\"").append(CRLF);
            writer.append("Content-Type: text/plain; charset=" + charset).append(CRLF);
            writer.append(CRLF);
            writer.append(paramEntry.getValue()).append(CRLF).flush();
          }
  
          // Send text file.
          writer.append("--" + boundary).append(CRLF);
          writer.append("Content-Disposition: form-data; name=\"tokenFile\"; filename=\"" + fileName +"\"").append(CRLF);
          writer.append("Content-Type: text/plain; charset=" + charset).append(CRLF);
          writer.append(CRLF).flush();
          BufferedReader reader = null;
          try {
              reader = new BufferedReader(new InputStreamReader(new FileInputStream(dispatchFile), charset));
              for (String line; (line = reader.readLine()) != null;) {
                  writer.append(line).append(CRLF);
              }
          } finally {
              if (reader != null) try { reader.close(); } catch (IOException logOrIgnore) {}
          }
          // End of multipart/form-data.
          writer.append("--" + boundary + "--").append(CRLF);
          writer.flush();
          
          // Get the response
          BufferedReader rd = new BufferedReader(new InputStreamReader(connection.getInputStream()));
          String line;
          while ((line = rd.readLine()) != null) {
            urlReturnValue = urlReturnValue + line;
          }
          rd.close();
      } finally {
          if (writer != null) writer.close();
      }    
    
    } catch (Exception e) {
      e.printStackTrace();
      urlReturnValue = "";
    }  
    return urlReturnValue;
  }
  
  private String dispatchOnly(String serviceUrl, String userName, String userPassKey, String fileName,
      String destFileName, File dispatchFile) {
    // make the remote call
    String callUrl = serviceUrl + PXY_MSGDISPATCH;
    
      // prepare the api call
    Map paramMap = new HashMap();
    paramMap.put(PXYPARAM_APIVERSION, PXYPARAM_APIVERSION_NUM);
    paramMap.put(PXYPARAM_APITYPE, PXYPARAM_APITYPE_PXYHPCI);
    paramMap.put(PXYPARAM_USERNAME, userName);
    paramMap.put(PXYPARAM_USERPASSKEY, userPassKey);
    paramMap.put(PXYPARAM_DISPATCHREQUEST_PROFILENAME, "DISPATCHEXAVAULT");
    if(destFileName != null && !destFileName.isEmpty())
      paramMap.put(PXYPARAM_DISPATCHREQUEST_DESTFILENAME, destFileName);
      
      logMessage("========================================================");
    logMessage("Make the call: " + callUrl);
    logMessage("Call payload: " + paramMap);
    String callResult = callUrl(callUrl, paramMap, fileName, dispatchFile);
    logMessage("Call result:" + callResult);
    
    // parse the url encoded key value pairs
    Map resultMap = DemoUtil.parseQueryString(callResult);
    
    // get the network call status
    String callStatus = resultMap.get(PXYRESP_CALL_STATUS);
    
    if (callStatus != null && callStatus.equals(PXYRESP_CALL_STATUS_SUCCESS)){ 
      logMessage("Successful transaction");
      authId = resultMap.get(PXYRESP_AUTH_ID);
      logMessage("Auth Ref Id:" + authId);
    }
    else {
      logMessage("Unsuccessful transaction");
      String statusCode = resultMap.get(PXYRESP_RESPSTATUS_CODE);
      String statusName = resultMap.get(PXYRESP_RESPSTATUS_NAME);
      String statusDesc = resultMap.get(PXYRESP_RESPSTATUS_DESCRIPTION);
      logMessage("Auth Status Code:" + statusCode);
      logMessage("Auth Status Name:" + statusName);
      logMessage("Auth Status Desc:" + statusDesc);
    }
    return callResult;
  }

API Response Variables

This API call responds with the following name-value pairs. The response being provided back is only of the upload success or failure there will be no status of the credit card processing.

statusThe Status response variable indicates if the API call is well formed, with an appropriate result. It does not guarantee a successful credit card transaction with a complete authorization or capture if the status is returned as success. Other parameters must be checked, see below. The value will either be success or failure.
pxyResponse.responseStatusThe transaction response considered successful for pxyResponse.responseStatus is the approved or dispatched status. Any other response should be considered an error. In case of an error transaction, the error code may be obtained as per the following response variables below. The possible values are either approved, declined, error, review and dispatched.
authIdis an enteral number provided by HostedPCI for your records only.
pxyResponse.processorTypeThis parameter provides you with the type of response being provided, the value will always be fileDispatchResponse
pxyResponse.fileRowCountThis parameter provides you with an update on how many columns have been provided within the file. This will indicated how many tokens were provided to HostedPCI.
pxyResponse.responseStatus.codeThis parameter provides you with an alphanumeric code that can assist with understanding the response being provided back as well as debugging.
pxyResponse.responseStatus.descriptionThis parameter will provide a brief description of the response being provided, which can assist with any errors that may occur.
pxyResponse.dispatchRespThe dispatch response variable contains the scrubbed response from the dispatch endpoint, the value will be dispatch response.

Gateway Parameter Guide

Acapture services were integrated by HostedPCI in 2017, we support the following credit card processing features by Acapture.

URL: https://www.acapture.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
User ID
Password
Entity ID

Adyen services were integrated by HostedPCI since 2015, we support the following credit card processing features provided by Adyen.

URL: https://www.adyen.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
wsUser
wsPassword
Merchant ID

AdyenRest services were integrated by HostedPCI since 2019, we support the following credit card processing features provided by AdyenRest.

URL: https://www.adyen.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username
Password

Authorize.net services were integrated by HostedPCI since 2010, we support the following credit card processing features by Authorize.Net.

URL: https://www.authorize.net/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
3D Secure – Pass-through
Authentication and security credentials
Login ID
Transaction Key

Bambora services were integrated by HostedPCI since 2013, we support the following credit card processing features provided by Bambora.

URL: https://www.bambora.com/en/ca/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Credentials on File
Authentication and security credentials
User ID
Password
Merchant ID

Braintree services were integrated by HostedPCI in 2016, we support the following credit card processing features by Braintree.

URL: https://www.braintreepayments.com/en-ca

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Credentials on File
3D Secure – pass-through
Authentication and security credentials
Merchant ID
Public Key
Private Key

CardConnect services were integrated by HostedPCI in 2015, we support the following credit card processing features by CardConnect.

URL: https://cardconnect.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Username
Password
Merchant ID
Terminal ID
URL Prefix

CenPOS services were integrated by HostedPCI since 2014, we support the following credit card processing features by CenPOS.

URL: https://www.cenpos.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
MerchandID
UserID
Password

Charge Logic services were integrated by HostedPCI since 2017, we support the following credit card processing features provided by Charge Logic.

URL: https://www.chargelogic.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
StoreNo
APIKey
ApplicationNo
ApplicationVersion

Chase Payment Batch services  were integrated by HostedPCI since 2016, we support the following credit card processing features provided by Chase Payment Batch.

URL:  https://www.chase.ca/en

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
SFTP Username
SFTP Password
PGP Private Key
PGP Private Key Pass Phrase

Chase Paymentech services were integrated by HostedPCI since 2011, we support the following credit card processing features by Chase Paymentech.

URL: https://en.chasepaymentech.ca/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Credentials on File
3D Secure – pass-through
Authentication and security credentials
Merchant ID
Bin
Terminal ID
Supported Parameters pxyOrder.shippingReference (Shipping Reference)

In order for Payments to be delivered to Chase clients have to whitelist our Submitter ID on your merchant account.

Submitter ID: 980491

CyberSource services were integrated by HostedPCI since 2009, we support the following credit card processing features by CyberSource.

URL: https://www.cybersource.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Merchant ID
Transaction Key

CyberSource Account Updater was integrated by HostedPCI in 2017, we support the following credit card processing features.

URL: https://www.cybersource.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username
Password
PGP Private Key
PGP Private Key Password
Merchant ID
P12 Certificate name
SSL Key
Store Name

DataCash services were integrated by HostedPCI in 2016, we support the following credit card processing features by DataCash.

URL: http://www.mastercard.com/gateway/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Client ID
Password

Divitia Global services  were integrated by HostedPCI since 2015, we support the following credit card processing features provided by Divitia Global.

URL: https://www.divitia.com.au/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
VID
Password
Track ID

Dlocal services  were integrated by HostedPCI since 2018, we support the following credit card processing features provided by Dlocal.

URL: https://dlocal.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Merchant xLogin
Merchant xTransKey
Secret Key
Notification_url
Supported ParameterspxyCustomerInfo.officialDocNumber   (Tax IDs for Brazil and Mexico)

pxyTransaction.merchantProductName  (Product name that will appear on statement )

pxyOrder.description    (Description of charge )

Ebiz Charge services were integrated by HostedPCI since 2020, we support the following credit card processing features provided by EbizCharge.

URL: www.ebizcharge.com

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
UserID
Password
Security ID

Eigen services were integrated by HostedPCI since 2013, we support the following credit card processing features by Eigen.

URL: https://www.eigenpayments.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Terminal ID
Hash Password

Elavon services were integrated by HostedPCI in 2016, we support the following credit card processing features by Elavon.

URL: https://www.elavon.com/index.html

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Ach Submit
Authentication and security credentials
Merchant ID
User ID
PIN

Elavon services were integrated by HostedPCI in 2016, we support the following credit card processing features by Elavon.

URL: https://www.elavon.com/index.html

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Merchant ID

First Data Global Gateway services were integrated by HostedPCI, we support the following credit card processing features by First Data Global Gateway.

URL: https://www.firstdata.com/en_ca/home.html

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Gateway ID
Gateways Password

First Data Payeezy services were integrated by HostedPCI in 2016, we support the following credit card processing features.

URL: https://www.firstdata.com/en_us/all-features/payeezy.html

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Credentials on File
Authentication and security credentials
API Key
API Secret
Merchant Token

First Data Virtual Terminal (previouisly knows as Linkpoint) services were integrated by HostedPCI since 2012, we support the following credit card processing features by First Data Virtual Terminal.

URL: https://www.firstdata.com/en_ca/home.html

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
P.12 certificate

Global Collect services were originally integrated by HostedPCI in 2013, However we have recently updated our API integration.

URL: http://www.globalcollect.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
API Key ID
Secret API Key
Merchant ID
Supported ParameterspxyCustomerInfo.birthDate   (Customer’s Birth Date)

pxyCustomerInfo.billingLocation.title    (Billing Title)

pxyCustomerInfo.shippingLocation.title   (Shipping Title)

Global Collect services were originally integrated by HostedPCI in 2013, However we have recently updated our API integration.

URL: http://www.globalcollect.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
API Key ID
Secret API Key
Merchant ID

Global Payment services were integrated by HostedPCI since 2019, we support the following credit card processing features provided by Global Payment.

URL: https://www.afex.com/canada/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Merchant ID
Shared Secret
Refund Password (Not enabled by default)

Helcim services were integrated by HostedPCI since 2014, we support the following credit card processing features provided by Helcim.

URL: https://www.helcim.com/ca/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Merchant ID
Token

iATS Payments services were integrated by HostedPCI since 2013, we support the following credit card processing features provided by iATS.

URL: http://home.iatspayments.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
User ID
Password

Ingenico services were integrated by HostedPCI since 2012, we support the following credit card processing features provided by Ingenico Payment Services.

URL: https://www.ingenico.com

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
User ID
Password
PSP ID

iPay services were integrated by HostedPCI since 2011, we support the following credit card processing features provided by iPay.

URL: http://www.planetpayment.com/ipay-gateway/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username
Password
Terminal ID

Klik & Pay services were integrated by HostedPCI in 2017, we support the following credit card processing features.

URL: http://klikandpay.com/en/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Account ID
Private Key

Moneris services were integrated by HostedPCI since 2012, we support the following credit card processing features by Moneris.

URL: https://www.moneris.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Credentials on File
Authentication and security credentials
Store ID
API token

Mundipagg services were integrated by HostedPCI in 2015, we support the following credit card processing features by Mundipagg.

URL: https://www.mundipagg.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Merchant Key
Supported Parameters
pxyCustomerInfo.gender    (Customer’s Gender)

pxyCustomerInfo.officialDocNumber    (Official Document Number)

pxyOrder.itemId    (Order Item ID)

pxyOrder.unitCostInCents, pxyOrder.totalCostInCents    (Unit Price in Cents, Total Cost in Cents)

NetBilling services were integrated by HostedPCI since 2015, we support the following credit card processing features provided by NetBillings.

URL: https://www.netbilling.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Account ID
Affiliate ID
Site ID

Network Merchants (NMI) services were integrated by HostedPCI since 2012, we support the following credit card processing features by Network Merchants.

URL: https://www.nmi.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Username
Password

NPC Skipjack services were integrated by HostedPCI since 2014, we support the following credit card processing features provided by NPC Skipjack.

URL: http://www.skipjack.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Serial Number
Developer Serial Number

Optimal Payments services were integrated by HostedPCI since 2013, we support the following credit card processing features provided by Optimal Payments.

URL: https://www.paysafe.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Store ID
Store Password
Merchant Account Number

Paya Connect services were integrated by HostedPCI since 2020, we support the following credit card processing features provided by Paya Connect

URL: https://paya.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
UserID
User API key
Developer ID

Pay Trace services were integrated by HostedPCI since 2020, we support the following credit card processing features provided by Pay Trace.

URL: https://paytrace.net/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Username
Password

PayFlow Pro services were integrated by HostedPCI since 2009, we support the following credit card processing features by PayFlow Pro.

URL: https://www.paypal.com/ca/home

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
PayPal username
PayPal password
Vender name
Partner name

Paypal Website Payment Pro was integrated by HostedPCI since 2013, we support the following credit card processing features provided by Website Payment Pro.

URL: https://www.paypal.com/ca/home

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
API username
API password
Signature

PayU services were integrated by HostedPCI since 2016, we support the following credit card processing features provided by PayU.

URL: https://corporate.payu.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit

Authentication and security credentials
API Login
API Key
Merchant ID
Account ID
Supported ParameterspxyTransaction.txnFingerPrintData    (Device Session ID)

pxyTransaction.txnInstallmentCount    (The number of installments)

pxyCustomerInfo.sessionId    (Transaction Cookie)

Prism Pay services were integrated by HostedPCI since 2011, we support the following credit card processing features by Prism Pay.

URL: http://www.prismpay.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Account ID
Merchant PIN
Sub Account ID

ProPay services were integrated by HostedPCI since 2015, we support the following credit card processing features by ProPay.

URL: https://www.propay.com/Canada/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Account Number
Certification String

PSI Gate services were integrated by HostedPCI since 2011, we support the following credit card processing features by PSI Gate.

URL: https://www.psigate.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Credentials on File
Authentication and security credentials
Store ID
Passphrase
Custom Merchant Ref.

Rakuten services were integrated by HostedPCI since 2019, we support the following credit card processing features provided by Rakuten.

URL: https://www.gmo-pg.com/en/service/mulpay/rakuten/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
wp_id
wp_password
Service ID
Service access Key

Redecard services were integrated by HostedPCI since 2015, we support the following credit card processing features provided by Redecard.

URL: https://www.userede.com.br/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Filiacao

Redecard services were integrated by HostedPCI since 2015, we support the following credit card processing features provided by Redecard.

URL: https://www.userede.com.br/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username
Password

Redsys services were integrated by HostedPCI since 2015, we support the following credit card processing features provided by Redsys.

URl: http://www.redsys.es/en/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username
PasswordS
Terminal

SafeCharge services were integrated by HostedPCI since 2018, we support the following credit card processing features provided by SafeCharge.

URL: https://www.safecharge.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
3D Secure – pass-through
Authentication and security credentials
Merchant ID
Merchant Key
Supported Parameters
pxyTransaction.merchantPhoneNum    (Display phone number on the clients statement)

pxyCustomerInfo.browserUserAgentHeader    (The customers browsers header)

Sage Payment services were integrated by HostedPCI since 2017, we support the following credit card processing features by Sage Payments.

URL: http://www.sage.com/ca/sage-payment-solutions

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
3D Secure – full
Authentication and security credentials
Merchant ID
Merchant Key

Stripe services were integrated by HostedPCI since 2013, we support the following credit card processing features by Stripe.

URL: https://stripe.com/ca

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
3D Secure – full
Authentication and security credentials
Secret Key

StarCard services were integrated by HostedPCI since 2019, we support the following credit card processing features by Stripe.

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username/Facility Number

TransFirst services were integrated by HostedPCI since 2014, we support the following credit card processing features by TransFirst.

URL: http://www.tsys.com/solutions/products-services/merchant/products/payment-gateway/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
TransFirst Express RegKey
Express Gateway ID
Merchant Account ID

TrustCommerce services were integrated by HostedPCI since 2019, we support the following credit card processing features provided by TrustCommerce.

URL: https://www.trustcommerce.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Customer ID
Password

USAePay services were integrated by HostedPCI since 2017, we support the following credit card processing features by USAePay.

URL: https://usaepay.info/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization
Authentication and security credentials
Source Key
Pin

Vantiv services were integrated by HostedPCI since 2017, we support the following credit card processing features by Vantiv.

URL: https://www.vantiv.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization

Authentication and security credentials
Account ID
Account Token
Accepter ID
Terminal ID
Application ID

Vantiv Litle services were integrated by HostedPCI since 2017, we support the following credit card processing features by Vantiv Litle.

URL:  https://www.vantiv.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Gateway Tokenization

Authentication and security credentials
Username
Password
Merchant ID
Supported ParameterspxyTransaction.txnExtraParam1     (Additional parameter)

pxyTransaction.processorRefId    (Required for refunds and voids only)

pxyThreeDSecAuth.paRes    (Used for making 3DS checks)

pxyThreeDSecAuth.authTxnId    (Required for using 3DS)

pxyCustomerInfo.profileGatewayId    (Gateway ID)

Vantiv Raft services have integrated by HostedPCI, we support the following credit card processing features by Vantiv Raft.

URL:  docs.apis.worldpay.com

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Username
Merchant ID

VitalPay were integrated by HostedPCI, we support the following credit card processing features provided by VitalPay..

URL: https://vitalpay.us/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit

Authentication and security credentials
Username
Password

VariPay were integrated by HostedPCI since 2020, we support the following credit card processing features provided by VariPay.

URL: https://varipay.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit

Authentication and security credentials
Username
Password
MerchantID

Wire Cardservices were integrated by HostedPCI since 2014, we support the following credit card processing features provided by WireCard.

URL: https://www.wirecard.com/

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
3D Secure – pass-through
Authentication and security credentials
Username
Password
Merchant Account ID

SecureNet services were integrated by HostedPCI since 2011, we support the following credit card processing features by SecureNet.

URL: http://www.worldpay.com/us

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
Authentication and security credentials
Secure ID
Secure Key
Supported ParameterspxyOrder.invoiceNumber    (Invoice Number)

World Pay services were integrated by HostedPCI since 2012, we support the following credit card processing features by World Pay.

URL: http://www.worldpay.com/us

Implemented Features
Auth
Sale (Auth + Capture)
Capture
Void
Credit
3D secure – full
Authentication and security credentials
Username
Password
Supported ParameterspxyCustomerInfo.sessionId    (World Pay Session ID)

Common error codes

Error CodeDescription
PPA_ACT_1User not logged-in, please check the user name and passkey are valid
PPA_ACT_2Invalid version, please use the correct version
PPA_ACT_3Too many mapping failures, contact HPCI admin
PPA_ACT_4SSL Required for the request, please https to submit the request
PPA_ACT_5Credit card mapping failure, please make sure only mapped credit card numbers are used for the request
PPA_ACT_6Payment gateway not configured for the currency, please contact HPCI to setup the correct gateway details
PPA_ACT_7Credit card operation failed, please check the gateway specific return codes
PPA_ACT_8Invalid amount, please check the amount sent
PPA_ACT_9Dependent credit card operation not found, please provide the correct reference number for the dependent transaction
PPA_ACT_10Unknown error, please contact HPCI
PPA_ACT_11Invalid operation, please verify the request
PPA_ACT_12Required parameter missing, please make sure missing parameter is provided
PPA_ACT_13CVV mapping failed, please verify the request
PPA_ACT_14Invalid expiry, please verify credit card expiry
PPA_ACT_15Credit card payment failed
PPA_ACT_16Used a duplicate transaction for the same reference number
PPA_ACT_17Credit card payment declined
PPA_ACT_18CC Token expired
PGT_SER_1Unknown provider.
PGT_SER_2Could not auth.
PGT_SER_3Could not void
PGT_SER_4Could not find
PGT_SER_5Processing transaction
PGT_SER_6Not implemented
PGT_SER_7Capture not found.
PGT_SER_8Points system not enabled
PGT_SER_9Gateway parameter is missing. Please review the additional response fields for more details.
PGT_SER_10Parameter not supported
PGT_SER_11Result empty
PGT_SER_12Could not initialize
PGT_SER_13Invalid amount
PGT_SER_14Unknown Auth transaction
PGT_SER_15Unknown Sale transaction
PGT_SER_16Unknown Void transaction
PGT_SER_17Unknown Capture transaction
PGT_SER_18Unknown Credit transaction
PGT_SER_19Could not complete credit
PGT_SER_20Call timeout
PGT_SER_21Unknown lookup exception
PGT_SER_22Preprocessor filter transaction rejected. Custom rule invoked.
PGT_SER_23Could not tokenize
PGT_SER_24Could not capture
PGT_SER_25Processing mode not supported
MCC_1iFRAME error, Credit card not valid
MCC_2IFRAME error, CVV not valid
AMC_ACT_2This error is a packet replay error. This happens when a user has attempted to resubmit a form multiple times, it is usually through the use of back button.
URU_3This error means that the socked timeout, this can occur because there is a temporary issue with the payment gateway.