Skip to main content
PATCH
/
cards
/
digital_wallet_tokens
/
{digital_wallet_token_id}
Update Digital Wallet Token's life cycle status
curl --request PATCH \
  --url https://api.synctera.com/v2/cards/digital_wallet_tokens/{digital_wallet_token_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "token_status": "ACTIVE"
}'
{
  "approved_time": "2010-05-06T12:23:34.321Z",
  "card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "device_id": "<string>",
  "device_type": "MOBILE_PHONE",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_modified_time": "2010-05-06T12:23:34.321Z",
  "processor_data": {},
  "removed_from_wallet_time": "2010-05-06T12:23:34.321Z",
  "requested_time": "2010-05-06T12:23:34.321Z",
  "state": "REQUESTED",
  "token_reference_id": "<string>",
  "type": "APPLE_PAY"
}

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

​
digital_wallet_token_id
string<uuid>
required

The unique identifier of a digital wallet token

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Update Digital wallet token status

​
token_status
enum<string>
required

The status indicating the digital wallet token lifecycle state

Available options:
ACTIVE,
SUSPENDED,
TERMINATED

Response

Digital wallet token Status updated

​
approved_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
card_id
string<uuid>

Card ID of the Digital wallet Token

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
device_id
string

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

Maximum length: 124
​
device_type
enum<string>

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

Available options:
MOBILE_PHONE,
WATCH,
TABLET,
MOBILE_PHONE_OR_TABLET,
VEHICLE,
APPLIANCE,
LAPTOP,
GAMING_DEVICE,
UNKNOWN
​
id
string<uuid>

Digital Wallet Token ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_modified_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
processor_data
object

Raw data from processor.

​
removed_from_wallet_time
string<date-time>

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

Example:

"2010-05-06T12:23:34.321Z"

​
requested_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
state
enum<string>

Current status of the Digital Wallet Token

Available options:
REQUESTED,
REQUEST_DECLINED,
ACTIVE,
SUSPENDED,
TERMINATED
​
token_reference_id
string

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

​
type
string

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:

"APPLE_PAY"