Getting Started

Introduction

Slimpay's REST API gives you programmatic access to everything the Slimpay wallet app does — funding and transfers, airtime and data, electricity and cable TV, school fee collection, the billers marketplace, payment links, and virtual meters. It's the same API that powers the official Slimpay mobile app, so every endpoint documented here is exercised in production.

Base URL

All requests are made to:

https://app.slimpay.ng/api/v1

Getting access

There's no separate developer account or approval process — every Slimpay wallet is an API-ready account. Register via POST /auth/register (see Authentication) and start calling authenticated endpoints with the token you get back immediately.

How it fits together

A Slimpay account has one wallet, backed by a dedicated virtual bank account number. Users fund that account via bank transfer, and the balance can be spent on bills, transfers, and collections, or withdrawn to any Nigerian bank.

Three groups of endpoints sit on top of the wallet:

Bills & utilities — airtime, data, electricity, and cable TV, debited from the wallet.
Collection surfaces — schools, the billers marketplace, and payment links. These move money into a school/biller/link owner's wallet via a hosted checkout, not a direct wallet debit.
Account & identity — auth, profile, PIN, and NIN verification, which gates wallet funding.

Request format

Send request bodies as application/json unless otherwise noted. Every response is JSON, with a consistent envelope:

json

{
  "status": true,
  "message": "Optional human-readable message",
  "data": { }
}

status is a boolean, not an HTTP status code repeated — always check it in addition to the HTTP status when handling a response.

Next steps

Head to Authentication to register a test account and get a bearer token.
Check Identity Verification early — a wallet can't fund, transfer, or spend until NIN verification completes.

Authentication