Sign in

Transition a Digital Wallet Token

Submit a Digital Wallet Token status transition to the card network. The Digital Wallet Token will move to pending_transitioning until the card network confirms the transition, and a digital_wallet_token.updated webhook will be sent once the transition has been confirmed.

post/digital_wallet_tokens/{digital_wallet_token_id}/transition

Path parameters

digital_wallet_token_idstring required

The identifier of the Digital Wallet Token.

Request body

status'active' | 'suspended' | 'deactivated' required

The status to transition the Digital Wallet Token to.

Example request

{
  "status": "suspended"
}

Response

Digital Wallet Token

account_idstring required

The identifier for the Account this Digital Wallet Token belongs to.

card_idstring required

The identifier for the Card this Digital Wallet Token belongs to.

created_atstring date-time required

The ISO 8601 date and time at which the Digital Wallet Token was created.

idstring required

The Digital Wallet Token identifier.

primary_account_number_reference_identifierstring required

The reference identifier assigned by the card network to the underlying Card.

status'active' | 'inactive' | 'suspended' | 'deactivated' | 'declined' | 'pending_transitioning' required

This indicates if payments can be made with the Digital Wallet Token.

token_reference_identifierstring required

The reference identifier assigned by the card network to the token.

token_requestor'apple_pay' | 'google_pay' | 'samsung_pay' | 'garmin_pay' | 'unknown' required

The digital wallet app being used.

type'digital_wallet_token' required

A constant representing the object's type. For this resource it will always be digital_wallet_token.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "cardholder": {
    "name": "John Smith"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "decline": null,
  "device": {
    "device_type": "mobile_phone",
    "identifier": "04393EADF4149002225811273840459271E36516DA4875FF",
    "ip_address": "1.2.3.4",
    "name": "My Work Phone"
  },
  "dynamic_primary_account_number": null,
  "id": "digital_wallet_token_izi62go3h51p369jrie0",
  "primary_account_number_reference_identifier": "V-0000000000000000000000",
  "status": "active",
  "token_reference_identifier": "DNITHE000000000000000000000",
  "token_requestor": "apple_pay",
  "type": "digital_wallet_token",
  "updates": [
    {
      "status": "inactive",
      "timestamp": "2020-01-31T23:59:59Z"
    }
  ]
}

Changes

Changed in 2 of the 34 revisions of this API.11