Cellulant

Cellulant Custom Checkout API

Host-to-host checkout flow for merchant-controlled UX.

GitHub OpenAPI

Operations 3

POST /v3/checkout-api/checkout-request/custom-request Initiate Custom Checkout Request #
POST /v3/checkout-api/checkout-request/charge Initiate Charge Request #
GET /v3/checkout-api/query-status Query Request Status #

Documentation

📖
Documentation
https://docs.tingg.africa/docs/introduction
📖
Documentation
https://docs.tingg.africa/docs/checkout-v3-express-checkout
📖
Documentation
https://docs.tingg.africa/docs/checkout-v3-custom-checkout
📖
Documentation
https://docs.tingg.africa/docs/checkout-v3-direct-card
📖
Documentation
https://docs.tingg.africa/reference/acknowledge-payments
📖
Documentation
https://docs.tingg.africa/docs/payouts-get-started
📖
Documentation
https://docs.tingg.africa/reference/postpayment
📖
Documentation
https://docs.tingg.africa/reference/engagement-service-api-v2
📖
Documentation
https://docs.tingg.africa/reference/engagement-apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/openapi/cellulant-custom-checkout-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/json-schema/cellulant-checkout-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/json-schema/cellulant-payout-packet-schema.json

Other Resources

🔗
Webhooks
https://docs.tingg.africa/reference/4-implement-webhook-via-callback-url-1
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/json-ld/cellulant-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/examples/cellulant-create-express-checkout-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/examples/cellulant-post-payment-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/cellulant/refs/heads/main/examples/cellulant-send-engagement-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cellulant-custom-checkout-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cellulant-custom-checkout-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cellulant Tingg Checkout Custom Checkout API
  description: 'Tingg Checkout 3.0 — accept payments across 25+ African markets through

    a single integration. Supports Express Checkout (hosted/modal) and Custom

    Checkout (host-to-host) for mobile money, cards, and direct bank transfer.

    '
  version: 3.0.0
  contact:
    name: Cellulant Developer Support
    url: https://developer.tingg.africa
    email: developer@cellulant.io
  license:
    name: Cellulant Terms of Service
    url: https://www.cellulant.io/terms
servers:
- url: https://api.tingg.africa
  description: Production
- url: https://api-approval.tingg.africa
  description: Sandbox
security:
- BearerAuth: []
  ApiKeyAuth: []
tags:
- name: Custom Checkout
  description: Host-to-host checkout flow for merchant-controlled UX.
paths:
  /v3/checkout-api/checkout-request/custom-request:
    post:
      summary: Initiate Custom Checkout Request
      description: Initiate a host-to-host checkout where the merchant collects payment details and posts them to Tingg directly, retaining control of the UX.
      operationId: initiateCustomCheckout
      tags:
      - Custom Checkout
      parameters:
      - $ref: '#/components/parameters/ApiKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCheckoutRequest'
      responses:
        '200':
          description: Custom checkout initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCheckoutResponse'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /v3/checkout-api/checkout-request/charge:
    post:
      summary: Initiate Charge Request
      description: Post a charge request to debit the customer for an initiated custom checkout. Used to push USSD/STK prompts or card charges from the merchant's backend.
      operationId: initiateChargeRequest
      tags:
      - Custom Checkout
      parameters:
      - $ref: '#/components/parameters/ApiKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChargeRequest'
      responses:
        '200':
          description: Charge accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeResponse'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /v3/checkout-api/query-status:
    get:
      summary: Query Request Status
      description: Retrieve the current status of a previously raised checkout or charge request by merchant_transaction_id.
      operationId: queryRequestStatus
      tags:
      - Custom Checkout
      parameters:
      - $ref: '#/components/parameters/ApiKey'
      - name: merchant_transaction_id
        in: query
        required: true
        schema:
          type: string
      - name: service_code
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    ChargeRequest:
      type: object
      required:
      - checkout_request_id
      - payment_option_code
      - msisdn
      properties:
        checkout_request_id:
          type: string
        merchant_transaction_id:
          type: string
        service_code:
          type: string
        payment_option_code:
          type: string
        msisdn:
          type: string
        amount:
          type: number
          format: double
        currency_code:
          type: string
    Payment:
      type: object
      properties:
        cpg_transaction_id:
          type: string
        payer_transaction_id:
          type: string
        customer_name:
          type: string
        msisdn:
          type: string
        amount_paid:
          type: number
          format: double
        currency_code:
          type: string
        payment_mode:
          type: string
        hub_overall_status:
          type: string
        payment_status:
          type: string
    ChargeResponse:
      type: object
      properties:
        status_code:
          type: integer
        status_description:
          type: string
        cpg_transaction_id:
          type: string
    CustomCheckoutResponse:
      type: object
      properties:
        status_code:
          type: integer
        checkout_request_id:
          type: string
        merchant_transaction_id:
          type: string
    ExpressCheckoutRequest:
      type: object
      required:
      - merchant_transaction_id
      - service_code
      - country_code
      - currency_code
      - request_amount
      - callback_url
      properties:
        merchant_transaction_id:
          type: string
          description: Unique merchant transaction id.
        service_code:
          type: string
          description: Tingg service code identifying the merchant's product line.
        country_code:
          type: string
          description: ISO 3166-1 alpha-2 country code (KE, UG, TZ, NG, GH, ...).
        currency_code:
          type: string
          description: ISO 4217 currency code.
        request_amount:
          type: number
          format: double
        request_description:
          type: string
        account_number:
          type: string
        msisdn:
          type: string
          description: Customer phone in E.164 format.
        customer_first_name:
          type: string
        customer_last_name:
          type: string
        customer_email:
          type: string
          format: email
        due_date:
          type: string
          format: date-time
        callback_url:
          type: string
          format: uri
        success_redirect_url:
          type: string
          format: uri
        fail_redirect_url:
          type: string
          format: uri
        payment_option_code:
          type: string
        language_code:
          type: string
          example: en
    StatusResponse:
      type: object
      properties:
        checkout_request_id:
          type: string
        merchant_transaction_id:
          type: string
        request_status_code:
          type: string
        request_status_description:
          type: string
        request_amount:
          type: number
          format: double
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        failed_payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
    CustomCheckoutRequest:
      allOf:
      - $ref: '#/components/schemas/ExpressCheckoutRequest'
      - type: object
        properties:
          payer_client_code:
            type: string
          payer_mode:
            type: string
            enum:
            - MOBILE
            - BANK
            - CARD
    Error:
      type: object
      properties:
        status_code:
          type: integer
        status_description:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
  parameters:
    ApiKey:
      name: apikey
      in: header
      required: true
      description: Merchant API key issued in the Tingg integration dashboard.
      schema:
        type: string
  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Merchant apiKey issued in the Tingg integration dashboard.