.payment-methods-card .card img {
   width: 6em;
   margin: auto;
   padding-top: 1em;
}

#footer > div > div {
   display: none;
}


Understand ClickPesa Payment API and how to integrate in your application

Payment API Overview

ClickPesa Documentation

ClickPesa makes accepting and disbursing payments easy, whether you know how to code or not - ClickPesa has the right solution for you.

Quickstart

Learn how open a ClicPesa account for your business and organizations in Tanzania

Get Started With ClickPesa

Welcome! ClickPesa offers a robust and flexible integration suite that supports different business requirements. Whether you need full API control, a simple hosted checkout, or an embedded solution, these guidelines will help you get started

Overview

Understand the different payment statuses and how to receive them

Payment Statuses

Understand the different payout statuses and how to receive them

Payout Statuses

Understand ClickPesa Webhooks (Callbacks) and how to integrate them in your application

Webhooks

Whitelisting IP Address for secure API calls

Whitelist IP

Generate checksum for secure transactions via API

Checksum

ClickPesa Checkout is a ready-to-use payment acceptance experience provided by ClickPesa.

Checkout Overview

Accept payments in your platform by redirecting customers to the ClickPesa Hosted Checkout

Hosted Checkout

Checkout Link API

Create custom billpay control number for bills and receive payments from mobile money wallets and bank free of charge

ClickPesa BillPay Overview

Explore common use cases and  userflow for BillPay, including webshop payments, invoice payments, and offline purchases.

Common Use Cases

Merchant BillPay-Namba

Order BillPay Control Number

Customer BillPay Control Number

Understand ClickPesa Payout Widgets and how to integrate them with your application

Payout Widgets Overview

Initiate payouts directly in your web application without redirecting to ClickPesa

Embedded Payout Widget

Send payouts from your ClickPesa account to mobile money wallets and bank accounts without leaving your application

Hosted Payout Widget

Generating a unique link for Hosted Payout Widget

Payout Link API

The Mobile Money Payment API enables you to collect payments directly from customers' mobile money wallets using USSD-PUSH requests

Mobile Money Payment API

Accept card payments from all major cards processor including Visa, MasterCard, American Express and Union Pay using the Cards Payment API

Card Payment API

Understand ClickPesa Payout API and how to integrate in your application

Payout API Overview

The Mobile Money Payout API enables you to send payouts directly to recipients' mobile money wallets.

Mobile Money Payout API

The Bank Payout API enables you to send payouts directly to recipients' bank accounts in Tanzania.

Bank Payout API

Generates JWT Authorization token required for accessing ClickPesa APIs

Generate Authorization Token

Validates push details like phone number, amount, order-reference and verifies payment channels availability

Preview USSD-PUSH request

Sends the USSD-PUSH request to customer's mobile device for payment authorization

Initiate USSD-PUSH request

Queries for the payment status using payment's Order Reference 

Query Payment Status

This endpoint validates card payment details like Amount, Order Reference and verifies Method availability

Preview Card Payment

Initiate Card Payment

Validates mobile money payout details like phone number, amount, order-reference, fee

Preview Mobile Money Payout

Initiate a mobile money payout by sending a request to the API. The specified amount will be transferred to the recipient’s mobile wallet.

Create Mobile Money Payout

Queries for the payouts status using payout’s Order Reference

Query Payout Status

Validates bank payout details like amount, order-reference and verifies payout channels availability

Preview Bank Payout

Create Bank Payout

Retrieve Account Balance

Retrieve Banks List

Generates a link for receiving payments via ClickPesa Hosted Checkout

Generate Checkout Link

Generate Payout Link

Plugins and SDK Integration

Welcome to the home of your new documentation

Introduction

Start building awesome documentation in under 5 minutes

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied