Abstract

Base URL & Versioning

The current version (1.0) of our API is available at the below path, all your request make sure that all your requests are sent to this base URL

https://integration.getravenbank.com/v1/*

API Structure

Our API follows REST design principles, exposing a set of stateless endpoints to interact with resources.
Endpoint URIs are named after the resources they interact with:

General References

Using the Atlas API it's also important you get used to some terminologies made use of, the below article explains possible terms and their meaning.

📘

Collections

Collections allow businesses to generate virtual accounts and carry out payments and transactions.

📘

Virtual Accounts

Virtual Accounts are generated via the collections API and allows merchant and their customers to recieve and send money to any local and international bank account and financial institutions.

📘

Virtual Card

This is a collection of API that allows you to generate virtual naira or dollar credit card on behalf of your customers, this will allow your customers make payments online using the virtual card you provided

📘

Merchants

Merchants are businesses or institutions registered on the Raven Atlas Platform

📘

Customers

Customers are the merchant's own customers, behind this are a set of virtual accounts related to a particular business.

📘

Webhooks

Webhooks are a notification sent to businesses based on their API actions & events.