Payment Link object

A payment link represents a request for payment that can be shared with customers. Payment links have a lifecycle that includes creation, potential updates, and eventual completion or expiration.

Create a Payment LinkCreates a new payment link for collecting payments from customers.

{
  "id": "pl_6phg74i4jG9wbzZbFDUQB",
  "status": "active",
  "payment_id": "p_xyz789abc123def456",
  "checkout_session_id": "chk_456789abc123def",
  "amount": 1000,
  "currency": "ZAR",
  "external_reference": "INV-2024-001",
  "description": "Product purchase",
  "link_url": "https://links.momentpay.io/zZbFDUQB",
  "expires_at": "2025-06-17T10:30:00Z",
  "metadata": {
    "customer_id": "cust_123456",
    "order_id": "ord_789012"
  },
  "created_at": "2025-06-16T10:30:00Z",
  "updated_at": "2025-06-16T10:30:00Z"
}

Collect

Billing

Technical Guides