Base URL & Resources

The Peex Platform currently exposes four main resources for handling payments, verification, and account management.

Base URL

All API requests should be made to the following base URL:

https://sandbox.peexit.com/api/v1/

For production (when available):

https://server.peexit.com/api/v1/

Available Resources

The platform currently provides the following main resources:

1. Partner Information

Retrieve information about your account in the Peex system, including balance and applicable fees.

• Endpoint: GET /clients/me
• Purpose: Account management and balance checking

2. Phone Verification

Verify that mobile phone numbers are valid before processing payments.

• Endpoint: POST /clients/verify_phoneNumber
• Purpose: Phone number validation

3. Payment Request (Mobile Money)

Request payments to Peex users via mobile phone numbers.

• Endpoint: POST /clients/request_payment
• Purpose: Mobile money transactions

4. Bank Payment Request

Request payments to bank accounts using bank details.

• Endpoint: POST /clients/request_bank_payment
• Purpose: Bank transfer transactions

5. Transaction Management

Retrieve all payment requests for your account.

• Endpoint: GET /clients/all_requests
• Purpose: Transaction history and tracking

Remittance API

Here's a complete overview of all available endpoints:

Response Format

All API responses follow a consistent JSON format:

Success Response (200)

{
  "request": {
    "id": 189213,
    "amount": 1,
    "status": "paid",
    "from_currency": "XAF",
    "to_currency": "XAF",
    "created_at": "2025-08-05T09:08:36.818Z",
    "updated_at": "2025-08-05T09:08:36.820Z",
    "payment_proof": null,
    "identifier_by": "+237699990699",
    "track_id": "test-api1",
    "type": "mobile",
    "payment_proof_image": "/images/missing.png"
    }
}

Error Response (4xx/5xx)

{
  "error": {
    "statusCode": Error code,
    "name": "Error name",
    "message": "Detailed error message"
  }
}

Common Status Codes

• 200 OK - Request successful
• 401 Unauthorized - Invalid secret key
• 404 Not Found - Resource not found (e.g., user not in Peex platform)
• 422 Unprocessable Entity - Invalid request parameters (e.g., aml_cft not set to true)

Next Steps

Now that you understand the available resources, you can start integrating with the API:

Need Help?

If you need assistance with API integration or have questions about specific endpoints:

• Contact support for sandbox access
• Request credentials via email
• Test all endpoints in the sandbox environment first

Remember: In the development environment, all payment amounts are fixed at 10 FCFA regardless of the amount specified in your request.