PeeX - Peers Exchange
Home/Resources/API Documentation
API Documentation

Integrate PeeX into your applications

Simple and powerful REST API to automate your payments and collections. Test in sandbox, deploy in production.

Base URL (Sandbox)

https://sandbox.peexit.com/api/v1/
quick-start.js
// Example: Create a Mobile Money collection
const response = await fetch('https://sandbox.peexit.com/api/v1/collection/request_payment', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'SECRETKEY': 'your-secret-key'
  },
  body: JSON.stringify({
    amount: 10, // In sandbox, the amount is fixed at 10 FCFA
    phone: '237XXXXXXXXX',
    operator: 'orange', // or 'mtn'
    reference: 'ORDER-123'
  })
});

const data = await response.json();
console.log(data);
Overview

Available APIs

Explore our APIs for payments, collections and more.

Remittance

Send payments to Mobile Money and banks

Collect

Collect payments via Mobile Money

Webhooks

Real-time transaction notifications

Reference

API Endpoints

Authentication

Authentication via SECRETKEY in HTTP headers

HeaderSECRETKEY: your-secret-keyAuthentication header

Remittance API

Send payments to Mobile Money and bank accounts

GET/remittance/mePartner info
POST/remittance/phone_verificationPhone verification
POST/remittance/request_paymentMobile Money payment
POST/remittance/bank_request_paymentBank payment
GET/remittance/all_requestsTransaction list

Collect API

Collect payments via Mobile Money

POST/collection/request_paymentCreate collection
GET/collection/all_requestsTransaction list
GET/collection/get_feesCalculate fees
GET/collection/mePartner account info

Reference

Formatting standards and status codes

DOCData FormattingFormatting guidelines
DOCTransaction StatusStatus codes
DOCError CodesError handling

Webhooks

Receive real-time notifications

POSTYour callback URLTransaction notification

Sandbox Note

The sandbox environment uses fixed amounts of 10 FCFA for testing. Production credentials are provided by email after your account is validated.

Request production access

Ready to integrate PeeX?

Check out our complete documentation to start the integration.