Skip to main content

JPay Africa API Documentation

Welcome to the JPay Africa API documentation. This guide provides comprehensive information about integrating with our payment gateway APIs.

Overview​

JPay Africa provides a robust payment processing platform that enables merchants and third-party applications to:

  • Initiate Collections: Accept payments from customers
  • Initiate Payouts: Send payments to beneficiaries
  • Manage Transactions: Track and retrieve transaction history
  • Authenticate Securely: Secure app-based authentication

API Base URL​

https://sandbox.api.jpay.africa/api/v1

Key Features​

🔐 Secure Authentication​

  • JWT-based token authentication
  • App key/secret authentication for third-party apps
  • Role-based access control (Merchant/Operator)

💳 Payment Processing​

  • Collections API for receiving payments
  • Payouts API for sending payments
  • Real-time transaction status tracking

📊 Transaction Management​

  • Comprehensive transaction history
  • Advanced filtering and search
  • Pagination support for large datasets

✅ Robust Error Handling​

  • Clear error messages and codes
  • Detailed validation feedback
  • Standard HTTP status codes

Getting Started​

To get started with the JPay Africa API:

  1. Create an App - Register your application
  2. Authenticate - Get your API tokens
  3. Make Your First Request - Initiate a payment
  4. Handle Responses - Understand responses and errors

Support​

For support and questions:

Rate Limits​

API requests are rate-limited to ensure fair usage:

  • Requests per minute: 60
  • Burst limit: 100

If you exceed the rate limit, you'll receive a 429 Too Many Requests response.

Versioning​

The current API version is v1. We maintain backward compatibility, but breaking changes will be announced with adequate notice.

SDKs and Libraries​

SDKs and client libraries are coming soon for popular programming languages:

  • Python
  • JavaScript/TypeScript
  • PHP
  • Ruby
  • Go

Check back soon or contact support to request an SDK for your language.