---
title: "example_checkout_token_event"
method: POST
path: "/examples/checkout_token"
tags: ["example-checkout-events"]
---

# example_checkout_token_event

`POST /examples/checkout_token`

Event is pushed to subscribers when the checkout token is created, \
updated or deleted

## Headers

- `event` string, required
- `event-delivery` string, required
- `event-signature` string
- `content-type` string, required

## Request body

- union
  - CheckoutTokenAddEvent
    - `account_id` string, required
    - `event_delivery` string, uuid, required
    - `event` 'checkout_token_add', required
    - `token` object, required
      - `id` string, required
      - `token` string, required
      - `type` 'payment_token', required
      - `status` 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'DELETED', required
      - `card_brand` 'visa' | 'mastercard', required
      - `masked_pan` string, required
      - `pan_expiry_date` string, \d{2}/\d{4}
      - `token_expiry_date` string, \d{2}/\d{4}, required
      - `links` object[]
        - `href` string, required
        - `rel` 'digital_card_art' | 'digital_card_art_background' | 'card_symbol' | 'terms_and_conditions', required
        - `mime_type` 'image/png' | 'image/pdf' | 'text/plain' | 'text/html'
      - `customer_id` string
      - `account_id` string, required
      - `relationship_id` string — Reference to the merchant entity for which the token is dedicated. Merchant-dedicated tokens are uniquely created per merchant_relationship_id.
      - `transaction_id` string, checkout-id — Reference to the transaction where the token was created
      - `external_token_references` string[] — External references to migrated card tokens
      - `payment_product_type` string, required
      - `created_at` string, date-time, required
      - `created_by` string
      - `updated_at` string, date-time, required
      - `deleted_at` string, date-time
      - `deleted_by` string
  - CheckoutTokenUpdateEvent
    - `account_id` string, required
    - `event_delivery` string, uuid, required
    - `event` 'checkout_token_update', required
    - `token` object, required
      - `id` string, required
      - `token` string, required
      - `type` 'payment_token', required
      - `status` 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'DELETED', required
      - `card_brand` 'visa' | 'mastercard', required
      - `masked_pan` string, required
      - `pan_expiry_date` string, \d{2}/\d{4}
      - `token_expiry_date` string, \d{2}/\d{4}, required
      - `links` object[]
        - `href` string, required
        - `rel` 'digital_card_art' | 'digital_card_art_background' | 'card_symbol' | 'terms_and_conditions', required
        - `mime_type` 'image/png' | 'image/pdf' | 'text/plain' | 'text/html'
      - `customer_id` string
      - `account_id` string, required
      - `relationship_id` string — Reference to the merchant entity for which the token is dedicated. Merchant-dedicated tokens are uniquely created per merchant_relationship_id.
      - `transaction_id` string, checkout-id — Reference to the transaction where the token was created
      - `external_token_references` string[] — External references to migrated card tokens
      - `payment_product_type` string, required
      - `created_at` string, date-time, required
      - `created_by` string
      - `updated_at` string, date-time, required
      - `deleted_at` string, date-time
      - `deleted_by` string
  - CheckoutTokenDeleteEvent
    - `account_id` string, required
    - `event_delivery` string, uuid, required
    - `event` 'checkout_token_delete', required
    - `token` object, required
      - `id` string, required
      - `token` string
      - `type` 'payment_token', required
      - `status` 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'DELETED', required
      - `card_brand` 'visa' | 'mastercard', required
      - `masked_pan` string
      - `pan_expiry_date` string, \d{2}/\d{4}
      - `token_expiry_date` string, \d{2}/\d{4}
      - `links` object[]
        - `href` string, required
        - `rel` 'digital_card_art' | 'digital_card_art_background' | 'card_symbol' | 'terms_and_conditions', required
        - `mime_type` 'image/png' | 'image/pdf' | 'text/plain' | 'text/html'
      - `customer_id` string
      - `account_id` string, required
      - `relationship_id` string — Reference to the merchant entity for which the token is dedicated. Merchant-dedicated tokens are uniquely created per merchant_relationship_id.
      - `transaction_id` string, checkout-id — Reference to the transaction where the token was created
      - `external_token_references` string[] — External references to migrated card tokens
      - `payment_product_type` string, required
      - `created_at` string, date-time, required
      - `created_by` string
      - `updated_at` string, date-time, required
      - `deleted_at` string, date-time, required
      - `deleted_by` string, required

## Response `200`

event handled

## Other responses

- `400` — ignored, stop resend
- `500` — unhandled, resend

---

[API](https://skmtc.net/dintero/apis/account-management-api.md) · [All operations](https://skmtc.net/dintero/apis/account-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dintero/account-management-api/revisions/9b83a4199008/schema)