Skip to main content

​
Overview

A payment link is a Modulus-hosted checkout URL. You create a link server-side, send your customer the returned url, and Modulus hosts the checkout page and processes the payment. No frontend code is required.

Quickstart

Create a link and take your first payment in five minutes.

​
Lifecycle

A payment link moves through the following statuses:

​
How it works

1

Create a payment link

Call Create a Payment Link with the amount, line items, description, and an expires_at. You receive a url.
2

Share the hosted URL

Send the url to your customer. They complete payment on the Modulus-hosted checkout page.
3

Return the customer

After payment, the customer is redirected to the matching URL in redirect_urls (success, declined, or expired).
4

Reconcile

Retrieve the payment link to read its current status and successful_payment_count, and match the payment to your records using the order_reference and metadata you set at creation.

​
Amounts and line items

Amounts are integers in the currency’s smallest unit (for PHP, centavos); see Working with amounts. When line_items are supplied, the link amount must equal their sum (unit_price times quantity). An empty array creates an amount-only link.