Webhooks

Saved Payment Method Events

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.
  • type: Always 'SAVED_PAYMENT_METHOD' for this webhook.
  • status: Saved payment method status, can be one of:
    • ACTIVE
    • EXPIRES_SOON
    • EXPIRED
    • DISABLED
  • shopperId: Zentact's reference for the shopper the card is saved to (for example, SHR4K7PQ2M9XZ). Zentact creates it from the shopper's email the first time a card is saved at checkout. It is not the shopper.id you send to the Checkout API.
  • paymentMethod: The saved payment method (for example, visa).
  • paymentMethodIdToken: The token identifying the saved payment method, used to charge it later.
  • pspMerchantAccountName: The name of the parent Adyen merchant account.
  • merchantAccountId: Unique ID for the merchant account.
  • organizationId: Unique ID for the organization.
  • payment (optional): Present when the saved method was created alongside a payment. Contains merchantReferenceId, pspReferenceId, and an additionalData object with cardBin, cardSummary, and expiryDate.

Example

The payload is delivered as a flat JSON object (it is not wrapped in a payload key).

{
  "createdAt": 1716174034,
  "type": "SAVED_PAYMENT_METHOD",
  "status": "ACTIVE",
  "shopperId": "SHR4K7PQ2M9XZ",
  "paymentMethod": "visa",
  "paymentMethodIdToken": "X9K2M4P7Q1R8T3V6",
  "pspMerchantAccountName": "DentalSolutions_US",
  "merchantAccountId": "12bb40d2-94ee-494c-a5d7-4b6f29428491",
  "organizationId": "bf368afb-ed57-4345-a04a-7c7213431a99"
}
Previous
Payment Events