# Yogupay ## Yogupay API - [Welcome!](https://yogupay.gitbook.io/yogupay-payout-api/readme.md) - [Signing Up](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/quickstart.md) - [Onboarding Process](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/publish-your-docs.md): Detailed Description of what happens after a Business Registers to Yogupay - [Environments](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/environments.md): After successful onboarding, we will provide you with credentials to access the Sandbox environment. Yogupay provides two environments to accommodate your development and testing needs - [Compliance](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/compliance.md) - [Documents Required](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/compliance/documents-required.md): Our Compliance Team will require some documents from your end. - [Terms & Conditions](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/compliance/terms-and-conditions.md): Yogupay is globally committed to the highest standards of conduct created to maintain an environment of integrity. That commitment reflects Yogupay's responsibility towards sustainable growth - [Licenses](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/compliance/licenses.md): This document provides an overview of the licenses held by Yogupay in various countries where the company operates. Please note that licensing requirements may vary depending on the jurisdiction - [Privacy Policy](https://yogupay.gitbook.io/yogupay-payout-api/getting-started/compliance/privacy-policy.md): Yogupay is globally committed to the highest standards of conduct created to maintain an environment of integrity. That commitment reflects Yogupay's responsibility towards sustainable growth - [Login](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/editor.md): This guide directs a user on how to log in to the Merchant Dashboard. - [Dashboard](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/dashboard.md): After logging in, this is the first page you encounter. All the platforms functionalities will be displayed here. - [View Balances](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/view-balances.md): This guide allows you to view balances credited to your account - [Add Money (Deposit)](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/add-money-deposit.md): This guide allows you to Deposit funds to your Yogupay Account - [Adding a Beneficiary](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/adding-a-beneficiary.md): This guide shows you how to create beneficiaries in order to send funds to them - [Send Money](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/send-money.md): This guide shows you how to send funds to your Beneficiary - [Set Up Webhook](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/set-up-webhook.md): This guide shows you how to setup webhook. - [Set Up API Password](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/set-up-api-password.md): This guide shows you how to setup API passwords. - [OTC (Market Place)](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/otc-market-place.md): This guide will walk you through the process of accepting an OTC trade on the YP Platform. - [Whitelist your IPs](https://yogupay.gitbook.io/yogupay-payout-api/business-dashboard/whitelist-your-ips.md): This is guide shows you how to Whitelist your IPs through the YP Dashboard - [Authentication](https://yogupay.gitbook.io/yogupay-payout-api/developers/editor.md): This endpoint is used to authenticate a user and obtain a token for accessing protected resources. - [API response codes](https://yogupay.gitbook.io/yogupay-payout-api/developers/api-response-codes.md): Each API response provides 3 status indicators: Status code, message and Boolean. See below the API reference. - [Currency Codes](https://yogupay.gitbook.io/yogupay-payout-api/developers/currency-codes.md): This document provides a comprehensive list of Currency & Country Codes currently covered by Yogupay. - [Collection Africa](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa.md): This guide enables businesses to receive payments from mobile money wallets and bank accounts across multiple African markets. - [Collection Ghana](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-ghana.md): This endpoint allows you to initiate a collection to Ghana with YoguPay . Collections are done via Mobile Money - [Collection Kenya](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-kenya.md): This endpoint allows you to initiate a collection to Kenya with YoguPay . Collections are done via Mobile Money - [Collection Nigeria](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-nigeria.md): This endpoint allows you to initiate a collection to Nigeria with YoguPay . Collections are done via Bank Transfer. - [Collection Tanzania](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-tanzania.md): This endpoint allows you to initiate a collection to Tanzania - [Collection Uganda](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-uganda.md): This endpoint allows you to initiate a collection to Uganda - [Collection South Africa](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-south-africa.md): This endpoint allows you to initiate a collection to South Africa. It initiates a request to with instructions to collect South African Rand. Payment will be completed with EFT. - [Collection West Africa](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-west-africa.md): This endpoint allows you to initiate a collection to to collect XOF/XAF - [Collection Zambia](https://yogupay.gitbook.io/yogupay-payout-api/collections/collection-africa/collection-zambia.md): This endpoint allows you to initiate a collection to Zambia - [Query Collection Status](https://yogupay.gitbook.io/yogupay-payout-api/collections/query-collection-status.md): This endpoint retrieves the details of a specific Collection using the transaction\_id. - [Payout Africa](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa.md): This endpoint allows you to initiate a payout transaction to Africa with YoguPay. It can either be via Bank Transfer or Mobile Money. - [Payout Ghana](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-ghana.md): This endpoint allows you to initiate a payout transaction to Ghana with YoguPay . Payouts are done via Mobile Money. - [Payout Kenya](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-kenya.md): This endpoint allows you to initiate a payout transaction to Kenya with YoguPay . Payouts are done via Mobile Money. - [Payout Tanzania](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-tanzania.md): This endpoint allows you to initiate a payout transaction to Tanzania with YoguPay . Payouts are done via Mobile Money - [Mobile Money TZ](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-tanzania/mobile-money-tz.md): This endpoint allows you to initiate a payout transaction to Tanzania with YoguPay via Mobile Money - [Bank Transfer TZ](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-tanzania/bank-transfer-tz.md): This endpoint allows you to initiate a payout transaction to Tanzania with YoguPay via Bank Transfer - [Payout Nigeria](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-nigeria.md): This endpoint allows you to initiate a payout transaction to Nigeria with YoguPay . Payouts are done via Bank Transfer. - [Verify Bank Account NGN](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-nigeria/verify-bank-account-ngn.md): This endpoint is used to validate a bank account recipient before initiating an NGN payout. - [Payout Uganda](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-uganda.md): This endpoint allows you to initiate a payout transaction to Uganda with YoguPay . Payouts are done via Mobile Money. - [Payout Cameroon](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-cameroon.md): This endpoint allows you to initiate a payout transaction to Uganda with YoguPay . Payouts are done via Mobile Money. - [Payout Ivory Coast](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-ivory-coast.md): This endpoint allows you to initiate a payout transaction to Ivory Coast with YoguPay . Payouts are done via Mobile Money. - [Payout Zambia](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-zambia.md): This endpoint allows you to initiate a payout transaction to Zambia with YoguPay - [Payout South Africa](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-south-africa.md): This endpoint allows you to initiate a payout transaction to South Africa with YoguPay . Payouts are done via Mobile Money. - [Payout LATAM](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-latam.md): This endpoint allows you to initiate a payout transaction to LATAM countries with YoguPay. It is done via Bank Transfer. - [LATAM Document Types](https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-latam/latam-document-types.md): This guide describes the various document types for different LATAM countries - [View Account Balances](https://yogupay.gitbook.io/yogupay-payout-api/payouts/view-account-balances.md): This guide enables you to view the balances you currently have in your account - [Get Transaction By ID](https://yogupay.gitbook.io/yogupay-payout-api/payouts/get-transaction-by-id.md): This endpoint retrieves the details of a specific transaction using the transaction code. - [View All Transactions](https://yogupay.gitbook.io/yogupay-payout-api/payouts/view-all-transactions.md): This endpoint retrieves transactions associated to the authenticated user. - [Bank Codes](https://yogupay.gitbook.io/yogupay-payout-api/payouts/bank-codes.md): This document serves as a reference guide to the Bank codes covered by Yogupay. Bank codes, Bank Names and SWIFT codes, are crucial for international financial transactions. - [Fiat Callbacks](https://yogupay.gitbook.io/yogupay-payout-api/fiat-callbacks.md): This page describes the webhook notifications sent by YoguPay API to provide updates on transaction-related activities. These callbacks cover Fiat Deposits, Fiat Transactions, and Fiat OTC. - [Get Fiat OTC](https://yogupay.gitbook.io/yogupay-payout-api/fiat-callbacks/get-fiat-otc.md): This endpoint retrieves the details of a fiat otc transactions for specific customer. - [Get Fiat Deposits](https://yogupay.gitbook.io/yogupay-payout-api/fiat-callbacks/get-fiat-deposits.md): This endpoint retrieves the details of a fiat deposits for a specific user. - [Payout Methods ](https://yogupay.gitbook.io/yogupay-payout-api/payout-methods/payout-methods.md): This guide provides valuable insights into Payment Methods, SLAs and Transactions Minimum and Maximum Limits for various countries. - [Africa](https://yogupay.gitbook.io/yogupay-payout-api/payout-methods/payout-methods/africa.md): This guide provides a comprehensive list of Payment Methods, SLAs and Transaction Limits around Africa - [🌏 Asia](https://yogupay.gitbook.io/yogupay-payout-api/payout-methods/payout-methods/asia.md): This guide provides a comprehensive list of Payment Methods, SLAs and Transaction Limits around Asia - [LATAM](https://yogupay.gitbook.io/yogupay-payout-api/payout-methods/payout-methods/latam.md): This guide provides a comprehensive list of payout methods, service level agreements (SLAs), and transaction limits for Latin America (LATAM) - [Wallets](https://yogupay.gitbook.io/yogupay-payout-api/wallets.md): This Collection enables you to programmatically create and transact with blockchain wallets. - [Create Wallet](https://yogupay.gitbook.io/yogupay-payout-api/wallets/create-wallet.md): This guide helps in generating a new wallet address for a specific asset and network. - [Fetch Wallets](https://yogupay.gitbook.io/yogupay-payout-api/wallets/fetch-wallets.md): This guide is for retrieving all wallets linked to your account - [Get Wallet Balance](https://yogupay.gitbook.io/yogupay-payout-api/wallets/get-wallet-balance.md): This guide is for retrieving all wallets linked to your account - [Add External Address](https://yogupay.gitbook.io/yogupay-payout-api/wallets/add-external-address.md): This endpoint adds an external address for a user's crypto wallet. - [Withdrawals](https://yogupay.gitbook.io/yogupay-payout-api/withdrawals.md) - [Create Withdrawal](https://yogupay.gitbook.io/yogupay-payout-api/withdrawals/create-withdrawal.md): This guide is used for sending cryptocurrency from your wallet to an external blockchain address - [Fetch Crypto Withdrawals](https://yogupay.gitbook.io/yogupay-payout-api/withdrawals/fetch-crypto-withdrawals.md): This endpoint retrieves Crypto withdrawals of a specific user . - [Fetch Withdrawals by Address](https://yogupay.gitbook.io/yogupay-payout-api/withdrawals/fetch-withdrawals-by-address.md): This endpoint retrieves the details of a specific Crypto withdrawal using the sender address - [Deposits](https://yogupay.gitbook.io/yogupay-payout-api/deposits.md) - [Deposit Crypto](https://yogupay.gitbook.io/yogupay-payout-api/deposits/deposit-crypto.md): This guide is for getting deposit address details for receiving cryptocurrency on a supported network - [Fetch Crypto Deposits](https://yogupay.gitbook.io/yogupay-payout-api/deposits/fetch-crypto-deposits.md): This endpoint retrieves the Crypto deposits of a specific user . - [Fetch Crypto Deposits by Address](https://yogupay.gitbook.io/yogupay-payout-api/deposits/fetch-crypto-deposits-by-address.md): This endpoint retrieves the Crypto deposits of a specific Address. - [Webhooks](https://yogupay.gitbook.io/yogupay-payout-api/webhooks.md): When initiating a transaction, you provide a callback URL in the payload, we use this to notify you of the transaction status. - [Webhooks](https://yogupay.gitbook.io/yogupay-payout-api/webhooks/webhooks.md): When initiating a transaction, you provide a callback URL in the payload, we use this to notify you of the transaction status. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://yogupay.gitbook.io/yogupay-payout-api/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.