Skip to content

Full API References

We offer several RESTful APIs: A server API which is used by the merchants in a server-to-server setup and a client API which is used by clients like desktops, laptops, mobile phones and other internet connected devices. For both APIs we offer a detailed API reference that lists all the functionalities and how to use them.


Commerce HPP API

Start accepting online payments in just a few minutes with HPP. It's quick and easy to integrate, accepts online payments from all major methods and credit cards, and is customizable to your brand.

description Full HPP API Reference launch

explore Swagger HPP API Specification launch

Commerce Public API

The Public API enables mobile phones, browsers, and apps to access the hosted data such as detailed information about the available payment methods, services metadata, and public keys used for encrypting sensitive data. These calls require a Public Key that the merchant can create using the Private API.

description Full Public API Reference launch

explore Swagger Public API Specification launch

Commerce Private API

The Private API enables merchants to access functionality such as payments, initiating hosted payments, creating profiles, and much more. All these calls require the caller to have a secret API key that merchants can look up in their Commerce Account.

description Full Private API Reference launch

explore Swagger Private API Specification launch

Commerce Callbacks

Callbacks notify you about events that occur with regards to the payments that you process via Commerce, like the state on payments or payouts changes changes. This allows you to be easily aware of things that happen, even after the consumer is no longer on your site.

description Commerce Callbacks Guide


Core API

The Core API allows you to programmatically manage your account. It does everything the Dashboard UI does, but adds some capabilities that may come in handy depending on your business needs.

Consider, for instance, a business model in which you provide a service that allows other merchants to accept payments (like in a marketplace). Using the Core API you can create a Commerce accounts on behalf of each merchant, under the umbrella of your main account.

description Full Core API Reference launch

explore Swagger Core API Specification launch


When an event occurs, we send you a webhook notification to tell you what's happened so you can take action and keep your business running smoothly.

Webhooks provide a definitive confirmation of a status update and are used for a variety of purposes, such as fulfilling orders, sending automated status updates to customers, or even integrating with third-party application services.



Cardgate API

The Cardgate API is Full card details API integration lets you accept payments on your website and mobile application, if you support PCI compliance at Level 1 or 2. It allows you to collect raw card data from your shoppers and pass this data in payment requests to the Cardgate API.

When you want to reduce your PCI compliance requirements, we recommend that you integrate with our Client-Side Encryption library instead.


Cardgate HPP API

Using Cardgate HPP for card payments you can process transactions using, our easy to use hosted responsive payment pages. Your consumers will be able to complete the payment process using Cardgate HPP that is hosted by us. Using these pages to capture card details and process card transactions will greatly reduce not only your integration efforts, but it will also reduce your 'PCI exposure' to the lowest level (SAQ-A).



Codes are everywhere in the world of payments. But what do they all mean? If you struggle to tell your HTTP status codes from your ISO 4217s, we've got your back. uses its own developed standard for classification and identification of FinTech industry entities named directory includes data like:

  • Currencies: National, Digital, Virtual, Cryptocurrencies, etc.
  • Payment Service Providers (PSP): Distributors, Aggregators, Collectors, Acquirers, etc.
  • Payment & Payout Methods: E-wallets, Bank Cards, Prepaid Cards, SSK, Alternative Methods, etc.
  • Payment & Payout Services.
  • Digital Exchangers: Online, Offline, Stock, etc.
  • Banks and Branches.
  • Vendors: Organizations and companies.

It also includes Country codes, Merchant category codes (MCC) and much other useful stuff.

All objects have own Unique Identification Code that used for unification all payment data from disparate sources.

Feel free to explore and contribute at paycoreio/openfintech

Postman Collections

While being able to build requests using a GUI is nice, Postman really starts to shine when you use collections. Postman Collections are simply a collection of pre-built requests that can be organized into folders, and they can be easily exported and shared with others.

Learn more →


Can't find what you're looking for? Contact our support team for help.