FastPay API Reference

Welcome to the comprehensive API documentation for FastPay, your payment aggregator platform for mobile money transactions across Africa.

Base URL

https://api.fastpay.tech

For testing and development:

https://sandbox-api.fastpay.tech

Authentication

All API requests require authentication using an API key in the X-API-Key header.

Authentication Header

Include your API key in every request:

X-API-Key: sk_test_your_api_key_here

Getting Your API Key

1. Log in to your merchant dashboard
2. Navigate to API Settings
3. Generate a new API key
4. Copy the key and store it securely (it will only be shown once)

Important: Keep your API key secure and never expose it in client-side code or public repositories.

API Endpoints Overview

Payments API

Accept and manage payment transactions through mobile money networks.

• Initialize Payment - Create a new payment transaction
• Initialize Direct Payment - Create a direct payment with mobile service
• Get Payments by Organization - Retrieve payments for an organization
• Get Payments by API Key - Retrieve payments for an API key
• Get Payment by Reference - Retrieve a specific payment by its unique reference

Transfers API

Send money to mobile wallets across supported networks.

• Initialize Transfer - Create a new transfer transaction
• Get All Transfers - Retrieve all transfers with pagination

Mobile Services API

Access information about available mobile payment services and their status.

• Get All Mobile Services - Retrieve all mobile services status

Request & Response Format

All API requests and responses use JSON format. Request bodies must include the Content-Type: application/json header.

Content-Type Header

Always include the following header in your requests:

Content-Type: application/json

Standard Response Structure

{
  "id": "transaction_id",
  "reference": "UNIQUE_REFERENCE",
  "amount": 1000,
  "status": "COMPLETE",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:35:00Z"
}

Error Response Structure

{
  "statusCode": 400,
  "message": "Error description or array of validation errors",
  "error": "Error Type"
}

HTTP Status Codes

The API uses standard HTTP status codes:

Rate Limiting

API requests are subject to rate limiting to ensure fair usage:

• Standard tier: 100 requests per minute per API key
• Rate limit headers: Each response includes X-RateLimit-Limit and X-RateLimit-Remaining headers

When the rate limit is exceeded, you will receive a 429 Too Many Requests response.

Webhooks

FastPay sends webhooks to notify your application of payment status changes. Configure webhook URLs in your merchant dashboard to receive real-time notifications.

Support

For support and questions:

• Documentation: Browse this documentation for detailed endpoint information
• Technical Support: Contact our developer support team at support@fastpay.tech
• Dashboard: Access your merchant dashboard at dashboard.fastpay.tech