Skip to main content
WEBHOOK
payment_request.paid
{
  "id": "evt_xyz987654321000001",
  "type": "payment_request.paid",
  "data": {
    "id": "pr_6phg74i4jG9wbzZbFDUQB",
    "status": "paid",
    "type": "link",
    "amount": 10000,
    "payment_id": "p_42432fdsjdklfjh4523987",
    "currency": "ZAR",
    "external_reference": "INV-2024-001",
    "description": "Product purchase",
    "expires_at": "2025-06-17T10:30:00Z",
    "link": {
      "checkout_session_id": "chk_G9wbzZbFDUQBFAE",
      "link_url": "https://links.momentpay.io/G9wbzZbFDUQBFAE"
    },
    "metadata": {
      "customer_id": "cust_123456",
      "order_id": "ord_789012"
    },
    "created_at": "2025-06-16T10:30:00Z",
    "updated_at": "2025-06-16T10:30:00Z"
  }
}

Body

application/json

Represents an occurrence in the system that triggers the webhook, containing an identifier, event type, and relevant data.

​
id
string
required

Unique identifier for a webhook event

Required string length: 24 - 50
Example:

"evt_1234567890abcdef1234"

​
type
enum<string>
required

Type of webhook event

Available options:
payment_link.created,
payment_link.updated
Example:

"payment_link.created"

​
data
object
required

A Payment Request represents a request for payment that can be shared via a link or sent to a banking app for authorization and Payment.

Example:
{
  "id": "pr_6phg74i4jG9wbzZbFDUQB",
  "status": "active",
  "payment_id": "p_xyz789abc123def456",
  "type": "link",
  "amount": 1000,
  "currency": "ZAR",
  "external_reference": "INV-2024-001",
  "expires_at": "2025-06-17T10:30:00Z",
  "description": "Product purchase",
  "link": {
    "checkout_session_id": "chk_456789abc123def",
    "url": "https://links.momentpay.io/zZbFDUQB"
  },
  "push": {
    "provider": "capitec",
    "capitec": { "phone_number": "+27823778084" }
  },
  "metadata": {
    "customer_id": "cust_123456",
    "order_id": "ord_789012"
  },
  "created_at": "2025-06-16T10:30:00Z",
  "updated_at": "2025-06-16T10:30:00Z"
}

Response

200

Return a 200 status to indicate that the data was received successfully