Card Payment Events

Use card payment events to keep your application informed when a card payment is authorized, declined, canceled, settled, reversed, refunded, or adjusted.

Enable Support Included on your webhook to receive the related CardPayment in the event payload. Use that included resource to read the payment status, amounts, merchant details, and history relationships. For an explanation of payment history, see Card Payments Lifecycle.

Subscribe to events

Create a webhook endpoint. See Webhooks Overview.

Available events

Event	When it is emitted	How to handle it
`cardPayment.authorized`	A card payment authorization is recorded.	Show the payment as authorized. An authorization reserves funds; it does not confirm settlement.
`cardPayment.declined`	A payment decline is recorded.	Show the decline and inspect the payment's `declineReason` when available.
`cardPayment.canceled`	An authorization is reversed before settlement and its hold is released.	Show the payment as voided. This is a payment event, not a card closure event.
`cardPayment.settled`	A payment settles, including a direct settlement without an earlier authorization.	Use the included payment’s `amounts.settled`.
`cardPayment.refunded`	A refund credit is recorded, including a standalone credit without an earlier refund request.	Use the included payment to identify the refund and read `amounts.refunded`.
`cardPayment.adjusted`	A settlement-adjustment history entry is recorded.	Inspect the included payment’s amounts and any included history entries. This event alone does not establish that money moved.

A refund request is recorded in payment history, but the current implementation does not emit a cardPayment.refundRequested event. Do not wait for that event before handling cardPayment.refunded.

Event payload

This illustrative settlement event shows Support Included enabled. Identifiers are placeholders, and the included payment is shortened to highlight its amounts:

{
  "data": {
    "id": "event_example_001",
    "type": "cardPayment.settled",
    "attributes": {
      "createdAt": "2026-09-18T10:30:00"
    },
    "relationships": {
      "cardPayment": {
        "data": {
          "id": "payment_example_001",
          "type": "CardPayment"
        }
      }
    }
  },
  "included": [
    {
      "id": "payment_example_001",
      "type": "CardPayment",
      "attributes": {
        "currency": "USD",
        "amounts": {
          "authorized": 10000,
          "settled": 10000,
          "adjusted": 0,
          "reversed": 0,
          "refundAuthorized": 0,
          "refunded": 0
        }
      }
    }
  ]
}