​
Introduction to Edge API

​
Overview

Edge is the financial infrastructure platform, designed to ride on the bank’s core infrastructure and empower businesses of all sizes to extend financial services to their end customers. By leveraging Edge’s robust set of APIs, you can seamlessly integrate financial services into your applications, enabling automation, innovation, and enhanced customer experiences. Whether you’re a seasoned developer or new to APIs, this guide will walk you through everything you need to start working with Edge. From setting up your account to making your first API call, you’ll find the information necessary to leverage the full potential of Edge’s capabilities.

​
Target Audience

This guide is intended for developers, technical architects, and anyone who needs to integrate Edge’s functionalities into their applications or services. A basic understanding of RESTful APIs, JSON, and programming concepts is recommended to follow along with this guide.

​
Prerequisites

Before you begin using the Edge API, ensure you have the following:

Sign Up for an Edge Account

You need to sign up for an Edge account. If you don’t have one, you can create an account here.

Get Your API Key

To authenticate your API requests, you’ll need an API key, which can be generated from your Edge Dashboard. Get your Key here

Development Environment

Basic tools like a code editor, terminal, and an HTTP client (such as Postman or cURL) will be helpful.

​
Guide Structure

To help you navigate the Edge API effectively, this guide is structured into the following sections:

Introduction

Understand what Edge is and how it can empower your business to extend banking services through its API Banking platform.

Getting Started

Learn how to access the Edge API, authenticate your requests, and make your first API call.

Authentication

Understand the key concepts, request-response patterns, and error handling mechanisms to effectively work with the Edge API.

Data Encryption

Understand the key concepts, request-response patterns, and error handling mechanisms to effectively work with the Edge API.

Environment

Idempotency ensures that repeated API requests have the same effect as a single request, preventing unintended duplicate actions.

Response Code

Response codes indicate the outcome of API requests, helping you understand and handle different transaction statuses effectively

Webhook

Webhooks allow your application to receive real-time notifications from Edge for specific events, enabling automated workflows.

Indemptoency

Understand the key concepts, request-response patterns, and error handling mechanisms to effectively work with the Edge API.

​
Going Live

Prepare for production by understanding documentation & compliance, security, governance, and both pre- and post-go-live checklists.

Documentation & Compliance

Ensure your integration complies with regulatory requirements and best practices as you prepare to go live with Edge.

Security and Governance

Learn how to secure your API interactions and manage data governance effectively.

Pre Go-Live & Checklists

Review the necessary steps and checklists to ensure your API integration is ready for production.

Post Go-Live

Understand ongoing responsibilities and best practices after going live with Edge.

​
Edge Products

Explore the range of products available through Edge, including KYC and Collections, to enhance your integration.

KYC

Implement KYC processes seamlessly using Edge’s APIs to ensure regulatory compliance and customer verification.

Collections

Utilize Edge’s APIs for efficient and secure collections, automating the payment process for your business.

​
Important Details to Remember

  • API Usage: Familiarize yourself with how to use your API credentials to make authenticated requests.
  • Compliance: Ensure your use of the API complies with our guidelines and terms of service to prevent any interruptions or restrictions.

​
Summary

Setting up your EDGE API access involves a clear process from account registration to obtaining your API credentials. By following these steps and utilizing the resources provided, you will be well-prepared to integrate and utilize the EDGE API effectively in your applications.