Quick Start

curl -X POST "{{BASE_URL}}/api/v1/payments" \
  -H "X-Public-Key: YOUR_PUBLIC_KEY" \
  -H "X-Timestamp: UNIX_TIMESTAMP" \
  -H "X-Signature: HMAC_SHA256_SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000,
    "currency": "XAF",
    "payer_phone": "677001122",
    "external_id": "order_10001",
    "metadata": {
      "description": "Premium subscription"
    }
  }'

If operator_code is omitted, the backend may auto-detect it from the payer phone number when possible.

Example Response

Payment Response

{
  "data": {
    "id": "01HR...",
    "amount": 1000,
    "currency": "XAF",
    "type": "PAYIN",
    "track_id": "TRX_01HR...",
    "status": "PENDING",
    "operator_code": "MTN_CM",
    "payer_phone": "677001122",
    "metadata": {
      "description": "Premium subscription"
    },
    "created_at": "2026-04-01T10:00:00Z"
  }
}

Step 3: Check the Payment Status

Fetch Latest Payment Status

curl -X GET "{{BASE_URL}}/api/v1/payments/status/TRX_01HR..." \
  -H "X-Public-Key: YOUR_PUBLIC_KEY" \
  -H "X-Timestamp: UNIX_TIMESTAMP" \
  -H "X-Signature: HMAC_SHA256_SIGNATURE"

Typical fields returned here include:

transaction_id

track_id

status

provider_status

amount

currency

updated_at

Step 4: Configure a Webhook Endpoint

Do not rely only on polling once you move beyond initial tests.

Open the Webhooks page from the dashboard.

Provisioning by API is still available for infrastructure or internal tooling:

Create a Webhook Endpoint

curl -X POST "{{BASE_URL}}/api/v1/webhook-endpoints" \
  -H "X-Public-Key: YOUR_PUBLIC_KEY" \
  -H "X-Timestamp: UNIX_TIMESTAMP" \
  -H "X-Signature: HMAC_SHA256_SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production backend",
    "target_url": "https://merchant.example.com/webhooks/genuka",
    "events": ["transaction.success", "transaction.failed"],
    "is_active": true
  }'

Production recommendation

In production, treat webhook delivery as the source of truth for final status changes, and use status polling only as a recovery or reconciliation mechanism.