All Versions

Card forgotten

EVENT card.forgotten

Published when a Card is GDPR forgotten/vaulted.

Permissions

PAYMENTS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the target seller associated with the event.
`type string`	The type of this event. The value is `"card.forgotten"`.
`event_id string`	A unique ID for the event.
`created_at string`	Read only The timestamp of when the event was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`data CardForgottenSquareEventData`	The data associated with the event.

Examples

All Versions

{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "card.forgotten",
  "event_id": "d214f854-adb1-4f56-b078-4b8697a3187a",
  "created_at": "2020-02-15T04:38:13Z",
  "data": {
    "type": "card_forgotten",
    "id": "ccof:uIbfJXhXETSP197M3GB",
    "object": {
      "card": {
        "id": "ccof:uIbfJXhXETSP197M3GB",
        "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
        "enabled": false,
        "merchant_id": "6SSW7HV8K2ST5",
        "reference_id": "user-id-1",
        "version": 2
      }
    }
  }
}