Skip to main content

Prerequisites

1

Get your API key

Sign up at dashboard.plexospay.com and create a test API key. Your test key starts with sk_test_.
2

Make your first payment

Run this cURL command to create a payment:
curl -X POST https://api.plexospay.com/v1/payments \
  -H "Authorization: Bearer sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10000,
    "operator": "MOCK",
    "operatorPhone": "+2389001234",
    "description": "My first payment"
  }'
Use the MOCK operator for testing. It simulates the full payment flow without real mobile money charges.
3

Check the response

You’ll receive a response like this:
{
  "id": "pi_abc123def456",
  "amount": "10000",
  "currency": "CVE",
  "feeAmount": "200",
  "netAmount": "9800",
  "operator": "MOCK",
  "operatorPhone": "+2389001234",
  "status": "CREATED",
  "description": "My first payment",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}
4

Confirm the payment (sandbox)

In sandbox mode, simulate the customer confirming:
curl -X POST https://api.plexospay.com/v1/payments/pi_abc123def456/confirm \
  -H "Authorization: Bearer sk_test_YOUR_API_KEY"
The payment status will change to DEBITED.

Or Use a Checkout Session

Create a shareable payment link instead of handling the flow yourself:
curl -X POST https://api.plexospay.com/v1/checkout/sessions \
  -H "Authorization: Bearer sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25000,
    "returnUrl": "https://myshop.com/thanks"
  }'
The response includes a url field — share it with the customer to complete payment.

Next Steps