Quickstart Guide

Modem Pay lets you accept Wave, Afrimoney, QMoney, APS, Yonna and card payments through one integration. You build once, and your customers pay with whichever method they prefer. This page takes you from sign-up to your first test payment.

Before you start

You need	Where to get it
A Modem Pay account	Sign up on the dashboard
Your API keys	Dashboard, under API keys
A URL to send customers back to	Your website or app

Everything on this page works in test mode. No real money moves until you go live.

Accept your first payment

Create your account

Copy your API keys

You get two kinds of keys from the dashboard:

Key	Starts with	Use it
Secret key	`sk_test_` / `sk_live_`	On your server only, with the SDKs and API
Public key	`pk_test_` / `pk_live_`	In your website, with HTML Checkout

Never put your secret key in a website, mobile app or public repository. Anyone with it can act on your account.

Create a payment

From your server, create a payment intent with the amount to charge. Modem Pay returns a payment_link.

import ModemPay from "modem-pay";

const modempay = new ModemPay("sk_test_...");

const intent = await modempay.paymentIntents.create({
  amount: 450,
  return_url: "https://yoursite.com/payment/success",
  cancel_url: "https://yoursite.com/payment/cancelled",
});

console.log(intent.data.payment_link);

from modempay import ModemPay

modem_pay = ModemPay(api_key="sk_test_...")

intent = modem_pay.payment_intents.create(params={
    "amount": 450,
    "return_url": "https://yoursite.com/payment/success",
    "cancel_url": "https://yoursite.com/payment/cancelled",
})

print(intent["data"]["payment_link"])

use ModemPay\ModemPay;

$modemPay = new ModemPay('sk_test_...');

$payment = $modemPay->paymentIntents()->create([
    'amount' => 450,
    'return_url' => 'https://yoursite.com/payment/success',
    'cancel_url' => 'https://yoursite.com/payment/cancelled',
]);

echo $payment->data->payment_link;

Amounts are in GMD, and the minimum is 10 GMD.

Send your customer to pay

Redirect the customer to the payment_link. They choose how to pay and complete the payment on Modem Pay’s checkout.When they finish, they come back to your return_url. If they cancel, they go to your cancel_url.

Confirm the payment with webhooks

Add your webhook URL in the dashboard. Modem Pay notifies your server when a payment changes, for example charge.succeeded or charge.cancelled.

Mark orders as paid from the webhook, not from the redirect. Customers sometimes close the page before they get back to your return_url, but the webhook still arrives.

That’s it. You’ve accepted a test payment.

Choose how to integrate

The steps above use an SDK. If you’d rather not write server code, use HTML Checkout.

	SDK / API	HTML Checkout
Best for	Apps and sites with a backend	Simple websites, quick launches
Code needed	Server code	A single HTML form
Key used	Secret key (`sk_`)	Public key (`pk_`)
Control	Full: payment intents, split payments, transfers, refunds	Collect payments

HTML Checkout

Add a form to your page that posts the payment details to Modem Pay. When the customer clicks Pay Now, they’re taken to checkout. Try it here:

The form posts to https://test.checkout.modempay.com/api/pay with these fields:

Field	Required	Description
`public_key`	Yes	Your public key (`pk_test_...` or `pk_live_...`)
`amount`	Yes	Amount in GMD, at least 10
`currency`	No	`GMD`
`return_url`	Recommended	Where the customer goes after paying
`cancel_url`	Recommended	Where the customer goes if they cancel
`customer_name`	No	Prefills checkout
`customer_email`	No	Prefills checkout
`customer_phone`	No	Prefills checkout
`metadata`	No	Your own data, e.g. an order ID.

Example of what Modem Pay receives:

{
  "public_key": "pk_test_...",
  "amount": "450",
  "currency": "GMD",
  "customer_name": "Zypheron Kade",
  "customer_email": "usr@example.com",
  "customer_phone": "7000001",
  "return_url": "https://yoursite.com/payment/success",
  "cancel_url": "https://yoursite.com/payment/cancelled",
  "metadata": { "order_id": "1042" }
}

Redirects and webhooks work exactly as in the SDK flow above.

Go live

When your test payments work:

Complete KYC

Submit your business verification from the dashboard. This is required before you can accept real payments.

Switch to live mode

Once KYC is approved, switch to live mode in the dashboard and replace your test keys with your live keys.

Run one real payment

Make a small real payment and check that your webhook marks the order as paid.

Test and live are kept separate. Payments and sub-accounts created in test mode don’t exist in live mode, and the reverse.

What’s next

Split payments

Share each payment with partners automatically.

Webhooks

React to payments, refunds and transfers on your server.

Transfers

Send money to mobile wallets and bank accounts.

Refunds

Return money to a customer, in full or in part.

Start Here

Collections

Split Payments

Payouts

Drop-ins

DeFi

Core API Resources

Terminals

Before you start

Accept your first payment

Choose how to integrate

HTML Checkout

Go live

What’s next

Split payments

Webhooks

Transfers

Refunds

​Before you start

​Accept your first payment

​Choose how to integrate

​HTML Checkout

​Go live

​What’s next

Split payments

Webhooks

Transfers

Refunds

Before you start

Accept your first payment

Choose how to integrate

HTML Checkout

Go live

What’s next