# Embedly API Documentation

## Docs

- [Wallet Overview](https://developer.embedly.ng/api-reference/Wallet.md): The Wallet Service provides organizations with a seamless and efficient solution for creating and managing customer wallets.
- [Overview](https://developer.embedly.ng/api-reference/authentication.md): Get started with the Embedly API and explore detailed endpoint documentation with interactive playgrounds.
- [Cards](https://developer.embedly.ng/api-reference/cards.md)
- [Checkout](https://developer.embedly.ng/api-reference/checkout.md): Generate a temporary wallet to receive one-time payments from your customers.
- [Overview](https://developer.embedly.ng/api-reference/customers.md): The Customer Service offers a comprehensive solution for merchants to efficiently manage their customer relationships. This service is designed to enhance the customer onboarding process, provide seamless wallet creation, and ensure compliance with regulatory requirements through Know Your Customer…
- [Payout](https://developer.embedly.ng/api-reference/payout.md): Enable your customer transfer funds to any nigerian financial institution.
- [Create Corporate Customer Wallet](https://developer.embedly.ng/api-reference/playground/Wallet/Add_Corporate_wallet.md): This endpoint enables you to create a wallet for a corporate customer
- [Create Wallet](https://developer.embedly.ng/api-reference/playground/Wallet/Add_Wallet.md): The endpoint is designed to create a new wallet for a customer.
- [Get Wallet History by Wallet ID](https://developer.embedly.ng/api-reference/playground/Wallet/Get_Wallet_History.md): The endpoint displays the transaction history for a specific wallet using the walletId over a specified time range.
- [Get Wallet History by Account Number](https://developer.embedly.ng/api-reference/playground/Wallet/Get_Wallet_History_by_Account.md): The endpoint displays the transaction history for a specific wallet using the account number over a specified time range.
- [Get Wallet By Customer ID](https://developer.embedly.ng/api-reference/playground/Wallet/Get_Wallet_List.md): The endpoint retrieves the details of a specific wallet using its associated account number..
- [Get Wallet by Wallet Account Number](https://developer.embedly.ng/api-reference/playground/Wallet/Get_Wallet_by_Account.md): The endpoint retrieves the details of a specific wallet using its associated account number..
- [Get Wallet by Wallet ID](https://developer.embedly.ng/api-reference/playground/Wallet/Get_Wallet_by_Id.md): The endpoint retrieves the details of a specific wallet using its unique wallet ID.
- [Simulate Inflow (Staging)](https://developer.embedly.ng/api-reference/playground/Wallet/Inflow.md): This endpoint is available only on the staging environment and exists solely to help you fund your staging accounts for testing. It is not available in production. An Inflow transaction refers to a transfer from an account outside your organization into an account within your organization. In produc…
- [Wallet to Wallet Transfers](https://developer.embedly.ng/api-reference/playground/Wallet/Wallet_to_Wallet.md): This endpoint enables fund transfers between wallets within the same organization profile.
- [Get Wallet to Wallet Transfer Status](https://developer.embedly.ng/api-reference/playground/Wallet/get_wallet_transactions_status.md): The endpoint facilitates requerying transfer requests between emedly wallets.
- [Retrieve Currencies](https://developer.embedly.ng/api-reference/playground/Wallet/utils/get_currency.md): The endpoint retrieves a list of available currencies on the Embedly platform.
- [Retrieve Wallet Restriction Types](https://developer.embedly.ng/api-reference/playground/Wallet/utils/get_restriction_types.md): The endpoint retrieves a list of pre-configured wallet restriction types on the Embedly platform.
- [Simulate Debit Card Transaction (staging)](https://developer.embedly.ng/api-reference/playground/cards/afrigo/Simulate_Debit_Card_Trx.md): This endpoint is available only on the staging environment and exists solely to help you simulate debit card transactions your staging accounts for testing. It is not available in production. In production environment, this is similar to your user making use of their debit card to make purchases eit…
- [Activate Afrigo Card](https://developer.embedly.ng/api-reference/playground/cards/afrigo/activate_card.md): This endpoint is to be used in activating an afrigo card issued to a customer.
- [Reset Card Pin](https://developer.embedly.ng/api-reference/playground/cards/afrigo/reset_card_pin.md): The endpoint enables you to reset card pins
- [Activate a Split Beneficiary](https://developer.embedly.ng/api-reference/playground/checkout/SplitCheckout/activate_a_split_beneficiary.md): Activates a split beneficiary for the authenticated organization. Organization API key required.
- [Create Split Beneficiary](https://developer.embedly.ng/api-reference/playground/checkout/SplitCheckout/create_split_beneficiary.md): This endpoint generates a new checkout split beneficiary for an organization. Organization must be active and have configured primary and secondary prefixes.
- [Deactivate a Split Beneficiary](https://developer.embedly.ng/api-reference/playground/checkout/SplitCheckout/deactivate_a_split_beneficiary.md): Activates a split beneficiary for the authenticated organization. Organization API key required.
- [Get all split beneficiaries](https://developer.embedly.ng/api-reference/playground/checkout/SplitCheckout/get_split_beneficiaries.md): Retrieves all split beneficiaries for the authenticated organization with optional filters for active status and search term. Supports pagination. Organization API key required.
- [Create Checkout Wallet](https://developer.embedly.ng/api-reference/playground/checkout/create_checkout_wallet.md): This endpoint generates a new checkout wallet for an organization. Organization must be active and have configured primary and secondary prefixes.
- [Get checkout wallet transactions](https://developer.embedly.ng/api-reference/playground/checkout/get_checkout_txns_by_walletId.md): Endpoint for getting all checkout wallets under an organization using the Organization Id
- [Get checkout wallets](https://developer.embedly.ng/api-reference/playground/checkout/get_checkout_wallet.md): Endpoint for getting all checkout wallets under an organization using the Organization Id
- [Get Organization Prefix Mappings](https://developer.embedly.ng/api-reference/playground/checkout/get_org_prefix_mappings.md): Retrieves all paginated organization prefix mappings for the specified organization. Supports search by secondary prefix, alias, organization name, or primary prefix code. Admin access required.
- [Add Director to Corporate Customer](https://developer.embedly.ng/api-reference/playground/customer/corporate/add_director.md): This endpoint enables you to add directors to a corporate customer profile
- [Upload Corporate Customer Documents](https://developer.embedly.ng/api-reference/playground/customer/corporate/add_documents.md): This endpoint enables you to upload documents for a corporate customer
- [Get A Corporate Customer](https://developer.embedly.ng/api-reference/playground/customer/corporate/get_customer.md): This endpoint enables you to retrieve details of a corporate customer
- [Get A Corporate Customer Director](https://developer.embedly.ng/api-reference/playground/customer/corporate/get_director.md): This endpoint enables you to create a corporate customer profile
- [Get All Corporate Customer Directors](https://developer.embedly.ng/api-reference/playground/customer/corporate/get_directors.md): This endpoint enables you to retrieve all directors of. a corporate customer
- [Get Corporate Customer Documents](https://developer.embedly.ng/api-reference/playground/customer/corporate/get_documents.md): This endpoint enables you to retrieve documents for a corporate customer
- [Create Corporate Customer](https://developer.embedly.ng/api-reference/playground/customer/corporate/profile_customer.md): This endpoint enables you to create a corporate customer profile
- [Update Corporate Customer](https://developer.embedly.ng/api-reference/playground/customer/corporate/update_customer.md): This endpoint enables you to update a corporate customer profile
- [Update Corporate Customer Director](https://developer.embedly.ng/api-reference/playground/customer/corporate/update_director.md): This endpoint enables you to update a corporate customer director details
- [Update Corporate Customer Documents](https://developer.embedly.ng/api-reference/playground/customer/corporate/update_documents.md): This endpoint enables you to update documents for a corporate customer
- [Get Customer by ID](https://developer.embedly.ng/api-reference/playground/customer/individual/Get_Id.md): This endpoint retrieves customer  using their unique identifier
- [Get All Customers](https://developer.embedly.ng/api-reference/playground/customer/individual/get_all_customers.md): This endpoint enables you to retrieve all customers you have successfully created.
- [Get Customer KYC Property Status](https://developer.embedly.ng/api-reference/playground/customer/individual/get_customer_kyc_status.md): This endpoint enables you see the status a customer's kyc properties - **bvn, nin and address**
- [Customer KYC Upgrade - Address Verification](https://developer.embedly.ng/api-reference/playground/customer/individual/kyc/address_verification.md): This endpoint enables you to complete address verification for customer in order to upgrade the customer's KYC to Tier 3
- [Customer KYC Upgrade - Address Verification (V2)](https://developer.embedly.ng/api-reference/playground/customer/individual/kyc/address_verification_v2.md): This endpoint enables you to complete address verification for customer in order to upgrade the customer's KYC to Tier 3
- [Customer KYC Upgrade - BVN](https://developer.embedly.ng/api-reference/playground/customer/individual/kyc/bvn.md): This endpoint enables you to upgrade a customer's KYC using bvn
- [Customer KYC Upgrade - NIN](https://developer.embedly.ng/api-reference/playground/customer/individual/kyc/nin.md): This endpoint enables you to upgrade a customer's KYC using nin
- [Create Customer](https://developer.embedly.ng/api-reference/playground/customer/individual/profile_customer.md): This endpoint enables you to create a customer profile.
- [Create Customer (v2)](https://developer.embedly.ng/api-reference/playground/customer/individual/profile_customer_v2.md): This endpoint enables you to create a customer profile.
- [Update Customer Name](https://developer.embedly.ng/api-reference/playground/customer/individual/update_customer.md): This endpoint is used to update a customer's name
- [Update Customer Contact](https://developer.embedly.ng/api-reference/playground/customer/individual/update_customer_contact.md): This endpoint is used to update a customer's contact details
- [Update Customer (v2)](https://developer.embedly.ng/api-reference/playground/customer/individual/update_customer_v2.md): This endpoint is used to update an existing customer's profile using the v2 API.
- [Get All Customer types](https://developer.embedly.ng/api-reference/playground/customer/utils/get_all_customer_types.md): This endpoint enables you to retrieve the Id of a specific customer.
- [Get Countries](https://developer.embedly.ng/api-reference/playground/customer/utils/get_countries.md): The endpoint allows you to retrieves the list and details of Countries.
- [Transaction Status Re-Query](https://developer.embedly.ng/api-reference/playground/payout/check_status.md): Endpoint for re-querying the status of an inter-bank transaction using its transaction reference.
- [Get Banks](https://developer.embedly.ng/api-reference/playground/payout/get_banks.md): Endpoint for retrieving banks available for processing transfers to and their respective bank codes.
- [Inter Bank Transfer](https://developer.embedly.ng/api-reference/playground/payout/interbank_transfer.md): This endpoint initiates a bank funds transfer from an Embedly wallet account within your organization, to an external bank account. (GTBank, OPAY, UBA, etc).
- [Bank Account Name Enquiry](https://developer.embedly.ng/api-reference/playground/payout/name_enquiry.md): Endpoint for validating external bank accounts.
- [Webhooks](https://developer.embedly.ng/api-reference/webhooks.md)
- [Authentication](https://developer.embedly.ng/home/authentication.md): To interact with the Embedly API, you’ll need to authenticate your requests using an apikey. This key is essential for accessing the API securely and ensuring that your requests are authorized.
- [Environment](https://developer.embedly.ng/home/environments.md): When integrating with the Embedly API, understanding the different environments available is crucial for smooth development and deployment. Embedly provides two distinct environments—**Staging** and **Production**—each tailored for specific stages of your integration process. This guide will walk yo…
- [Introduction](https://developer.embedly.ng/home/introduction.md): Welcome to the Embedly API documentation. Let's get started by making Embedly yours.
- [Onboarding Checklist](https://developer.embedly.ng/home/live/checklist.md): Follow this checklist to complete your onboarding on Embedly, from signing up to linking your corporate bank account.
- [Going Live on Embedly](https://developer.embedly.ng/home/live/going-live.md): Prepare your application to go live on Embedly. Follow these pre-going live activities to ensure a smooth transition from staging to production.
- [Security](https://developer.embedly.ng/home/live/security.md): Security is critical when integrating with Embedly, ensuring that your data and the data of your users are protected at every step. Follow these security guidelines and best practices to safeguard your integration and maintain a secure connection with Embedly.
- [Onboarding](https://developer.embedly.ng/home/onboarding.md): Get started with Embedly—your all-in-one API Banking platform. Follow these steps to quickly set up your account and start integrating financial services into your business.
- [Response Codes](https://developer.embedly.ng/home/response.md): When working with the Embedly API, you will encounter various response codes that indicate the outcome of your requests. These codes follow the ISO 8583 standard, commonly used in financial transactions. Understanding these codes is essential for handling API responses effectively.
- [Webhook](https://developer.embedly.ng/home/webhook.md): Webhooks are a powerful feature that allows your application to receive real-time notifications about specific events that occur within the Embedly platform. By setting up webhooks, you can automate processes, update records, and trigger workflows in your application as soon as an event happens.

## OpenAPI Specs

- [package](https://developer.embedly.ng/package.json)
- [package-lock](https://developer.embedly.ng/package-lock.json)
- [mint_](https://developer.embedly.ng/mint_.json)
- [settings](https://developer.embedly.ng/.vscode/settings.json)
- [extensions](https://developer.embedly.ng/.vscode/extensions.json)