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.

Hosted Payment Page (Checkout)¶

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

Full Checkout Guide

Full Checkout API Reference

Swagger Checkout API Specification

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.

Full Public API Reference

Swagger Public API Specification

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.

Full Private API Reference

Swagger Private API Specification

Callbacks¶

Callbacks notify you about events that occur with regards to the payments that you process via Payelata.com 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.

Commerce Callbacks Guide

Codes¶

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.

Payelata.com uses its own developed standard for classification and identification of FinTech industry entities named OpenFinTech.io.

OpenFinTech.io directory includes data like:

• Currencies: National, Digital, Virtual, Cryptocurrencies, etc.
• Payment & Payout Methods: E-wallets, Bank Cards, Prepaid Cards, SSK, Alternative Methods, etc.
• Payment & Payout Services.

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 OpenFinTech.io

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 →