Overview
The Rolla Developer API enables you to programmatically manage payouts and retrieve transaction data. Use it to automate vendor payments, salary disbursements, and other financial operations.
Base URL: https://api.rolla.xyz/api/v1/external
Authentication
All API endpoints require authentication using an API key. Include your API key in the X-API-Key header with every request.
curl -X GET "https://api.rolla.xyz/api/v1/external/banks" \
-H "X-API-Key: your_api_key_here"
Keep your API key secure. Do not expose it in client-side code or public repositories.
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.
All responses follow a consistent JSON structure:
{
"status": true,
"message": "Description of the result",
"data": { ... }
}
Error Responses
When an error occurs, the response will include status: false and a descriptive error message:
{
"status": false,
"message": "Invalid or inactive API key"
}
Rate Limiting
API requests are rate-limited to ensure fair usage. If you exceed the limit, you’ll receive a 429 Too Many Requests response.
Available Endpoints
| Endpoint | Method | Description |
|---|
/banks | GET | List Nigerian banks |
/lookup | POST | Validate bank account |
/payouts | POST | Initiate a payout |
/transactions | GET | Retrieve transactions |
