Payment Method Status Webhook Payload

{
  "status": "ADDED",
  "type": "CARD",
  "customerId": "6439bb4f-46c6-4ff6-b58a-fe811ddfa8eb",
  "paymentMethodId": "card_0508c108caa91d0a937c028da2756ff1",
  "businessId": "f96cd01b-b13c-4c21-9d52-c1de4e8721ac",
  "cardDetails": {
    "lastFourDigits": "1111",
    "brand": "VISA",
    "cardType": "DEBIT",
    "expiryMonth": "04",
    "expiryYear": "2031"
  }
}

{
  "status": "DELETED",
  "type": "CARD",
  "customerId": "6439bb4f-46c6-4ff6-b58a-fe811ddfa8eb",
  "paymentMethodId": "card_0508c108caa91d0a937c028da2756ff1",
  "businessId": "f96cd01b-b13c-4c21-9d52-c1de4e8721ac",
  "cardDetails": {
    "lastFourDigits": "1111",
    "brand": "VISA",
    "cardType": "DEBIT",
    "expiryMonth": "04",
    "expiryYear": "2031"
  }
}

Delivered when a customer saves a payment method for future payments, or removes a saved one. Use it to keep your own record of a customer’s saved payment methods in step with Atoa.

Status	Description
ADDED	Payment method was saved against the customer and can be charged on file.
DELETED	Payment method was removed from the customer’s saved payment methods.

type tells you the kind of payment method, and which detail object the payload carries. CARD carries cardDetails.

{
  "status": "ADDED",
  "type": "CARD",
  "customerId": "6439bb4f-46c6-4ff6-b58a-fe811ddfa8eb",
  "paymentMethodId": "card_0508c108caa91d0a937c028da2756ff1",
  "businessId": "f96cd01b-b13c-4c21-9d52-c1de4e8721ac",
  "cardDetails": {
    "lastFourDigits": "1111",
    "brand": "VISA",
    "cardType": "DEBIT",
    "expiryMonth": "04",
    "expiryYear": "2031"
  }
}

{
  "status": "DELETED",
  "type": "CARD",
  "customerId": "6439bb4f-46c6-4ff6-b58a-fe811ddfa8eb",
  "paymentMethodId": "card_0508c108caa91d0a937c028da2756ff1",
  "businessId": "f96cd01b-b13c-4c21-9d52-c1de4e8721ac",
  "cardDetails": {
    "lastFourDigits": "1111",
    "brand": "VISA",
    "cardType": "DEBIT",
    "expiryMonth": "04",
    "expiryYear": "2031"
  }
}

The detail object and its fields are optional — a field is omitted when the provider did not report it. Only status, type, customerId, paymentMethodId and businessId are guaranteed.

Use paymentMethodId to charge the saved payment method — see Charge Saved Card. Authorize Card generates the link a customer uses to save one.

Overview

Reference

Webhook

Card on File

Payment Method Status Webhook Payload