Getting started

Service overview

CentralPay provides a powerful payment processing API, enabling you to process multi-channel transactions at local and/or international levels.

The REST API gives you access to a complete set of features and services provided by CentralPay.

You can choose between several integration methods depending on the payment functionalities you want to access and the technical knowledge you have.
The most advanced integration method we offer is through our REST API that allows you to access advanced features and use your own payment forms.

Our system stores card data sent over the Internet through a secure connection and provides you with a token for each transaction. Our technology analyses fraudulent transactions and keeps a record of IPs, emails and cards with a potential fraud risk.

Accepting payments with CentralPay is easy and only requires a few simple steps. The steps are detailed in the tutorials. 

Integration using POP-IN FORM


Pop-in forms allow a fast and easy integration as all the hard work is handled by CentralPay.

> More information in the Pop-in Form tutorial

Integration using Custom Form

Using the custom form requires more technical skills but it allows you to have a full control over the look and feel of the payment form. Therefore, integrating the form seamlessly onto your website.

> More information in the Custom Form tutorial

How DOEs it work?


Single payment flow

Single payment flow
During the first payment, the CardTokenID is used to create a Transaction. Customer can be created so they can be 
used again to process any further payment.

NEXT transactions PAYMENT FLOW

For 1-click payments, the merchant only needs to send the CustomerID and transaction information to initiate the payment. 


Multiple payment process
The CustomerID + CustomerValidationValue (CVV) alows the merchant to process to fast and secure payments with one-click. 



How Can I test the service?

To try out the payment process, please contact

Test account

The test account allows you to test the API and its features. With the test account you access a sandbox, which is very similar to the production environment. The only difference is that the transactions are not processed.

Live account

Once you have tested the service and your account has been validated by your Account Manager, you can request the activation of your live account.
As soon as your live account is activated, you will receive an email with your credentials.


Before processing your first transactions:

  • Make test payments using a valid debit/credit card. Verify that the transactions are processed as expected. You can cancel or refund these transactions afterwards.
  • Check that your site(s) configuration settings have been setup correctly. Also, ensure that email notification settings have been configured.







When a transaction has been processed, the cardholder can receive a Payment Receipt to the email address provided in the parameter receiptEmail of the transaction request (see the Transaction HTTP Parameters section of this document).

Although this Payment Receipt has a predefined structure to show the payment information, you can configure several details from the Back-office.

See an example of a Payment Receipt email:


Details for each element marked with an arrow are described below:

  • 1. Email sender address.
  • 2. Email sender name.
  • 3. Company logo.
  • 4. Poinf os sale name.
  • 5. Footer text.
  • 6. Receipt language.

Point of Sale information

Elements marked with 1234 are configured in the Points of sales settings of your account. In the Back-office go to Dasboard > Point of sales > Settings.

Click in the edit icon:

Fill or edit the parameters marked with numbers, this will update the belonging fileds in the email template :

  • 1. Email sender address.
  • 2. Email sender name.
  • 3. Company logo.
  • 4. Poinf of sale name.

Receipt footer text

Go now to Configuration > Receipt email templates and click on the create button.
NB : you have to use a Merchant Admin profile to do it.

Now, in the Receipt email edition page you will have to enter the following settings:

  • A name for the new Receipt email template.
  • Select a Language for this template, .
  • Select a Point of Sale for this template.
  • Enter a Footer template.

The content of this footer text (field 5 of the Payment Receipt) will be displayed at the end of the email message


This template will be used only for the Point of sale selected. The Language will depend on the browserUserAgent, browserAcceptLanguage and enduserLanguage parameters sent in the transaction request.

You will find more details about how configure and send these parameters in the next section Receipt Language.

Receipt language

Send these parameters (not mandatory) if you want the cardholder to receive the Payment Received in the language configured by default in the user's browser:


Value description

string (2)

User language (browser default)
Required: NO
Validation: [a-z]{2} Alpha2 ISO 639-1 language code
Note: Payment Receipt language will be defined by 

string (255) -

List of languages installed in the browser
Required: NO
Validation: [a-z]{2}([-A-Z]{2})? Alpha2 ISO 639-1 language code and, optional, Alpha2 ISO 3166-2 country code (optional)
Examples: de, en-US, en-GB | fr, es-ES, it | es, en-GB, nl, ru

string (255)

Browser and operating system identifier
Required: NO
Validation: .{0,255}
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36