Payment Link Status Update

This webhook is triggered when a payment link status changes.

Payload

{
  "apiKeyId": "string",
  "type": "payment_link.status_updated",
  "paymentLinkId": "string",
  "status": "string",
  "clientReferenceId": "string",
  "transactions": [
    {
      "transactionId": "string",
      "paymentMethod": "string",
      "datePaid": 0,
      "amount": 0,
      "amountBreakdown": {
        "base": 0,
        "tip": 0,
        "fee": 0
      },
      "applicationFee": 0
    }
  ]
}

Fields

Field	Type	Description
apiKeyId	string	The API key ID associated with this webhook
type	string	The event type (payment_link.status_updated)
paymentLinkId	string	The unique identifier (ULID) of the payment link
status	string	Can be paid, pending, or processing
clientReferenceId	string	The client reference ID provided when creating the payment link
transactions	array	List of Transaction Object entries that settled against this payment link

Example

{
  "apiKeyId": "01HXYZ1234567890ABCDEFGH",
  "type": "payment_link.status_updated",
  "paymentLinkId": "01HXYZ1234567890ABCDEFGH",
  "status": "paid",
  "clientReferenceId": "order-12345",
  "transactions": [
    {
      "transactionId": "01HXYZTXN1234567890ABCDE",
      "paymentMethod": "CARD",
      "datePaid": 1715000000,
      "amount": 153.50,
      "amountBreakdown": {
        "base": 100.00,
        "tip": 50.00,
        "fee": 3.50
      },
      "applicationFee": 11.00
    }
  ]
}