Welcome

This is the authoritative guide to use Allawee API services. We provide guides for accessing the API, explanation of various terms used with the API, sample codes, and sample responses. The documentation is split into various sections that will be updated when changes are made.

You can also use the API Reference in addition to the documentation. A link to the Reference is at the bottom of the side navigation panel. You can consult to reference as you build on the Allawee API. It will be helpful if you already have an understanding of how to make requests to and consume RESTful APIs, although we include sample request and response codes in a few languages.

A summary of our documentation:

Authentication

The Authentication section will show you how to authentication your requests to make calls to the Allawee API. We use the token to confirm that the request is coming from you. This token can also affect your payments, so we include information on how to revoke your token if you suspect it is compromised and how to generate new tokens. This section also includes information on key scopes for your tokens.

Versioning

Breaking changes can be disruptive to your workflow, which is why we have a section dedicated to how we version our APIs. The section includes how we denote the version for endpoints, the kind of changes we think are breaking changes, and the kind of changes we believe are not breaking changes.

Common Data Types

There are some data types that occur often in our documentation and while using our API generally, such as dates, monetary values, loan types, and collateral types. In this section, we detail how you should work with these values. This will help you sync better with our API and sometimes will save you precious time.

Customers

The Customers API lets you Create a customer, Fetch customers, Update info on your customers and perform various actions on them.

Cards

This document provides an overview of how to customize your cards, the process for creating cards, and the different options you have for creating them.

Cards API

Our Cards API contains endpoints to get your list of cards, get a particular card, top up a card’s balance, freeze or unfreeze a card, and to terminate a card. You can call these endpoints from your own app. The Cards API section contains detailed instructions on how to work with it. It includes the endpoints, description of the values in the response, sample requests, and a sample response.

Card Program

The Card Programs API allows you to create, control, update and scale a commercial card program for your users.

Webhooks

The Webhooks API lets you listen for events and perform actions when those events occur.

Events

Events keep you informed about significant happenings in your account.

Accounts

Every card has an account that stores its funds, and Naira accounts can get money from other banks through NIP.

Simulation

This Simulation endpoints allows you make various card requests such as Create Card Authotization, Go live, Authorization Request Check .

Testing

Our testing section gives you the information you need to test your app before using our API in production. While testing, you can work with the API to understand how it behaves and determine how to best integrate it into your app. This section includes how to get your test token, how to make test requests, and test values you can use to influence your results.

Error Handling

Handling errors is an important part of building software. Sometimes, the behaviour we get is not what we expect. This is why we take error handling seriously and try to give you as much information as we can to help you work around errors. Calls to our API return status codes and messages. Our Error Handling section includes the different status codes and error messages and what they mean. We also provide debugging information for common errors, their causes, and their fixes.

Last updated Aug. 01, 2023

Next Up: Quickstart