> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paywithatoa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Payment Method Status Webhook Payload

> Reference for the Atoa 'Payment Method Status Webhook' payload, the fields Atoa sends and an example JSON body to handle.

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`.

`metadata` is the key/value data you attached when saving the card (see [Authorize Card](https://docs.paywithatoa.com/api-reference/card-on-file/authorize-card.md)), and `createdAt` is when the card was saved. Both match what the [List Payment Methods](https://docs.paywithatoa.com/api-reference/payment-methods/list-payment-methods.md) API returns, and are omitted when the card carried no metadata.

```json Added theme={null}
{
  "status": "ADDED",
  "type": "CARD",
  "customerId": "6439bb4f-46c6-4ff6-b58a-fe811ddfa8eb",
  "paymentMethodId": "card_0508c108caa91d0a937c028da2756ff1",
  "businessId": "f96cd01b-b13c-4c21-9d52-c1de4e8721ac",
  "metadata": { "internalId": "42" },
  "createdAt": "2025-06-15T10:30:00.000Z",
  "cardDetails": {
    "lastFourDigits": "1111",
    "brand": "VISA",
    "cardType": "DEBIT",
    "expiryMonth": "04",
    "expiryYear": "2031"
  }
}
```

```json Deleted theme={null}
{
  "status": "DELETED",
  "type": "CARD",
  "customerId": "6439bb4f-46c6-4ff6-b58a-fe811ddfa8eb",
  "paymentMethodId": "card_0508c108caa91d0a937c028da2756ff1",
  "businessId": "f96cd01b-b13c-4c21-9d52-c1de4e8721ac",
  "metadata": { "internalId": "42" },
  "createdAt": "2025-06-15T10:30:00.000Z",
  "cardDetails": {
    "lastFourDigits": "1111",
    "brand": "VISA",
    "cardType": "DEBIT",
    "expiryMonth": "04",
    "expiryYear": "2031"
  }
}
```

> [!NOTE]
>
> 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.

> [!NOTE]
>
> Use `paymentMethodId` to charge the saved payment method — see [Charge Saved Card](https://docs.paywithatoa.com/api-reference/card-on-file/charge-saved-card.md). [Authorize Card](https://docs.paywithatoa.com/api-reference/card-on-file/authorize-card.md) generates the link a customer uses to save one.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.