# Zerocash

> Zerocash API documentation — collect payments and disburse payouts across Africa and beyond through a single integration.

## Docs

- [Account Resolver](https://docs.zerocash.tech/api-reference/endpoint/account-resolver.md): Resolve and verify account details across multiple payment methods and currencies. This endpoint routes the request to the appropriate provider based on the `currency` and `method` combination, returning a normalised account name and ID.
- [Authorise Charge](https://docs.zerocash.tech/api-reference/endpoint/authorise-charge.md): Submit the required authorisation data (OTP, PIN, or Address) to move the transaction forward.
- [Bank Transfer](https://docs.zerocash.tech/api-reference/endpoint/bank-transfer.md): This endpoint allows you to create temporary virtual bank accounts for accepting payments.
- [Card Charge](https://docs.zerocash.tech/api-reference/endpoint/card-charge.md): Start a card payment transaction by sending the customer's card details and transaction information.
- [Create an External Account](https://docs.zerocash.tech/api-reference/endpoint/create-an-external-account.md): External accounts, also known as beneficiaries, are records of accounts where funds can be sent (payouts) or from which funds can be initiated (deposits). This can represent an individual's bank account, a business account, or a mobile mone
- [Currency Uptime Checker](https://docs.zerocash.tech/api-reference/endpoint/currency-uptime-checker.md): Monitor the real-time health status of payment services across different currencies. Use this endpoint to check service availability before initiating transactions or to display the status on your integration's dashboard.
- [Delete External Account](https://docs.zerocash.tech/api-reference/endpoint/delete-external-account.md)
- [Generate Bearer Token](https://docs.zerocash.tech/api-reference/endpoint/generate-bearer-token.md): Generates or retrieves a valid bearer token for a given public key. This token is used to authenticate requests and lasts for 1 hour.
- [Get Banks](https://docs.zerocash.tech/api-reference/endpoint/get-banks.md): Fetch supported banks for a particular country.
- [Get Branches](https://docs.zerocash.tech/api-reference/endpoint/get-branches.md): Get Bank Branches (Conditional on whether or not bank has branches as well)
- [Get Countries](https://docs.zerocash.tech/api-reference/endpoint/get-countries.md): Get all supported countries and methods supported within them.
- [Get External Account](https://docs.zerocash.tech/api-reference/endpoint/get-external-account.md)
- [Get External Accounts](https://docs.zerocash.tech/api-reference/endpoint/get-external-accounts.md)
- [Get FX Rate](https://docs.zerocash.tech/api-reference/endpoint/get-fx-rate.md): This endpoint retrieves the currency conversion rate and the converted amount from one currency to another.
- [Get Historical Rates](https://docs.zerocash.tech/api-reference/endpoint/get-historical-rates.md): This will give you historical BID or ASK rates for a specific pair over the last 30 days.
- [Get Mobile Money Providers](https://docs.zerocash.tech/api-reference/endpoint/get-mobile-money-providers.md): This endpoint allows you to get the mobile money providers.
- [Get Phone Number Operators](https://docs.zerocash.tech/api-reference/endpoint/get-phone-number-operators.md): Retrieves the mobile money operator details for a given phone number, based on the number, currency, and country provided.
- [Get Transaction](https://docs.zerocash.tech/api-reference/endpoint/get-transaction.md)
- [Get Transactions](https://docs.zerocash.tech/api-reference/endpoint/get-transactions.md): Lists recent transactions for your account. Results are paginated and return up to 3 transactions by default. Pass limit to request up to 10 transactions per call. For status checks on a known transaction, use GET /api/b2b/transactions/{tra
- [Get User](https://docs.zerocash.tech/api-reference/endpoint/get-user.md): The endpoint fetches user profile information, including their contact details and configured webhook URLs for both production and sandbox environments. It also includes information about any active wallets associated with the user's accoun
- [Get Webhook](https://docs.zerocash.tech/api-reference/endpoint/get-webhook.md): Fetch a webhook.
- [Get Webhooks](https://docs.zerocash.tech/api-reference/endpoint/get-webhooks.md): This api allows for users to fetch their webhooks.
- [Mobile Money Charge](https://docs.zerocash.tech/api-reference/endpoint/mobile-money-charge.md): Initiates a mobile money charge request for transactions.
- [Opay Charge](https://docs.zerocash.tech/api-reference/endpoint/opay-charge.md): Accept payments via OPay. Charges are processed asynchronously; some transactions require a redirect to complete authentication before funds are captured.
- [Payouts](https://docs.zerocash.tech/api-reference/endpoint/payouts.md): This endpoint is a universal endpoint, below are schemas for different payouts such as mobile money or bank accounts and this endpoint allows you to payout to these destinations through this single endpoint.
- [Refund Deposit](https://docs.zerocash.tech/api-reference/endpoint/refund-deposit.md): This API endpoint allows you to initiate a refund for a previously successful mobile money deposit transaction.
- [Resend Webhook](https://docs.zerocash.tech/api-reference/endpoint/resend-webhook.md): Allows a user to resend webhooks.
- [Simulate Webhook](https://docs.zerocash.tech/api-reference/endpoint/simulate-webhook.md): This endpoint lets you simulate webhook events in the sandbox environment, allowing you to test your webhook handling code without waiting for real events.
- [Update External Account](https://docs.zerocash.tech/api-reference/endpoint/update-external-account.md)
- [Validate OTP](https://docs.zerocash.tech/api-reference/endpoint/validate-otp.md): This endpoint validates a deposit transaction that requires OTP confirmation after charge initiation. Use it only when Zerocash returns or sends stepRequired: "otp". For provider-required OTPs that must be collected before creating the ch
- [API Reference](https://docs.zerocash.tech/api-reference/introduction.md): Conventions, authentication, and error handling shared by every Zerocash endpoint.
- [Account fees](https://docs.zerocash.tech/guides/account-fees.md): Where to find the deposit and withdrawal fees configured for your account.
- [Authentication](https://docs.zerocash.tech/guides/authentication.md): Exchange your API keys for a bearer token and authenticate every request.
- [Bank transfer](https://docs.zerocash.tech/guides/collections/bank-transfer.md): Generate a temporary account for the customer to pay into, and reconcile the transfer automatically.
- [Card charge](https://docs.zerocash.tech/guides/collections/card.md): Collect card payments and handle 3DS, OTP, PIN, and address verification steps.
- [Mobile money charge](https://docs.zerocash.tech/guides/collections/mobile-money.md): Charge a customer's mobile money wallet, handle OTP and redirect steps, and confirm the outcome.
- [OPay charge](https://docs.zerocash.tech/guides/collections/opay.md): Accept NGN payments through OPay, including the redirect authorisation step.
- [Charges overview](https://docs.zerocash.tech/guides/collections/overview.md): The ways to collect money from your customers, and how to choose between them.
- [Environments](https://docs.zerocash.tech/guides/environments.md): How sandbox and production differ, and how to move between them safely.
- [API error codes](https://docs.zerocash.tech/guides/errors/api-errors.md): HTTP status codes and errorCode values returned when a request itself fails.
- [Transaction error codes](https://docs.zerocash.tech/guides/errors/transaction-error-codes.md): Why an individual charge or payout failed, and what to do about each case.
- [Mobile money operators](https://docs.zerocash.tech/guides/mobile-money-operators.md): Operator codes by country, for momoOperatorId on charges and payoutMethod.code on payouts.
- [External accounts](https://docs.zerocash.tech/guides/payouts/external-accounts.md): Store recipients as beneficiaries so repeat payouts need only an ID.
- [Payouts overview](https://docs.zerocash.tech/guides/payouts/overview.md): Disburse funds to mobile money wallets, bank accounts, paybills, and tills through one endpoint.
- [Sending payouts](https://docs.zerocash.tech/guides/payouts/payouts.md): Implement payouts to mobile money, bank accounts, paybills, tills, and saved recipients.
- [Supported countries & limits](https://docs.zerocash.tech/guides/supported-countries.md): Where Zerocash moves money, by method, with minimum and maximum transaction amounts.
- [Testing direct collection APIs](https://docs.zerocash.tech/guides/testing/direct-collections.md): Sandbox values for mobile money, bank transfer, card, and OPay charge endpoints.
- [Testing overview](https://docs.zerocash.tech/guides/testing/overview.md): Sandbox test values for collections and payouts, and the rules that apply to both.
- [Testing payouts](https://docs.zerocash.tech/guides/testing/payouts.md): Sandbox account numbers that simulate successful and failed payouts.
- [Event types & structures](https://docs.zerocash.tech/guides/webhooks/event-types.md): The webhook envelope, the events Zerocash sends, and the transaction types you will see.
- [Getting started with webhooks](https://docs.zerocash.tech/guides/webhooks/getting-started.md): Receive real-time transaction notifications instead of polling the API.
- [Webhook secrets](https://docs.zerocash.tech/guides/webhooks/secrets.md): Verify that an incoming webhook genuinely came from Zerocash.
- [Transaction events](https://docs.zerocash.tech/guides/webhooks/transaction-events.md): Example payloads for every transaction webhook, including step-required and refund events.
- [Zerocash API](https://docs.zerocash.tech/introduction.md): Collect payments and disburse funds across Africa and beyond through a single integration.
- [Quickstart](https://docs.zerocash.tech/quickstart.md): Authenticate, collect your first payment, and send your first payout.
- [Collect Africell mobile money in The Gambia or DR Congo](https://docs.zerocash.tech/recipes/africell-gmd-cdf.md): Charge an Africell customer in GMD or CDF, where they confirm from a USSD menu after you create the charge.
- [Collect Orange Money in Burkina Faso](https://docs.zerocash.tech/recipes/orange-money-burkina-faso.md): Charge an XOF Orange Money customer in Burkina Faso, where a one-time payment code is generated before the charge.
- [Collect Orange Money in Côte d'Ivoire](https://docs.zerocash.tech/recipes/orange-money-cote-divoire.md): Charge an XOF Orange Money customer in Côte d'Ivoire using a 4-digit temporary authorisation code.
- [Collect OTT Voucher payments in Botswana](https://docs.zerocash.tech/recipes/ott-voucher-botswana.md): Charge a BWP customer paying with an OTT Voucher by redeeming their voucher PIN.
- [Recipes](https://docs.zerocash.tech/recipes/overview.md): End-to-end walkthroughs for corridors that need more than a standard charge.

## OpenAPI Specs

- [openapi](https://docs.zerocash.tech/api-reference/openapi.json)