Overview
The Rolla Developer API enables you to programmatically manage wallets and retrieve transaction data. Use it to automate financial operations across multiple currencies.Amounts: Unless a route documents otherwise, numeric
amount fields use each currency’s smallest unit — NGN kobo (like the quickstart withdrawal), USD US cents (100 = $1.00 USD), etc.https://api.rolla.xyz/api/v1/external
Authentication
All API endpoints require authentication using an API key. Include your API key in theX-API-Key header with every request.
Obtaining an API Key
API keys can be generated from your Rolla Dashboard. Navigate to Settings → API Keys to create and manage your keys.IP Whitelisting
For enhanced security, you can optionally whitelist specific IP addresses for your API key. When enabled, requests from non-whitelisted IPs will be rejected.Acting on a tenant account (X-Account-Id)
If your business is a Rolla white-label tenant, a single API key can act on any account inside your tenancy — your own account, or any account you’ve onboarded under it. Add the optional X-Account-Id header naming the target account, and the entire request is scoped to that account: onboarding, documents, wallets, funding instructions, payouts, beneficiaries — everything runs as that account.
| Behaviour | Result |
|---|---|
| Header omitted | The request acts as your own (the API key’s) account — standard behaviour. |
| Header set to an account in your tenancy | The request is scoped to that account. |
| Header set, but your key isn’t a tenant key | 403 — X-Account-Id is only available to tenant API keys. |
| Header naming an account outside your tenancy | 404 — Account not found in your tenancy. |
Accounts you create with a tenant API key (via
POST /accounts) are automatically added to your tenancy, so you can immediately address them with X-Account-Id afterwards. Accounts that onboard themselves through your white-label app are part of your tenancy too.Response Format
All responses follow a consistent JSON structure:Error Responses
When an error occurs, the response will includestatus: false and a descriptive error message:
Rate Limiting
API requests are rate-limited to ensure fair usage. If you exceed the limit, you’ll receive a429 Too Many Requests response.
Available Endpoints
| Endpoint | Method | Description |
|---|---|---|
/banks | GET | List Nigerian banks |
/lookup | POST | Validate bank account |
/transactions | GET | Retrieve transactions |
/accounts | POST / GET | Onboard and manage additional business or individual accounts |