# Payaza Documentation

## Docs

- [Initiate Payment](https://docs.payaza.africa/api-reference/apple-pay-and-google-pay/initiate-payment.md): This endpoint is used to initiate an Apple Pay or Google Pay collection.
- [Authorize Transaction](https://docs.payaza.africa/api-reference/auth-capture-void/authorize-transaction.md): This endpoint authorizes a transaction and holds funds for a specified period. This endpoint handles payout requests.
- [Capture Transaction](https://docs.payaza.africa/api-reference/auth-capture-void/capture-transaction.md): This endpoint captures a previously authorized transaction.
- [Get All Authorizations](https://docs.payaza.africa/api-reference/auth-capture-void/get-all-authorizations.md): The merchant uses this endpoint to fetch refund transaction history. The data output can be filtered using a date range and/or status..
- [Get Single Authorization](https://docs.payaza.africa/api-reference/auth-capture-void/get-single-authorization.md): This endpoint retrieves details of a single authorization by its authorization_reference.
- [Void Transaction](https://docs.payaza.africa/api-reference/auth-capture-void/void-transaction.md): This endpoint voids a previously authorized transaction. This request can only be done on transactions that are fully authorized and have not been captured
- [Fetch All Branches](https://docs.payaza.africa/api-reference/branches/fetch-all-branches.md): This fetches all branches that have been created by a Payaza account.
- [Card Charge](https://docs.payaza.africa/api-reference/card-collection/card-charge.md): This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes.
- [Check Refund Status](https://docs.payaza.africa/api-reference/card-collection/check-refund-status.md): This endpoint is used to fetch the status of a refunded card payment (transaction).
- [Check Transaction Status](https://docs.payaza.africa/api-reference/card-collection/check-transaction-status.md): This endpoint gets the transaction status corresponding to the provided transaction reference for a card transaction.
- [Check Transaction Status(Merchant Reference)](https://docs.payaza.africa/api-reference/check-transaction-statusmerchant-reference/check-transaction-statusmerchant-reference.md): This endpoint is used to check the transaction status of a transaction using the Merchant Reference.
- [Fetch All EUR subaccounts](https://docs.payaza.africa/api-reference/eur-accounts/fetch-all-eur-subaccounts.md): This endpoint is used to display all EUR subaccounts that have been created under your Payaza Account
- [Get All EUR Account Request](https://docs.payaza.africa/api-reference/eur-accounts/get-all-eur-account-request.md): This endpoint fetches all the Euro subaccount requests that have been made on your Payaqza account.
- [Get Single Euro Account Request](https://docs.payaza.africa/api-reference/eur-accounts/get-single-euro-account-request.md): This fetches an Euro subaccount request through the creation reference retrieved when a user or corporate subaccount request is made.
- [List Of Acceptable IDs](https://docs.payaza.africa/api-reference/eur-accounts/list-of-acceptable-ids.md): This endpoint shows the list of acceptable identification documents in various countries for the creation of Euro subaccounts.
- [Request Corporate and User Subaccount](https://docs.payaza.africa/api-reference/eur-accounts/request-corporate-and-user-subaccount.md): This endpoint allows users to create a corporate or user subaccount
- [Flutter](https://docs.payaza.africa/api-reference/libraries/flutter.md): Payaza’s Flutter SDK makes it easy for you to start accepting payments from your customers when they visit your applications. The checkout SDK can be integrated in very easy steps, making it the easiest way to start accepting payments.
- [IOS Swift](https://docs.payaza.africa/api-reference/libraries/iosswift.md): IOS SDK aids in processing payment through the following channels: Cards, Bank and Virtual Transfer..
- [Payment Page](https://docs.payaza.africa/api-reference/libraries/paymentpage.md): Welcome to the Payment Page documentation. This guide will help you integrate our payment gateway and implement a secure and seamless checkout experience on your website.
- [React Native](https://docs.payaza.africa/api-reference/libraries/reactnative.md): Payaza React Native Library.
- [Web SDK](https://docs.payaza.africa/api-reference/libraries/websdk.md): Integrate the Payaza Checkout SDK into any website to accept card, bank transfer, and mobile money payments with a prebuilt, hosted payment modal.
- [WordPress](https://docs.payaza.africa/api-reference/libraries/wordpress.md)
- [Momo, XOF and ZAR Process Collection](https://docs.payaza.africa/api-reference/momo-and-zar-collections/momo-xof-and-zar-process-collection.md): This endpoint initiates mobile money collection for various currencies such as KES, GHS, UGX, TZS, LRD, ZAR, XOF and XAF. The Momo collections guide can be found [here](/guides/momo-collections)
- [Transaction Status Query](https://docs.payaza.africa/api-reference/momo-and-zar-collections/transaction-status-query.md): This endpoint is used to check the status of a transaction using the transaction reference from the Momo Collection Request.
- [XOF Process OTP](https://docs.payaza.africa/api-reference/momo-and-zar-collections/xof-process-otp.md): This endpoint processes the One Time Password that was retrieved by the user which would be used to complete the XOF(Orange only) Collection. For testing purposes, please use **2251114462945** for the OTP Required option. Also, use the OTP value **4567** for your tests..
- [View Payaza Account Details](https://docs.payaza.africa/api-reference/payaza-account/view-payaza-account-details.md): This endpoint retrieves the Payaza account details for a merchant.
- [Accept Or Reject Chargeback](https://docs.payaza.africa/api-reference/refunds-and-chargebacks/accept-or-reject-chargeback.md): This endpoint is used to either accept or decline a chargeback request.
- [Chargeback Request](https://docs.payaza.africa/api-reference/refunds-and-chargebacks/chargeback-request.md): This endpoint is used to fetch chargeback requests directed to your Payaza account.
- [Chargeback Transaction History](https://docs.payaza.africa/api-reference/refunds-and-chargebacks/chargeback-transaction-history.md): The merchant can use this endpoint to fetch all chargeback transactions.
- [Fetch Refund History](https://docs.payaza.africa/api-reference/refunds-and-chargebacks/fetch-refund-history.md): The merchant uses this endpoint to fetch refund transaction history for card transactions. The data output can be filtered using a date range and/or status..
- [Initiate Refund](https://docs.payaza.africa/api-reference/refunds-and-chargebacks/initiate-refund.md): This endpoint is used to initiate a refund for a card transaction.
- [Create A Subaccount](https://docs.payaza.africa/api-reference/sub-accounts/create-a-subaccount.md): This endpoint is used to create a subaccount.
- [View Payaza Sub Account Details](https://docs.payaza.africa/api-reference/sub-accounts/view-payaza-sub-account-details.md): This retrieves the Payaza subaccount details for a merchant using the subaccount account reference value in the Create A Subaccount API..
- [Bank Codes](https://docs.payaza.africa/api-reference/transfers/bank-codes.md): The Bank Codes API is used to retrieve the bank codes available for each country that would be used in the Initiate A Transfer request.
- [Get Account Name Enquiry](https://docs.payaza.africa/api-reference/transfers/get-account-name-enquiry.md): The Account Name Enquiry API is used to retrieve the account details of a beneficiary using its account number.
- [Initiate A Transfer](https://docs.payaza.africa/api-reference/transfers/initiate-a-transfer.md): Send funds from your Payaza account to a bank account or mobile wallet. Supports single and bulk payouts. See the full [Transfers guide](/guides/transfers) for a step-by-step walkthrough.
- [Transaction Status Query](https://docs.payaza.africa/api-reference/transfers/transaction-status-query.md): This retrieves the details of a transaction using the transaction reference value that was placed in the Initiate A Transfer request.
- [Create Reserved/Dynamic Virtual Account](https://docs.payaza.africa/api-reference/virtual-accounts/create-reserveddynamic-virtual-account.md): This API endpoint allows you to create dynamic virtual accounts with a duration of 30 mins and reserved/static virtual accounts that are permanent. Our virtual accounts guide can be found [here](/guides/virtual-accounts)
- [Fund Test Virtual Account](https://docs.payaza.africa/api-reference/virtual-accounts/fund-test-virtual-account.md): This endpoint funds the test virtual accounts. Please note that this API is just for sandbox collections.
- [Get Virtual Account Status](https://docs.payaza.africa/api-reference/virtual-accounts/get-virtual-account-status.md): This endpoint retrieves the status of a specific virtual account using the account number. It works for only static virtual accounts.
- [Transaction Status Query](https://docs.payaza.africa/api-reference/virtual-accounts/transaction-status-query.md): This endpoint is used to check the status of a transaction using the transaction reference.
- [Apple Pay & Google Pay](https://docs.payaza.africa/guides/apple-google-pay.md): Accept wallet payments from customers using Apple Pay and Google Pay. Initiate the payment server-side and confirm the outcome via webhook or status query.
- [Auth, Capture, and Void](https://docs.payaza.africa/guides/auth-capture-void.md): Pre-authorize a card, capture the funds later, or void the authorization before settlement. Use this flow when the final charge amount is not known at the time of payment.
- [Authentication](https://docs.payaza.africa/guides/authentication.md): All Payaza API requests are authenticated using your API key. Learn how to retrieve, encode, and use your key correctly.
- [Card Collections](https://docs.payaza.africa/guides/card-collection.md): This guide explains how to collect payments from customers using debit and credit cards via the Payaza Card Charge API — including 3DS authentication, transaction status checks, and refunds.
- [Collections — All Rails](https://docs.payaza.africa/guides/collections-overview.md): An overview of every Payaza collection channel: hosted checkout, API gateway, virtual accounts, mobile money, and digital wallets.
- [Errors](https://docs.payaza.africa/guides/errors.md): A reference for all Payaza API error responses, their causes, and how to fix them.
- [Getting Started](https://docs.payaza.africa/guides/getting-started.md): Everything you need to start collecting payments and sending transfers with the Payaza API.
- [Momo, XOF and ZAR Collections](https://docs.payaza.africa/guides/momo-collections.md): This guide explains how to collect payments directly from your customers' Mobile Money accounts using Payaza — covering MoMo (GHS, KES, UGX, TZS, LRD, XAF), XOF (Côte d'Ivoire and Benin), and ZAR EFT and Capitec (South Africa).
- [Payaza Account](https://docs.payaza.africa/guides/payaza-account.md): Retrieve your main Payaza account details — including balance, account reference, and virtual account numbers — for use across your integration.
- [Refunds & Chargebacks](https://docs.payaza.africa/guides/refunds-chargebacks.md): Initiate refunds on completed card transactions and manage chargeback disputes raised by customers through their card issuers.
- [Sub Accounts](https://docs.payaza.africa/guides/sub-accounts.md): Create and manage Payaza sub-accounts for internal business units. Sub-accounts are strictly for segmenting operations within your own organization — not for onboarding external customers or merchants.
- [Test Cards](https://docs.payaza.africa/guides/testcards.md): Use these test card numbers to simulate payment outcomes in the Payaza test environment. Test cards do not work in the live environment.
- [Transfers](https://docs.payaza.africa/guides/transfers.md): Send funds from your Payaza account to bank accounts and mobile wallets across Africa.
- [Virtual Accounts](https://docs.payaza.africa/guides/virtual-accounts.md): This guide explains how to collect NGN payments from customers using Payaza virtual accounts - both Dynamic (temporary) and Reserved (permanent).
- [Web Checkout Guide](https://docs.payaza.africa/guides/webcheckoutguide.md): Integrate the Payaza Checkout SDK into your website to accept card, bank transfer, and mobile money payments with a pre-built, hosted checkout flow.
- [Webhooks](https://docs.payaza.africa/guides/webhooks.md): Webhooks receive messages based on events triggered in the system, they are an important part of your payment integration. Webhooks are responsible for notifying you about events that happen on your accounts, such as pending, successful, or failed transactions.
- [Welcome to Payaza](https://docs.payaza.africa/introduction.md): Everything you need to integrate seamless global payments.

## OpenAPI Specs

- [openapi](https://docs.payaza.africa/openapi.json)