Peex Platform API Documentation
This document provides a comprehensive overview of the PEEX API, designed to facilitate seamless integration between external systems and Peex for efficient data submission and processing.
Introduction
The Peex Platform API enables secure payment processing and transaction management for mobile money and bank transfers. Our REST API provides endpoints for phone verification, payment requests, transaction tracking, and real-time notifications.
Security
To access these resources, you will need to use an access token (SECRETKEY). These secret keys must be set in your HTTP request header. Your secret key will be sent by mail for the production environment.
SECRETKEY: 37528871-1f6c-43e9-a74a-0ad1f4baba76
Note: Just set it as an HTTP header when calling the API.
Resources
For now, the platform exposes four main resources:
Base URL: https://sandbox.peexit.com/api/v1/
- Partner Information - Retrieve your account balance and fees
- Phone Verification - Verify mobile phone numbers
- Payment Request - Process mobile money payments
- Bank Payment Request - Process bank transfers
- Transaction Management - Get all payment requests
Getting Started
The technical part of an integration is complete when all the following steps have been completed:
- Receive API documentation ✓
- Receive sandbox access - Contact support for access
- Perform sandbox testing - Test with provided credentials
- Receive production access - Get production credentials
- Perform production testing - Go live with real transactions
Important Note: In the development environment, the actual amount initiated for a payout or collect operation is fixed at 10 FCFA, regardless of the value provided in the request payload.