API Key Auth

Get Banks

Endpoint for retrieving banks available for processing transfers to and their respective bank codes.

x-api-key

Embedly API Documentation

API Reference

Get Started

Join The Community

Welcome to the Embedly API documentation. Let's get started by making Embedly yours.

Introduction

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.

Onboarding

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.

Authentication

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 you through the purpose of each environment, how to use them effectively, and best practices for transitioning from testing to live operations.

Environment

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.

Response Codes

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.

Webhook

Prepare your application to go live on Embedly. Follow these pre-going live activities to ensure a smooth transition from staging to production.

Going Live on Embedly

Follow this checklist to complete your onboarding on Embedly, from signing up to linking your corporate bank account.

Onboarding Checklist

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.

Security

Get started with the Embedly API and explore detailed endpoint documentation with interactive playgrounds.

Overview

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 (KYC) procedures.

This endpoint enables you to create a customer profile

Create Customer

This endpoint retrieves customer  using their unique identifier

Get Customer by ID

This endpoint enables you to retrieve all customers you have successfully created.

Get All Customers

This endpoint is used to update a customer's name

Update Customer Name

The Product API serves as a comprehensive solution for managing product information, enabling users to add, update, delete, and retrieve products effectively. This API ensures that product data is always current and accessible.

The endpoint allows you to to create a new product.

Create new product

The endpoint allows you to retrieve a list of products.

List of all products

The endpoint allows you to update an existing product..

Update existing Product

The endpoint allows you to activate a product by its ID.

Activate Product by its ID

The endpoint allows you to deactivate a product by its ID.

Deactivate Product by its ID

The ProductLimit API defines and manages transaction limits associated with products, allowing organizations to set and update limits based on customer and currency. This API helps ensure compliance and effective risk management.

The endpoint allows you to retrieve limits for a specific product and currency.

Retrieve Limit of a product and Currency

The endpoint allows you to retrieve limits for a specific product and currency for a given customer.

Limit for Customer

The endpoint allows you to retrieve the default transaction limits

Default transaction limits

The endpoint allows you to to add limits for a specific customer.

Limit Customer

The endpoint allows you to update default transaction limits..

Update default transaction limit

The endpoint allows you to update an existing product limit

Add Limit to existing Product

The endpoint allows you to add limits for a specific customer.

Customer Limit

The Wallet Service provides organizations with a seamless and efficient solution for creating and managing customer wallets.

Wallet Overview

The endpoint is designed to create a new wallet for a customer.

Create Wallet

The endpoint displays the transaction history for a specific wallet using the walletId over a specified time range.

Wallet History

The endpoint allows you to close a specified wallet using the account number and associated details.

Close Wallet

The endpoint allows you to retrieves the details of a specific wallet associated with a customer.

Retrieve Wallet Detail

The endpoint allows you to reverse a specified wallet transaction.

Reverse Transaction

The endpoint facilitates transferring funds from one embedly wallet to another embedly wallet.

Wallet to Wallet Transfers

The endpoint restricts a specified wallet based on the account ID and restriction type.

Restrict by AccountID

The endpoint restricts a specified wallet by updating its details.

Restrict Wallet

The Wallet Group API facilitates the organization of multiple wallets into groups, allowing for better management and oversight. This API supports the creation and modification of wallet groups to enhance user experience.

The endpoint allows you to create a new wallet group.

Add WalletGroup

The endpoint allows you to add a wallet to a specified wallet group.

Add Wallet to WalletGroup

The endpoint allows you to add a feature to a specified wallet group.

Add WalletGroup Feature

The endpoint retrieves a list of available WalletGroup features..

WalletGroup Feature

The endpoint allows you to retrieves details of a specified wallet group using its ID.

WalletGroup ID

The endpoint retrieves a list of all wallet groups.

Get WalletGroup

Enable your customer transfer funds to any nigerian financial institution.

Payout

Endpoint for validating external bank accounts.

Bank Account Name Enquiry

This endpoint initiates a bank funds transfer.

Inter Bank Transfer

Endpoint for re-querying the status of a transaction using its reference number.