# ClickPesa Documentation

> ClickPesa API Documentation

## Docs

- [Retrieve Account Balance](https://docs.clickpesa.com/api-reference/account/get-account-balance.md): Get Account Balance
- [Retrieve Account Statement](https://docs.clickpesa.com/api-reference/account/get-account-statement.md): Get Account Statement
- [Generate Authorization Token](https://docs.clickpesa.com/api-reference/authorization/generate-token.md): Generates JWT Authorization token required for accessing ClickPesa APIs
- [Bulk Create Customer Control Numbers](https://docs.clickpesa.com/api-reference/collection/billpay/bulk-create-customer-control-numbers.md): Bulk create BillPay Customer Control Numbers (max 50 per request). Each item follows the single-create format. Supports partial success — valid items are created; invalid ones are returned in the errors array
- [Bulk Create Order Control Numbers](https://docs.clickpesa.com/api-reference/collection/billpay/bulk-create-order-control-numbers.md): Bulk creates BillPay Order Control Numbers (max 50 per request). Supports partial success: valid items are created while invalid items are reported in the errors array.
- [Create Customer Control Number](https://docs.clickpesa.com/api-reference/collection/billpay/create-customer-control-number.md): Generates a BillPay Control Number for a specific customer
- [Create Order Control Number](https://docs.clickpesa.com/api-reference/collection/billpay/create-order-control-number.md): Generates a BillPay Control Number for a specific bill, transaction or invoice
- [Query BillPay Number Details](https://docs.clickpesa.com/api-reference/collection/billpay/querying-for-billpay-details.md): Queries for BillPay number details
- [Update BillPay Reference](https://docs.clickpesa.com/api-reference/collection/billpay/update-billpay-reference.md): Partially updates a BillPay reference. Use to update amount, description, payment mode, or status without recreating the reference.
- [Update BillPay Number Status](https://docs.clickpesa.com/api-reference/collection/billpay/update-billpay-reference-status.md): **Deprecated.** Use PATCH /billpay/{billPayNumber} with body { billStatus } instead. Updates the status of a BillPay reference. Inactive references will be rejected during verification and confirmation.
- [Initiate Card Payment](https://docs.clickpesa.com/api-reference/collection/card-payment/initiate-card-payment.md)
- [Preview Card Payment](https://docs.clickpesa.com/api-reference/collection/card-payment/preview-card-payment.md): This endpoint validates card payment details like Amount, Order Reference and verifies Method availability
- [Generate Checkout Link](https://docs.clickpesa.com/api-reference/collection/generate-checkout-link/generate-checkout-link.md): Generates a link for receiving payments via ClickPesa Hosted Checkout
- [Query Payment Status](https://docs.clickpesa.com/api-reference/collection/querying-for-payments/querying-for-payments.md): Queries for the payment status using payment's Order Reference
- [Initiate USSD-PUSH request](https://docs.clickpesa.com/api-reference/collection/ussd-push-requests/initiate-ussd-push-request.md): Sends the USSD-PUSH request to customer's mobile device for payment authorization
- [Preview USSD-PUSH request](https://docs.clickpesa.com/api-reference/collection/ussd-push-requests/preview-ussd-push-request.md): Validates push details like phone number, amount, order-reference and verifies payment channels availability
- [Query All Payments](https://docs.clickpesa.com/api-reference/collection/ussd-push-requests/query-all-payments.md): Query all payments with filtering, sorting, and pagination capabilities
- [Create Bank Payout](https://docs.clickpesa.com/api-reference/disbursement/bank-payout/create-bank-payout.md)
- [Preview Bank Payout](https://docs.clickpesa.com/api-reference/disbursement/bank-payout/preview-bank-payout.md): Validates bank payout details like amount, order-reference and verifies payout channels availability
- [Generate Payout Link](https://docs.clickpesa.com/api-reference/disbursement/generate-payout-link/generate-payout-link.md): Generate Payout Link for making payouts
- [Create Mobile Money Payout](https://docs.clickpesa.com/api-reference/disbursement/mno-payout/create-mno-payout.md): Initiate a mobile money payout by sending a request to the API. The specified amount will be transferred to the recipient's mobile wallet.
- [Preview Mobile Money Payout](https://docs.clickpesa.com/api-reference/disbursement/mno-payout/preview-mno-payout.md): Validates mobile money payout details like phone number, amount, order-reference, fee
- [Query All Payouts](https://docs.clickpesa.com/api-reference/disbursement/mno-payout/query-all-payouts.md): Query all payouts with filtering, sorting, and pagination capabilities
- [Query Payout Status](https://docs.clickpesa.com/api-reference/disbursement/mno-payout/querying-for-payouts.md): Queries for the payouts status using payout’s Order Reference
- [Retrieve Exchange Rates](https://docs.clickpesa.com/api-reference/exchange/get-latest-exchange-rates.md): Retrieve latest exchange rates between currencies. If no params are passed, all available rates will be returned.
- [Retrieve Banks List](https://docs.clickpesa.com/api-reference/list/get-bank-list.md): Get Bank List
- [API Integration Setup](https://docs.clickpesa.com/application/api-application-setup.md): Learn how to set up API integration with ClickPesa, including creating applications, managing API keys, and retrieving credentials
- [Embedded Integration Setup](https://docs.clickpesa.com/application/embedded-application-setup.md): Learn how to set up an embedded integration with ClickPesa to seamlessly integrate payment services into your application.
- [Hosted Integration Setup](https://docs.clickpesa.com/application/hosted-application-setup.md): Learn how to set up hosted integration with ClickPesa, including creating applications, managing API keys, and retrieving credentials.
- [ClickPesa BillPay Overview](https://docs.clickpesa.com/bill-pay/bill-pay-overview.md): Create and use BillPay Control Numbers to receive instant payments from mobile money and banks
- [BillPay API](https://docs.clickpesa.com/bill-pay/billpay-api-overview.md): The BillPay API enables you to create BillPay Control Numbers for orders and customers to receive payments from mobile money wallets and bank accounts
- [FAQ](https://docs.clickpesa.com/bill-pay/billpay-faq.md): Frequently Asked Questions about BillPay Control Numbers
- [Merchant BillPay-Namba](https://docs.clickpesa.com/bill-pay/billpay-namba.md): Your 4-digit static BillPay number for merchant deposits
- [Common Use Cases](https://docs.clickpesa.com/bill-pay/billpay-use-cases.md): Explore common use cases and userflows for BillPay, including webshop payments, invoice payments, offline purchases, and recurring customer payments.
- [Customer BillPay Control Number](https://docs.clickpesa.com/bill-pay/customer-billpay-namba.md): A static payment number assigned to a specific customer for repeat payments
- [Order BillPay Control Number](https://docs.clickpesa.com/bill-pay/order-billpay-namba.md): A one-time payment number for a specific transaction or invoice — created manually or via API.
- [Checkout Overview](https://docs.clickpesa.com/checkout/checkout-overview.md): ClickPesa Checkout is a ready-to-use payment acceptance experience provided by ClickPesa.
- [Checkout Link API](https://docs.clickpesa.com/checkout/hosted-checkout/checkout-link-api.md): Generate Hosted Checkout link using API
- [Hosted Checkout](https://docs.clickpesa.com/checkout/hosted-checkout/hosted-checkout.md): Accept payments in your platform by redirecting customers to the ClickPesa Hosted Checkout
- [Checksum](https://docs.clickpesa.com/home/checksum.md): Generate checksum for secure transactions via API
- [Overview](https://docs.clickpesa.com/home/integration-overview.md): 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
- [Quickstart](https://docs.clickpesa.com/home/introduction.md): ClickPesa makes accepting and disbursing payments easy, whether you know how to code or not - ClickPesa has the right solution for you.
- [Get Started With ClickPesa](https://docs.clickpesa.com/home/onboarding.md): Learn how open a ClicPesa account for your business and organizations in Tanzania
- [Payment Statuses](https://docs.clickpesa.com/home/payment-status.md): Understand the different payment statuses and how to receive them
- [Payout Statuses](https://docs.clickpesa.com/home/payout-status.md): Understand the different payout statuses and how to receive them
- [Webhooks](https://docs.clickpesa.com/home/webhooks.md): Understand ClickPesa Webhooks (Callbacks) and how to integrate them in your application
- [Whitelist IP](https://docs.clickpesa.com/home/whitelisted-ip-address.md): Whitelisting IP Address for secure API calls
- [Card Payment API](https://docs.clickpesa.com/payment-api/card-payment-api/card-payment-api-overview.md): Accept card payments from all major cards processor including Visa, MasterCard, American Express and Union Pay using the Cards Payment API
- [Mobile Money Payment API](https://docs.clickpesa.com/payment-api/mobile-money-payment-api/mobile-money-payment-api-overview.md): The Mobile Money Payment API enables you to collect payments directly from customers' mobile money wallets using USSD-PUSH requests
- [Payment API Overview](https://docs.clickpesa.com/payment-api/payment-api-overview.md): Understand ClickPesa Payment API and how to integrate in your application
- [Bank Payout API](https://docs.clickpesa.com/payout-api/bank-payout-api/bank-payout-api-overview.md): The Bank Payout API enables you to send payouts directly to recipients' bank accounts in Tanzania.
- [Mobile Money Payout API](https://docs.clickpesa.com/payout-api/mobile-money-payout-api/mobile-money-payout-api-overview.md): The Mobile Money Payout API enables you to send payouts directly to recipients' mobile money wallets.
- [Payout API Overview](https://docs.clickpesa.com/payout-api/payout-api-overview.md): Understand ClickPesa Payout API and how to integrate in your application
- [Plugins and Extensions](https://docs.clickpesa.com/sdk-plugins/plugins-and-extensions.md): Official and community-built plugins, SDKs, and extensions for ClickPesa integration

## OpenAPI Specs

- [openapi](https://docs.clickpesa.com/api-reference/account/openapi.json)