Private API Reference

Digital Wallet Token Transitions

A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.

Transition a Digital Wallet Token

Submit a Digital Wallet Token status transition to the card network. A digital_wallet_token.updated webhook will be sent once the transition has been confirmed.

curl -X "POST" \
  --url "${INCREASE_URL}/digital_wallet_tokens/digital_wallet_token_izi62go3h51p369jrie0/transition" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "suspended"
  }'

Returns a Digital Wallet Token object:

{
  "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"
    }
  ]
}

Parameters

digital_wallet_token_id

string

Required

The identifier of the Digital Wallet Token.

More about Digital Wallet Tokens.

status

enum

Required

The status to transition the Digital Wallet Token to.