API Tutorials
WE'RE HIRING!HELP CENTERINTEGRATIONSSTATUS PAGESIGN UP

Prerequisites

Suggest Edits

👍

Check our Reference Materials with a handy Glossary for more details about a payment connector.

If you're not into Cleeng Merchant, this solution is for you.

The Cleeng Payment API has been built to integrate with all kinds of payment gateways using the designated connectors. This gives you the flexibility to use your desired payment gateway while leveraging Cleeng’s subscriber retention management solutions.

As a broadcaster, you need to prepare the following for the Cleeng Payment API to work:

  • Front-End Part
  • Prerequisites to be completed at the selected Payment Gateway
  • Prerequisites to be completed in Cleeng

Step 1: Front-End Part

You need to implement your front-end part on the website with the desired payment gateway.

Step 2: Prerequisites at the Selected Payment Gateway

When you have chosen a payment gateway you need to configure your account and integrate with them.

In general, this might include:

  • getting a test and a production account (this might involve providing the required documents, like company registration documents, as well as completing PCI compliance questionnaire, meeting website requirements, etc.)
  • signing a contract
  • configuring a production account, e.g.:
    -> setting up payment methods with correct configuration of countries and currencies (if applicable),
    -> adding information about bank account(s),
    -> configuring webhook notifications (if applicable); this should be done when a connector is in place.

📘

Note

For the actual configuration and integration steps, you should always check with the payment gateway that you have selected.

❗️

Important

PCI compliance must be assured.

Step 3: Prerequisites in Cleeng

You need the following to integrate with Cleeng:

3.1) Cleeng Broadcaster Account

You need to have a Cleeng Broadcaster account. To log in, you may go to this link. If you haven’t registered yet, you can sign up here.

3.2) Cleeng Sandbox Account

It is recommended that you have a Cleeng sandbox account. Your sandbox account will be useful to control and test your integration. (For more information on sandbox account you may visit Cleeng Sandbox).

3.3) API Keys

The Cleeng Payment API uses API keys to authenticate requests. You can view and manage your keys in the Cleeng Dashboard.

The API key should be set as “X-Publisher-Token” HTTP header in the request as in the following example:

curl -X POST \
  https://api.cleeng.com/3.1/payments
  -H 'X-Publisher-Token: a6xxki_mf493WSBjEs9D-UpN-0kyESWYPUQo9S6nEewTyuL7'

3.4) Payment Methods Settings

The Cleeng Payment API uses Payment Methods Settings that are a reference to payment method. These contain settings relating to how this payment method should behave in Cleeng. It holds information on how to display this payment method in the Cleeng Dashboard.

To set up Payment Methods in Cleeng, please contact the BSS Team.

Please provide your email address (if a different email address is used for sandbox and production environment - both email addresses should be provided).

You can have more than one payment method configured per connector/payment gateway. For example, a connector with multiple payment methods (e.g. card, Apple Pay, Google Pay) integrated should have separate settings per payment method so that you are able to distinguish which payment method has been used for a subscription.

3.5) An Offer

Create an offer so that you can make sure you are using the right pricing and conditions during payment requests.

You can set up offers in the Dashboard.

Up Next

Once the payment front-end components on the merchant website are ready, it's time to move on. The front-end part needs to communicate with the payment gateway in order to process payments.

Cleeng recommends building a connector - a separate server-side application that will receive requests from the front-end application and connect with the Payment Gateway API and with Cleeng Payment API to process the event.

The basic functionalities that the connector should be ready for:

Let's start building a connector. Be aware that the connector has to be hosted in your own environment.

For more information on connector, see Reference Materials.

Updated about 2 months ago