API Specification

Streamline your integration process with our recommended method.
Begin with our sample project for a guided approach to your integration.

Recommended Resource: Dive into Our Integration Code Sample

Explore our recommended code sample designed to streamline your integration process. This sample project provides a fully functional payment integration and offers a guided approach to integrating with our payment gateway. We suggest beginning your development journey with this sample, tailored for practical implementation and efficiency.

The Hosted Page (HPP) Integration Method


The Hosted Payment Page (HPP) is an integration method where the entry of sensitive data is handled by the Payment Gateway so the merchant’s servers are not exposed to this data. This is advisable to reduce the PCI scope of the integrated solution.

The Hosted Payment Pages can be styled. For details on styling the Hosted Payment Pages, see the section Pay Pages.

Cardholders are redirected to the page hosted securely on our servers. Once the customer clicks the ‘submit’ button on the page, all data is collected, processed and the Payment Gateway sends the processing result back to the Merchant's site, also redirecting the Account Holder to the Merchant's result page, in a transparent way.

The following APIs are available for this integration method:

The Direct/HTTPS POST (XML) Integration Method


The XML integration method can be used for custom integrations or highly customized browser-based software applications. This method offers full access to all of our products and features. Customers using only the XML method to process or collect credit card data must maintain their own security and are subject to a more rigorous PCI security assessment.

The XML integration method can also be used to supplement the Hosted Payment Page (HPP) method depending on the feature set being utilized by the developer.

The following APIs are available for this integration method:

Additional Integration Information


This section includes response code and messages, how to use the custom fields, how to calculate the hash parameters of requests and responses, information on Fraud services and a glossery of terms used in this documentation.

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International