Payments Overview

X-Pay provides a unified API to accept payments through multiple channels including Mobile Money, bank transfers, and card payments.

Payment Flow

Payment Object

Every payment in X-Pay has the following structure:

{
  "id": "pay_abc123xyz",
  "amount": 5000,
  "currency": "RWF",
  "status": "completed",
  "payment_method": "mobile_money",
  "description": "Order #1234",
  "customer_email": "customer@example.com",
  "metadata": {
    "order_id": "1234",
    "product": "Premium Plan"
  },
  "created_at": "2025-01-01T10:00:00Z",
  "updated_at": "2025-01-01T10:00:30Z"
}

Payment Statuses

Status	Description
pending	Payment initiated, awaiting customer action
processing	Payment is being processed by provider
completed	Payment successful
failed	Payment failed
cancelled	Payment cancelled by customer/merchant
refunded	Payment has been refunded

Supported Payment Methods

Method	Countries	Currencies
MTN Mobile Money	Rwanda, Uganda, Ghana	RWF, UGX, GHS
Airtel Money	Rwanda, Uganda, Kenya	RWF, UGX, KES
Bank Transfer	Rwanda	RWF
Card Payments	Global	USD, EUR, GBP

Quick Example

curl -X POST https://server.xpay-bits.com/v1/payments \
  -H "Authorization: Bearer sk_sandbox_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10000,
    "currency": "RWF",
    "payment_method": "mobile_money",
    "phone_number": "+250788123456",
    "description": "Monthly subscription"
  }'

Next Steps

• Create a Payment - Detailed payment creation guide
• Payment Methods - All supported payment methods
• Mobile Money - Mobile Money integration guide