Getting started

​
Why use this API?

The Transact API initiates a purchase request to Clickatell​. The full list of available products will be provided to you during the integration phase.

Note: This API should only be used if you want to reserve funds yourself prior to sending Clickatell the purchase request. If you require Clickatell to do the fund reservations, use the Reserve and Transact API instead.

Important:

The Transact Result API needs to be implemented with this API. The Transact Result Request will be called to inform the client of the purchase result. ​

Participating parties

• Buyer 
• Clickatell
• Client
• Supplier
• Recipient

For definitions of each, see here.

Getting started with the Transact API

To interface with Clickatell, the below needs to be set up, configured and tested.

Step 1: Integrate with Security Service API

• Follow the instructions in the Security Service API quick-start guide to request a token with your client_secret and client_id
• Use the API_key and access_token in the following request (Step 2)

Step 2: Call Financial Terms Lookup API 

• Follow the instructions in the Financial Terms Lookup API quick-start guide
• Add the API_key and access_token to the request header
• Use the client_id supplied during integration

Step 3: Call Transact API (this API)

• Add the API_key and access_token to the request header
• Use the client_id supplied during integration

Step 4: Implement Transact Result API

• Follow the instructions in the Transact Result API quick-start guide

Notes

The following API calls are not discussed in this document as they form part of the respective API’s documentation as indicated below:

• Security Service API quick-start guide
  • token Request
  • token Response
• Financial Terms Lookup API quick-start guide
  • financial terms lookup Request
  • financial terms lookup Response
• Transact Result API quick-start guide
  • transactResult Request
  • transactResult Response

A high-level view of this interface is illustrated below:

For a list of all roles-players/stakeholders involved in the purchasing process, see here. 

Read more:

• Transact API references
• Transact Result API
• Financial Terms Lookup API
• Security Service API
• Overview
• Getting started