# ClickPesa Documentation > ClickPesa API Documentation - [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 - [Login and Password Reset](https://docs.clickpesa.com/home/login-password-reset.md): How to log in to the ClickPesa Merchant Dashboard with OTP and reset your password - [Instant Web Access](https://docs.clickpesa.com/home/instant-web-access.md): Install the ClickPesa Merchant Dashboard as an app on your phone or desktop for quick access without app store downloads - [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 - [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 - [Sandbox and Testing Environment](https://docs.clickpesa.com/home/sandbox-and-testing-environment.md): ClickPesa does not provide a sandbox. Test against live production with small amounts and the pre-KYC limits - [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 - [Checksum](https://docs.clickpesa.com/home/checksum.md): Generate checksum for secure transactions via API - [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 - [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. - [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. - [Merchant Dashboard Overview](https://docs.clickpesa.com/dashboard/dashboard-overview.md): Manage collections, payouts, transactions, and account settings from the ClickPesa Merchant Dashboard — no coding required - [Get Started in the Dashboard](https://docs.clickpesa.com/dashboard/get-started.md): Use the in-dashboard Get Started hub to set up your account, enable payments, and find developer resources - [Set Up Your Company Account](https://docs.clickpesa.com/dashboard/setup-company-account.md): Complete the six-step account setup checklist in the Merchant Dashboard before collecting payments or sending payouts - [Payment Pages](https://docs.clickpesa.com/dashboard/payment-pages.md): Create and manage payment pages in the Merchant Dashboard - [E-Invoice](https://docs.clickpesa.com/dashboard/e-invoice.md): Create and manage invoices in the Merchant Dashboard - [Checkout Links](https://docs.clickpesa.com/dashboard/checkout-links.md): View and manage hosted checkout links in the Merchant Dashboard - [Customers](https://docs.clickpesa.com/dashboard/customers.md): Add customers and assign BillPay control numbers in the Merchant Dashboard - [Payment Plans](https://docs.clickpesa.com/crdb-direct-debit/payment-plans.md): Create and manage CRDB Direct Debit payment plans in the Merchant Dashboard - [Single Payout](https://docs.clickpesa.com/dashboard/disbursement/single-payout.md): Send a payout to one beneficiary from the Merchant Dashboard - [Bulk Payouts](https://docs.clickpesa.com/dashboard/disbursement/bulk-payouts.md): Send payouts to multiple beneficiaries from the Merchant Dashboard - [Payments](https://docs.clickpesa.com/dashboard/transactions/payments.md): Overseeing your payment transaction is essential for good financial management. Our dashboard simplifies this task by providing a clear view and tracking of... - [Payouts](https://docs.clickpesa.com/dashboard/transactions/payouts.md): Overseeing your payout transactions is a crucial aspect of any business, and being able to track and review payouts is fundamental to maintaining... - [Balance](https://docs.clickpesa.com/dashboard/account/balance.md): Balance is where collected payments are settled and also balance is used for disbursing (bulk) payouts to - [Deposits](https://docs.clickpesa.com/dashboard/account/deposits.md): This guide will walk you through the process of doing a deposit to your account. With Deposit you can fund your balance. You can use funds to payout via... - [Withdrawal](https://docs.clickpesa.com/dashboard/account/withdraws.md): This guide will walk you through the process of doing a withdrawal. With withdrawal you can withdraw any TZS or USD balance. You can use withdrawal to... - [Payment Export](https://docs.clickpesa.com/dashboard/data-export/payment-export.md): This feature simplifies the process of exporting your payments data exactly how you want it. We've already organized the data for you, so all you need to do... - [Payout Export](https://docs.clickpesa.com/dashboard/data-export/payout-export.md): This feature simplifies the process of exporting your payouts data exactly how you want it. We've already organized the data for you, so all you need to do... - [Deposit Export](https://docs.clickpesa.com/dashboard/data-export/deposit-export.md): This feature simplifies the process of exporting your deposits data exactly how you want it. We've already organized the data for you, so all you need to do... - [Withdraw Export](https://docs.clickpesa.com/dashboard/data-export/withdraw-export.md): This feature simplifies the process of exporting your withdrawal data exactly how you want it. We've already organized the data for you, so all you need to... - [Quickbooks](https://docs.clickpesa.com/dashboard/data-export/quickbooks.md): This feature simplifies the process of exporting your transactions for quickbooks . We've already organized the data for you, so all you need to do is... - [General](https://docs.clickpesa.com/dashboard/settings/general.md): Manage business profile, contact details, and authorised person information in the Merchant Dashboard - [Collection](https://docs.clickpesa.com/dashboard/settings/collection.md): In this section, you'll find all the settings related to receiving funds through Online and Offline Collections . These settings control payment... - [Disbursement](https://docs.clickpesa.com/dashboard/settings/disbursement.md): This settings is the location where your company's bank account is added. The withdraw settlement account is the bank account where funds are settled when... - [Team](https://docs.clickpesa.com/dashboard/settings/team.md): Invite team members and assign roles in the Merchant Dashboard - [KYC](https://docs.clickpesa.com/dashboard/settings/kyc.md): Upload and manage KYC documents to verify your business in the Merchant Dashboard - [Developers](https://docs.clickpesa.com/dashboard/settings/developers.md): Create applications, manage API keys, webhooks, and IP whitelisting in the Merchant Dashboard - [Security](https://docs.clickpesa.com/dashboard/settings/security.md): In today's digital landscape, safeguarding your accounts against unauthorized access is crucial. This feature enables users to effortlessly update their... - [Notifications](https://docs.clickpesa.com/dashboard/notifications.md): Email and SMS for payments, payouts, and deposits — plus the dashboard bell and account alerts - [Hosted Checkout Overview](https://docs.clickpesa.com/checkout/checkout-overview.md): Hosted Checkout is a ready-to-use payment acceptance experience provided by ClickPesa. - [Common Use Cases](https://docs.clickpesa.com/checkout/common-use-cases.md): Where Hosted Checkout and Checkout Links fit your business - [The Hosted Checkout Page](https://docs.clickpesa.com/checkout/checkout-page.md): Hosted Checkout is a feature that facilitates seamless payments for customers of ClickPesa merchants. It allows users to pay for Payment Pages, Invoices,... - [Checkout Link](https://docs.clickpesa.com/checkout/checkout-link.md): The checkout link feature is for businesses and organizations with an app, website or software product who seek a streamlined method to accept online... - [Checkout Link API](https://docs.clickpesa.com/checkout/checkout-link-api.md): Generate Hosted Checkout link using API - [Mobile USSD-PUSH API](https://docs.clickpesa.com/payment-api/mobile-money-payment-api/mobile-money-payment-api-overview.md): Collect payments from customers' mobile money wallets using USSD-PUSH requests - [Card API](https://docs.clickpesa.com/payment-api/card-payment-api/card-payment-api-overview.md): Accept card payments from all major card processors including Visa, MasterCard, American Express and UnionPay - [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 - [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. - [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 - [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 via API or, for legacy accounts, by manual concatenation. - [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 - [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 - [TanQR/Lipa Namba Overview](https://docs.clickpesa.com/tan-qr/tan-qr-overview.md): Accept payments with a QR code and Lipa Namba powered by TIPS - [TanQR/Lipa Namba FAQ](https://docs.clickpesa.com/tan-qr/tan-qr-faq.md): Frequently asked questions about TanQR/Lipa Namba - [Set Up Lipa Namba](https://docs.clickpesa.com/tan-qr/lipa-namba-setup.md): Activate TanQR/Lipa Namba in the ClickPesa Merchant Dashboard - [Accepting Payments with Lipa Namba](https://docs.clickpesa.com/tan-qr/accepting-payments.md): How customers pay using your TanQR/Lipa Namba QR code or Lipa Namba - [CRDB Direct Debit Overview](https://docs.clickpesa.com/crdb-direct-debit/crdb-direct-debit-overview.md): Collect recurring payments from customers' CRDB bank accounts with mandate-based Direct Debit - [CRDB Direct Debit FAQ](https://docs.clickpesa.com/crdb-direct-debit/faq.md): Common questions about CRDB Direct Debit, Payment Plans, and mandates - [Set Up CRDB Direct Debit](https://docs.clickpesa.com/crdb-direct-debit/setup.md): Activate CRDB Direct Debit in the ClickPesa Merchant Dashboard - [Payment Plans](https://docs.clickpesa.com/crdb-direct-debit/payment-plans.md): Create and manage CRDB Direct Debit payment plans in the Merchant Dashboard - [CRDB Direct Debit API](https://docs.clickpesa.com/crdb-direct-debit/api-overview.md): Request mandate approvals, query, and cancel CRDB Direct Debit mandates with the Collection API - [Mobile Payouts API](https://docs.clickpesa.com/payout-api/mobile-money-payout-api/mobile-money-payout-api-overview.md): Send payouts directly to recipients' mobile money wallets. - [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. - [Lipa Namba Payout API](https://docs.clickpesa.com/payout-api/lipa-namba-payout-api/lipa-namba-payout-api-overview.md): Send money to any Lipa Namba or TanQR in Tanzania, instantly. - [Plugins and Extensions](https://docs.clickpesa.com/sdk-plugins/plugins-and-extensions.md): Official and community-built plugins, SDKs, and extensions for ClickPesa integration - [Generate Authorization Token](https://docs.clickpesa.com/api-reference/authorization/generate-token.md): Generates JWT Authorization token required for accessing ClickPesa APIs - [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 - [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 - [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 - [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 - [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 - [Initiate Card Payment](https://docs.clickpesa.com/api-reference/collection/card-payment/initiate-card-payment.md) - [Query Payment Status](https://docs.clickpesa.com/api-reference/collection/card-payment/querying-for-payments.md): Queries for the payment status using payment's Order Reference - [Query All Payments](https://docs.clickpesa.com/api-reference/collection/card-payment/query-all-payments.md): Query all payments with filtering, sorting, and pagination capabilities - [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 - [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 - [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. - [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 - [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, collection ceiling, 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. - [Request Mandate Approval](https://docs.clickpesa.com/api-reference/collection/crdb-direct-debit/request-mandate.md): Request CRDB Direct Debit mandate approval and create the linked payment schedule. - [Get Mandate](https://docs.clickpesa.com/api-reference/collection/crdb-direct-debit/get-mandate.md): Get CRDB Direct Debit mandate details and linked payment plan summary by mandate request ID - [Cancel Mandate](https://docs.clickpesa.com/api-reference/collection/crdb-direct-debit/cancel-mandate.md): Cancel an ACTIVE CRDB Direct Debit mandate. When the linked payment plan is still active, the plan and unpaid cycles are cancelled too. - [Preview Mobile Money Payout](https://docs.clickpesa.com/api-reference/disbursement/mno-payout/preview-mno-payout.md): Validates a mobile money payout and returns the fee and balance. - [Create Mobile Money Payout](https://docs.clickpesa.com/api-reference/disbursement/mno-payout/create-mno-payout.md): Sends a payout to a mobile money wallet. - [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 - [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 - [Preview Bank Payout](https://docs.clickpesa.com/api-reference/disbursement/bank-payout/preview-bank-payout.md): Validates a bank payout and returns the fee, balance, and estimated arrival. - [Create Bank Payout](https://docs.clickpesa.com/api-reference/disbursement/bank-payout/create-bank-payout.md): Sends a payout to a bank account. - [Query Payout Status](https://docs.clickpesa.com/api-reference/disbursement/bank-payout/querying-for-payouts.md): Queries for the payouts status using payout’s Order Reference - [Query All Payouts](https://docs.clickpesa.com/api-reference/disbursement/bank-payout/query-all-payouts.md): Query all payouts with filtering, sorting, and pagination capabilities - [Retrieve Banks List](https://docs.clickpesa.com/api-reference/list/get-bank-list.md): Get Bank List - [Retrieve Lipa Namba Providers](https://docs.clickpesa.com/api-reference/disbursement/lipa-namba-payout/list-lipa-namba-providers.md): Returns the list of Lipa Namba providers. - [Preview Lipa Namba Payout](https://docs.clickpesa.com/api-reference/disbursement/lipa-namba-payout/preview-lipa-namba-payout.md): Validates a Lipa Namba or TanQR payout and returns the fee, balance, and beneficiary name. - [Create Lipa Namba Payout](https://docs.clickpesa.com/api-reference/disbursement/lipa-namba-payout/create-lipa-namba-payout.md): Sends a payout to a Lipa Namba or TanQR. - [Query Payout Status](https://docs.clickpesa.com/api-reference/disbursement/lipa-namba-payout/querying-for-payouts.md): Queries for the payouts status using payout’s Order Reference - [Query All Payouts](https://docs.clickpesa.com/api-reference/disbursement/lipa-namba-payout/query-all-payouts.md): Query all payouts with filtering, sorting, and pagination capabilities - [Generate Checkout Link](https://docs.clickpesa.com/api-reference/collection/generate-checkout-link/generate-checkout-link.md): Generates a link for receiving payments via Hosted Checkout. After payment, customers are redirected to the Return URL configured on your hosted application in the dashboard. For payment status updates, use application webhooks and/or an optional callbackUrl on the request body (see Payment notifica… - [Generate Payout Link](https://docs.clickpesa.com/api-reference/disbursement/generate-payout-link/generate-payout-link.md): Generate Payout Link for making payouts - [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 - [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. ## OpenAPI Specs - [openapi](/api-reference/account/openapi.json) - [openapi](/api-reference/authorization/openapi.json) - [openapi](/api-reference/collection/billpay/openapi.json) - [openapi](/api-reference/collection/card-payment/openapi.json) - [openapi](/api-reference/collection/crdb-direct-debit/openapi.json) - [openapi](/api-reference/collection/generate-checkout-link/openapi.json) - [openapi](/api-reference/collection/query-all-payments/openapi.json) - [openapi](/api-reference/collection/querying-for-payments/openapi.json) - [openapi](/api-reference/collection/ussd-push-requests/openapi.json) - [openapi](/api-reference/disbursement/bank-payout/openapi.json) - [openapi](/api-reference/disbursement/generate-payout-link/openapi.json) - [openapi](/api-reference/disbursement/lipa-namba-payout/openapi.json) - [openapi](/api-reference/disbursement/mno-payout/openapi.json) - [openapi](/api-reference/disbursement/query-all-payouts/openapi.json) - [openapi](/api-reference/disbursement/querying-for-payouts/openapi.json) - [openapi](/api-reference/exchange/openapi.json) - [openapi](/api-reference/list/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.