E

Exxari Developer Docsv1.0 Stable

Getting Started

Welcome to the Payment Gateway API. This guide will help you get up and running with our payment processing platform in just a few steps.

1

Sign Up on the Dashboard

Start by creating an account on our merchant dashboard. You'll need to provide your business information, contact details, and banking information for settlement.

Go to Dashboard

2

Generate Your API Keys

Once your account is set up, navigate to Settings → API Keys in the dashboard. Click "Generate New Key" to create your first API key. You'll be able to choose between:

•Sandbox Keys: For testing your integration
•Live Keys: For processing real payments

⚠️ Keep your API keys secure! Never share them publicly or commit them to version control.

3

Manage Multiple API Keys

You can generate multiple API keys for different purposes:

Different Applications

Generate separate keys for your web application, mobile app, and backend services for better organization and security.

Multiple Businesses

If you manage multiple businesses under the same account, generate dedicated API keys for each business. This keeps transactions organized and allows you to track revenue per business independently.

Separate Environments

Always use different keys for sandbox and production to prevent accidental charges during testing.

4

Start Integrating

Include your API key in the X-API-Key header for every API request. All requests must be made over HTTPS.

Here's a quick example:

curl -X POST https://api.gateway.com/v1/payments/card/initiate \ -H "X-API-Key: your_api_key_here" \ -H "Content-Type: application/json" \ -d '{ "amount": 5000, "currency": "GHS", "email": "customer@example.com" }'

🔐 Authentication Guide

For complete details on authentication, security best practices, and how to manage your API keys, visit our Authentication guide:

View Authentication Guide →

Available API Endpoints

Card Payments

Jump to terminal specifications →

Checkout Sessions

Jump to terminal specifications →

Transaction Status

Jump to terminal specifications →

Mobile Money

Jump to terminal specifications →

Refunds

Jump to terminal specifications →

Webhooks

Jump to terminal specifications →

Need Help?

Our support team is available 24/7 to help you with integration questions and technical issues.

Contact Support

Payment Matrix Reference Specs

Execute live tests against specific routing definitions. Use the toggle buttons inside the terminal frames to inspect alternate structural responses.

POST/v1/payments/card/initiate

1. Initiate Card Payment (with 3DS)

Verify authorization layers. Production payloads must follow precise protocol arrays to pass modern network orchestration gateways securely.

Required Headers

X-API-Key:sec_key_live_••••••••••••••••

Content-Type:application/json

Request Body Configuration

{
  "amount": 2500,
  "currency": "GHS",
  "email": "customer@example.com",
  "card": {
    "number": "4000123456789010",
    "expiry_month": "12",
    "expiry_year": "2028",
    "cvv": "123"
  },
  "redirect_url": "https://yourdomain.com/checkout/verify"
}

Response Blueprint

{
  "status": "success",
  "transaction_reference": "TXN-CARD-90811A",
  "amount": 2500,
  "currency": "GHS",
  "message": "Payment authorized successfully."
}

POST/v1/checkout/sessions

2. Create Hosted Checkout Session

Verify authorization layers. Production payloads must follow precise protocol arrays to pass modern network orchestration gateways securely.

Required Headers

X-API-Key:sec_key_live_••••••••••••••••

Content-Type:application/json

Request Body Configuration

{
  "amount": 150,
  "currency": "USD",
  "merchant_reference": "INV-2026-004",
  "customer": {
    "email": "m.amoo@exxari.com"
  },
  "redirect_url": "https://yourdomain.com/success"
}

Response Blueprint

{
  "status": "success",
  "session_id": "cs_live_9921c8b3f11a",
  "checkout_url": "https://checkout.gateway.com/pay/cs_live_9921c8b3f11a"
}

GET/v1/transactions/verify/TXN-ORD-77192

3. Verify Transaction Status

Verify authorization layers. Production payloads must follow precise protocol arrays to pass modern network orchestration gateways securely.

Required Headers

X-API-Key:sec_key_live_••••••••••••••••

Response Blueprint

{
  "status": "success",
  "transaction_reference": "TXN-ORD-77192",
  "amount": 500,
  "currency": "GHS",
  "channel": "mobile_money"
}

POST/v1/payments/momo/charge

4. Mobile Money Charge API

Verify authorization layers. Production payloads must follow precise protocol arrays to pass modern network orchestration gateways securely.

Required Headers

X-API-Key:sec_key_live_••••••••••••••••

Content-Type:application/json

Request Body Configuration

{
  "amount": 80,
  "currency": "GHS",
  "phone_number": "0244123456",
  "provider": "MTN"
}

Response Blueprint

{
  "status": "success",
  "transaction_reference": "TXN-MOMO-10293",
  "message": "Transaction completed instantly."
}

POST/v1/refunds/initiate

5. Execute Reverse / Refund Request

Verify authorization layers. Production payloads must follow precise protocol arrays to pass modern network orchestration gateways securely.

Required Headers

X-API-Key:sec_key_live_••••••••••••••••

Content-Type:application/json

Request Body Configuration

{
  "transaction_reference": "TXN-CARD-90811A",
  "amount": 2500,
  "reason": "Customer order cancellation."
}

Response Blueprint

{
  "status": "success",
  "refund_reference": "REF-88192-A",
  "amount_refunded": 2500
}

POSThttps://merchant-api.yourdomain.com/webhooks/payments

6. Webhook Notification Event Structure

Verify authorization layers. Production payloads must follow precise protocol arrays to pass modern network orchestration gateways securely.

Required Headers

X-Signature-Token:v1=7a5f6e8d2c1b3f...

Content-Type:application/json

Response Blueprint

{
  "event": "transaction.completed",
  "created_at": "2026-05-30T08:39:00Z",
  "data": {
    "status": "success",
    "amount": 2500,
    "currency": "GHS"
  }
}