JGME Pay
Collect Payment

Collections - Payment Links

Create and manage shareable payment links for hosted customer payments.

Payment Links let you create hosted checkout URLs that customers can open from invoices, messages, social media, or email campaigns. A link can collect a fixed amount or allow the customer to enter an amount within configured limits.

When a customer completes payment through a payment link, JGME Pay sends a payment webhook to your configured webhook endpoint. Use the webhook event as your source of truth before fulfilling the order or marking an invoice as paid.

See Webhooks and Callbacks for the payment.completed payload, signature verification, retry handling, and webhook URL priority.

Endpoints

MethodEndpointPurpose
POST/payments/v1/payment-linksCreate a payment link
GET/payments/v1/payment-linksFetch paginated payment links
GET/payments/v1/payment-links/{id}Fetch a payment link and its analytics

Integration Steps

Create the payment link

Call POST /payments/v1/payment-links with title, description, currency, country, and amount settings. Send your client identifier in the client-id header.

Share the URL

Use the returned shortURL or longURL in invoices, emails, chats, social posts, or payment reminders.

Receive the payment webhook

After the customer pays, JGME Pay sends a payment webhook to the configured endpoint. Verify the webhook signature and process the event idempotently.

Review link performance

Use GET /payments/v1/payment-links/{id} to retrieve the link, collected totals, channel breakdown, and provider availability.

curl --request POST \
  --url https://api.jgmepay.com/payments/v1/payment-links \
  --header 'client-id: <client-id>' \
  --header 'client-secret: <client-secret>' \
  --header 'content-type: application/json' \
  --data '{
    "isAmountFixed": false,
    "title": "decimal test",
    "description": "demo",
    "redirectURL": "",
    "logo": "https://6thbridge-file-upload.s3.amazonaws.com/choosen-02.png",
    "customFields": [],
    "maximumAmount": 100000000,
    "minimumAmount": 0,
    "amountLimit": 100000000,
    "currency": "XOF",
    "country": "CI"
  }'

Example response:

{
  "statusCode": 201,
  "data": {
    "clientId": "6thbridge",
    "locale": "en",
    "logo": "https://6thbridge-file-upload.s3.amazonaws.com/choosen-02.png",
    "currency": "XOF",
    "country": "CI",
    "title": "decimal test",
    "description": "demo",
    "isAmountFixed": false,
    "longURL": "https://checkout-staging.6thbridge.com/link/6a7a2093b9e24880f73a80b0",
    "shortURL": "https://s.6bd.co/payment-link/1PIDcH",
    "minimumAmount": 0,
    "maximumAmount": 100000000,
    "amountLimit": 100000000,
    "customFields": [],
    "redirectURL": "",
    "expiresAt": null,
    "isActive": true,
    "status": "active",
    "parentClientId": "6thbridge",
    "createdAt": "2026-08-10T19:03:47.222Z",
    "updatedAt": "2026-08-10T19:03:47.222Z",
    "id": "6a7a2093b9e24880f73a80b0"
  }
}

Request Fields

FieldTypeRequiredDescription
titlestringYesHuman-readable payment link title
descriptionstringYesHuman-readable payment link description
currencystringYesRequired 3-letter ISO currency code
countrystringYesRequired 2-letter ISO country code used for active integration lookup
isAmountFixedbooleanNoSet to true when the payer cannot change the amount
amountnumberRequired when isAmountFixed is trueFixed collection amount in minor units
minimumAmountnumberUsed when isAmountFixed is falseMinimum payer-entered amount in minor units
maximumAmountnumberUsed when isAmountFixed is falseMaximum payer-entered amount in minor units
amountLimitnumberNoTotal collectible amount limit across successful payments for this link, in minor units
customFieldsarrayNoExtra payer fields to collect before creating checkout
redirectURLstringNoURL to redirect the payer to after payment flow
logostringNoLogo URL or empty string. Defaults to the client or business logo
localestringNoLocale for payer-facing checkout. Defaults to the client or business locale
isAnonymousPaymentEnabledbooleanNoWhether anonymous payments are allowed
expiresAtdateNoDate on which the link expires

Amount Modes

Custom Fields

Use customFields when you need extra payer information before checkout is created. Choice fields require options.

Supported customFields.type values:

TypeUse case
textShort free-text input
paragraph-textLonger free-text input
dropdownSingle choice from predefined options
numberNumeric input
dateDate input
file-uploadFile attachment
checkboxBoolean confirmation
{
  "customFields": [
    {
      "label": "Invoice number",
      "name": "invoiceNumber",
      "type": "text",
      "required": true
    },
    {
      "label": "Package",
      "name": "package",
      "type": "dropdown",
      "required": true,
      "options": ["Basic", "Premium"]
    }
  ]
}
curl --request GET \
  --url 'https://api.jgmepay.com/payments/v1/payment-links?page=1&limit=2' \
  --header 'client-id: <client-id>' \
  --header 'client-secret: <client-secret>'
curl --request GET \
  --url https://api.jgmepay.com/payments/v1/payment-links/6a7204a536c2106e38fe8e01 \
  --header 'client-id: <client-id>' \
  --header 'client-secret: <client-secret>'

The response includes the payment link fields and an analytics object with collected amount, transaction count, channel breakdown, revenue history, available providers, and available channels.

Webhook Completion

Payment links use the same collection webhook flow documented in Webhooks and Callbacks. When a customer successfully completes a payment link checkout, JGME Pay sends a payment webhook such as payment.completed.

Verify the signature

Validate x-webhook-signature with your client-secret before processing the event.

Use idempotency

Track processed reference and status values so retries do not trigger duplicate fulfillment.

Fulfill after final status

Mark invoices, orders, or balances as paid only after receiving and validating a final webhook status such as success.

Important Rules

Amount values are sent in minor units. See Amount Specification.

Do not rely only on customer redirect behavior to confirm payment. Always process the payment webhook before fulfilling value.

On this page