Cards

Pause card token

Temporarily pause a card token. Authorizations with the token are declined until it is reactivated. Only tokens in the active status can be paused. Fires an issuing.card_token.paused event.

patch/issuing/card-tokens/{card_token_id}/pause

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/issuing/card-tokens/{card_token_id}/pause
  • Auth: HTTP basic

Path parameters

card_token_idstring required

Response

Successful response

activation_denied_atstring date-time nullable

Timestamp when the token entered activation_denied status

card_account_idstring required

The ID of the card account

card_idstring required

The ID of the card

card_program_idstring required

The ID of the card program

created_atstring date-time required

The creation timestamp of the card token

deactivated_atstring date-time nullable

Timestamp when the token was deactivated

device_namestring nullable

The name of the device the token is provisioned to

device_type'mobile_phone' | 'tablet' | 'watch' | 'mobile_phone_or_tablet' | 'pc' | 'ecommerce' | 'unknown' nullable

The type of device the token is provisioned to. Possible values: mobile_phone, tablet, watch, mobile_phone_or_tablet, pc, ecommerce, unknown

first_activated_atstring date-time nullable

Timestamp when the token was first activated

first_paused_atstring date-time nullable

Timestamp when the token was first paused

idstring required

The ID of the card token

last_activated_atstring date-time nullable

Timestamp when the token was last activated

last_paused_atstring date-time nullable

Timestamp when the token was last paused

network_token_reference_idstring

The network token reference used to identify this token in wallet SDKs. Available for Visa tokens when assigned by the network.

pending_activation_atstring date-time nullable

Timestamp when the token entered pending_activation status

pending_authentication_atstring date-time nullable

Timestamp when the token entered pending_authentication status

requestor_namestring nullable

The name of the token requestor (e.g., the digital wallet provider)

status'pending_activation' | 'stepping_up' | 'pending_authentication' | 'activation_denied' | 'active' | 'paused' | 'deactivated' required

The status of the card token

stepping_up_atstring date-time nullable

Timestamp when the token entered stepping_up status

token_type'wallet' | 'card_on_file' nullable

The type of token. Possible values: wallet, card_on_file

wallet_type'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown' required

The type of digital wallet. Possible values: apple_pay, google_pay, samsung_pay, unknown

Example response

{
  "card_account_id": "cacc_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_id": "card_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_program_id": "cpgm_2x8gszy5folpA9s0TOCseE9ABDM",
  "device_name": "iPhone",
  "device_type": "mobile_phone",
  "id": "ctkn_2x8gszy5folpA9s0TOCseE9ABDM",
  "network_token_reference_id": "DNITHE302312345678901234",
  "requestor_name": "Apple Pay",
  "status": "active",
  "token_type": "wallet",
  "wallet_type": "apple_pay"
}

Changes

No recorded changes to this operation across all 1 revision of this API.