Payment links

A payment link opens a Modem Pay checkout page for a product, a service or a donation. Send it on WhatsApp, put it in your Instagram bio, print it as a QR code or add it to an email. Every link can be used again and again until you turn it off.

You don’t need the API for this. Create links in the dashboard under Payment links. Use the API when you want to create links from your own system, for example one per product.

What you can set

Field	Required	What it does
`title`	No	Shown at the top of the checkout page.
`description`	No	What the customer is paying for.
`amount`	No	A fixed price. Leave it out to let the customer type any amount, which is good for donations and tips.
`currency`	Yes	`GMD`.
`redirect_url`	No	Where the customer goes after paying.
`cancel_url`	No	Where the customer goes if they cancel.
`custom_fields`	No	Extra questions to ask at checkout, like `"Student ID"` or `"Delivery address"`. Answers come back in `custom_fields_values` on the transaction and webhook.

Create a link

const link = await modempay.paymentLinks.create({
  title: "Wax print dress",
  description: "Size M, pick up at Kairaba Avenue",
  amount: 3500,
  currency: "GMD",
  redirect_url: "https://yourshop.gm/thanks",
  custom_fields: ["Pickup date"],
});

console.log(link.payment_link); // share this

curl -X POST https://api.modempay.com/v1/payment-links \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Wax print dress",
    "description": "Size M, pick up at Kairaba Avenue",
    "amount": 3500,
    "currency": "GMD",
    "redirect_url": "https://yourshop.gm/thanks",
    "custom_fields": ["Pickup date"]
  }'

The response includes the URL to share:

{
  "id": "ed46f172-0c9e-4d53-862d-0afbb85d6f88",
  "type": "single-charge",
  "status": "active",
  "title": "Wax print dress",
  "amount": 3500,
  "currency": "GMD",
  "custom_fields": ["Pickup date"],
  "unique_code": "aa57aa1a28655934…",
  "payment_link": "https://test.checkout.modempay.com/pay/aa57aa1a28655934…",
  "test_mode": true,
  "createdAt": "2025-02-13T12:11:17.695Z"
}

Manage links

// Get one
const link = await modempay.paymentLinks.retrieve("ed46f172-…");

// Change it, or turn it off
await modempay.paymentLinks.update("ed46f172-…", { status: "inactive" });

// List all
const links = await modempay.paymentLinks.list();

// Delete
await modempay.paymentLinks.delete("ed46f172-…");

You can update title, description, amount, currency, redirect_url, cancel_url, custom_fields and status. An inactive link can’t be paid. Set it back to active to reopen it.

Know when someone paid

Every payment through a link sends a charge.succeeded webhook. The payload has payment_link_id, so you can tell which link was paid, and custom_fields_values with the customer’s answers. You can also see every payment for a link in the dashboard.

Links, intents or invoices?

Use	When
Payment link	The same price for many customers, shared by hand.
Payment intent	One payment for one order, created by your server.
Invoice	A bill for one customer, with line items, a due date and reminders.

Start here

Build and test

Get paid

Payments API

Webhooks

Pay people

Balances and reports

Customers and discounts

Split payments

Accept in person

Stablecoins

What you can set

Create a link

Manage links

Know when someone paid

Links, intents or invoices?

​What you can set

​Create a link

​Manage links

​Know when someone paid

​Links, intents or invoices?

What you can set

Create a link

Manage links

Know when someone paid

Links, intents or invoices?