Webhooks

Saved Payment Method Webhooks

Trigger

  • Description: Sent when a status of shopper's saved payment method availability changes.

Payload

  • createdAt: Unix epoch timestamp indicating when the event was created.
  • shopperId: End customer's unique id that was linked during a checkout with savePaymentMethod flag.
  • type: Always 'SAVED_PAYMENT_METHOD' for this webhook.
  • organizationId: Unique ID for the organization.
  • status: Payment status, can be one of:
    • ACTIVE
    • EXPIRES_SOON
    • EXPIRED
    • DISABLED
  • paymentMethod: The method used for the payment.

Example

{
    "payload": {
        "organizationId": "bf368afb-ed57-4345-a04a-7c7213431a99",
        "shopperId": "AAC",
        "status": "ACTIVE",
        "createdAt": 1716174034,
        "type": "SAVED_PAYMENT_METHOD",
        "paymentMethod": "visa"
    }
}
Previous
Payment Events