JGME Pay
Getting Started

Quick Start

Get up and running with JGME Pay payment orchestration API in under 10 minutes. Integrate MTN MoMo API, M-Pesa API, and other Africa mobile money API providers.

This guide will help you make your first payment orchestration API call to JGME Pay in under 10 minutes. By the end, you'll have integrated Africa mobile money API capabilities including MTN MoMo API, M-Pesa API, and other local payment methods in Africa.


Prerequisites

Before you begin, you'll need:

A JGME Pay account
Your API credentials (client-id and client-secret)

A tool to make HTTP requests (cURL, Postman, or your preferred language)


Step 1: Create Your Account

Sign Up

Go to https://merchant.jgmepay.com and create a free account.

Verify Email

Check your inbox and verify your email address.

Complete Profile

Fill in basic business information to activate your account.


Step 2: Get Your API Credentials

API Keys Location in Dashboard

Navigate to Settings

Log into your dashboard and click on Settings in the sidebar.

Go to API Keys/Webhooks

Click on API Keys/Webhooks tab.

Copy Your Credentials

You'll find your:

  • client-id - Your unique identifier
  • client-secret - Your secret key (keep this secure!)

Never expose your client-secret in client-side code or public repositories. Always make API calls from your backend server.


Webhooks notify your server about transaction status changes in real-time.

Go to API Keys/Webhooks

In Settings -> Security -> API Keys and Webhooks, find the webhook configuration section.

Enter Your Callback URL

Add your webhook endpoint URL (e.g., https://yoursite.com/jgmepay/webhook).

Save Configuration

Click Save. You can test the webhook using our test transaction feature.


Environment URLs

ServiceURL
API Base URLhttps://api.jgmepay.com
Dashboardhttps://merchant.jgmepay.com
Checkout Pagehttps://checkout.jgmepay.com

Every transaction is live and involves real money. Validate with the smallest amount your providers accept.


Step 4: Make Your First API Call

Let's create a checkout session to collect a payment:

curl --location 'https://api.jgmepay.com/payments/v1/checkouts' \
  --header 'client-id: YOUR_CLIENT_ID' \
  --header 'client-secret: YOUR_CLIENT_SECRET' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "reference": "order-001",
    "amount": 5000,
    "currency": "NGN",
    "country": "NG",
    "redirectURL": "https://yoursite.com/payment/success",
    "webhook": "https://yoursite.com/jgmepay/webhook",
    "user": {
      "email": "customer@example.com",
      "phoneNumber": "08012345678"
    }
  }'

Expected Response

{
  "success": true,
  "data": {
    "checkoutId": "chk_abc123xyz",
    "checkoutUrl": "https://checkout.jgmepay.com/chk_abc123xyz",
    "reference": "order-001",
    "amount": 5000,
    "currency": "NGN",
    "status": "pending"
  }
}

Step 5: Redirect Customer to Checkout

Take the checkoutUrl from the response and redirect your customer to complete payment:

// Redirect customer to checkout
window.location.href = response.data.checkoutUrl;

The customer will:

  1. See available payment methods for their country
  2. Select their preferred method (e.g., MTN MoMo, Bank Transfer)
  3. Complete the payment
  4. Be redirected to your redirectURL

Step 6: Handle the Webhook

When the payment status changes, we'll send a POST request to your webhook URL:

{
  "event": "payment.completed",
  "data": {
    "reference": "order-001",
    "checkoutId": "chk_abc123xyz",
    "amount": 5000,
    "currency": "NGN",
    "status": "successful",
    "provider": "mtn-momo-nigeria",
    "paidAt": "2025-02-06T10:30:00Z"
  }
}

Always verify webhook signatures and confirm transaction status via API before fulfilling orders.


What's Next?


Troubleshooting

Still need help?

On this page