API Reference

v2.0.0

NabooPay Payment Gateway API for West Africa. Manage transactions, payouts, and accounts via a single REST API.

Base URL

bash

https://api.naboopay.com

All API requests should be made to this base URL. You can change it in the "Try it" panel of any endpoint.

Authentication

All endpoints require a Bearer token in the Authorization header. You can generate your API key from the NabooPay dashboard.

bash

curl https://api.naboopay.com/api/v2/transactions \
  -H "Authorization: Bearer YOUR_API_KEY"

Header	Value
`Authorization`	`Bearer YOUR_API_KEY`

API Key Scopes

v2 API keys carry a scope that controls which endpoints they can access. Using a key with an insufficient scope returns 403 Forbidden. Generate keys with the appropriate scope from the NabooPay dashboard.

Scope	Allowed Operations
`checkout`	Create, read, delete transactions; process refunds
`read`	Read transactions, payouts, and accounts (no writes)
`write`	Create and delete transactions
`read_write`	Full read + write access to transactions
`payout`	Create and read payouts
`management`	Full account management, refunds, and administrative access

Rate Limiting

A sliding window algorithm enforces rate limits per API key. Exceeding any limit returns a 429 Too Many Requests response (payouts return 409 Conflict when the per-phone limit is hit).

Limit	Applies To	Response
100 requests / 60 s	All endpoints (per API key)	`429`
2 payouts / phone / 5 min	`POST /api/v2/payouts` — per recipient phone number	`409`
Read — `GET`	Any organization status (active or inactive)	—

Error Responses

All errors return a consistent JSON body with a human-readable message.

json

{
  "error": "Transaction not found"
}

v1 API is deprecated

The v1 API is no longer maintained and will not receive new features. Migrate to v2 for improved filtering, pagination, and the new Payouts API. View migration guide