Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Digital Wallet Tokens

Update Digital Wallet Token's life cycle status

The status of a digital wallet token can be updated as, ACTIVE to SUSPENDED, SUSPENDED to ACTIVE, ACTIVE to TERMINATED or SUSPENDED to TERMINATED.

patch/cards/digital_wallet_tokens/{digital_wallet_token_id}

Path parameters

digital_wallet_token_idstring uuid required

The unique identifier of a digital wallet token

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

token_status'ACTIVE' | 'SUSPENDED' | 'TERMINATED' required

The status indicating the digital wallet token lifecycle state

Response

Digital wallet token Status updated

approved_timestring date-time
card_idstring uuid

Card ID of the Digital wallet Token

device_idstring

The user’s Android device ID; the device’s unique identifier.

device_type'APPLIANCE' | 'GAMING_DEVICE' | 'LAPTOP' | 'MOBILE_PHONE' | 'MOBILE_PHONE_OR_TABLET' | 'TABLET' | 'UNKNOWN' | 'VEHICLE' | 'WATCH'

Type of the device where the Digital Wallet Token is used in

idstring uuid

Digital Wallet Token ID

last_modified_timestring date-time
processor_dataobject

Raw data from processor.

removed_from_wallet_timestring date-time

The time that the token was removed from a wallet. Tokens make remain active after being removed from a wallet.

requested_timestring date-time
state'ACTIVE' | 'REQUESTED' | 'REQUEST_DECLINED' | 'SUSPENDED' | 'TERMINATED'

Current status of the Digital Wallet Token

token_reference_idstring

Unique identifier of the digital wallet token within the card network.

typestring

Type of the Digital Wallet. Can be one of APPLE_PAY, ANDROID_PAY, SAMSUNG_PAY or something else when cards are added on file to a merchant.

Example response

{
  "approved_time": "2010-05-06T12:23:34.321Z",
  "card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_modified_time": "2010-05-06T12:23:34.321Z",
  "removed_from_wallet_time": "2010-05-06T12:23:34.321Z",
  "requested_time": "2010-05-06T12:23:34.321Z",
  "type": "APPLE_PAY"
}