Clickatell API Docs

Elevate your business interactions in chat with Clickatell's powerful APIs.

Channels

  • WhatsApp & SMS (One API): Communicate with customers via multiple messaging channels (WhatsApp and SMS) using a single integration.

  • SMS only: Enable one- and two-way SMS communication with your customers.

Applications

  • Chat 2 Pay API: Send payment requests to customers and facilitate payments via chat for secure, contactless payment experiences.

  • Chat Flow External Link Handler API: Direct customers to an external web page from within a Chat Flow conversation and return with additional data.

Marketplace

Clickatell's Marketplace APIs for digital product distribution and payment acceptance:

  • Bank Interfaces API: A collection of APIs used between Clickatell and banks/funding sources when dealing with purchases.

  • Customer Account Validation API: Validate a customer's bill payment account number before submitting the bill payment purchase request to the vendor.

  • Financial Terms Lookup API: Display the correct fee and settlement amounts per the contractual agreement for the purchased SKU.

  • In-Flight Transaction Check API: Used before a purchase instruction to confirm that no similar transaction is in progress.

  • MNO Lookup API: Derive the specific mobile network operator (MNO) for the specified MSISDN.

  • Notifications API: Send notifications to buyers/recipients using different channels.

  • Product Lookup API: Confirm a product's configuration and attributes.

  • Reserve and Transact API: Initiate a purchase and fund reservation request to Clickatell.

  • Security Service API: Request authentication tokens for all other Clickatell API calls.

  • Token Lookup API: Lookup tokens/vouchers to present to the buyer/customer who purchased token-related products via Clickatell’s platform.

  • Transact API: Initiates a purchase request to Clickatell​.

  • Transact Result API: Initiates the delivery of the transaction result for a purchase made through Clickatell after Clickatell facilitated the dispensing of the product.

  • Transaction Lookup API: Used after a purchase to confirm the transaction status.

  • User Transaction Lookup API: Identify if a new transaction is similar to one of the user’s recent transactions.