Digital Wallet Tokens

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.

Events

Your application can listen to webhooks about this resource. The events about Digital Wallet Tokens will have the categories "digital_wallet_token.created" or "digital_wallet_token.updated" .

The Digital Wallet Token object

{
  "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",
  "status": "active",
  "token_requestor": "apple_pay",
  "type": "digital_wallet_token",
  "updates": [
    {
      "status": "inactive",
      "timestamp": "2020-01-31T23:59:59Z"
    }
  ]
}

Attributes

card_id

string

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

More about Cards.

cardholder

dictionary

The cardholder information given when the Digital Wallet Token was created.

created_at

string

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

decline

dictionary

Nullable

If the Digital Wallet Token was declined during provisioning, details about the decline.

device

dictionary

The device that was used to create the Digital Wallet Token.

dynamic_primary_account_number

dictionary

Nullable

The redacted Dynamic Primary Account Number.

string

The Digital Wallet Token identifier.

status

enum

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

token_requestor

enum

The digital wallet app being used.

type

string

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

updates

array

Updates to the Digital Wallet Token.

List Digital Wallet Tokens

curl \
  --url "${INCREASE_URL}/digital_wallet_tokens?card_id=card_oubs0hwk5rn6knuecxg2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Digital Wallet Token object */ },
    { /* Digital Wallet Token object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

card_id

string

Filter Digital Wallet Tokens to ones belonging to the specified Card.

More about Cards.

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Retrieve a Digital Wallet Token

curl \
  --url "${INCREASE_URL}/digital_wallet_tokens/digital_wallet_token_izi62go3h51p369jrie0" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

digital_wallet_token_id

string

Required

The identifier of the Digital Wallet Token.

More about Digital Wallet Tokens.

Sandbox: Create a digital wallet token request

Simulates a user attempting to add a Card to a digital wallet such as Apple Pay.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/digital_wallet_token_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "card_id": "card_oubs0hwk5rn6knuecxg2"
  }'

Returns a Inbound Digital Wallet Token Request Simulation Result object:

{
  "decline_reason": null,
  "digital_wallet_token_id": "digital_wallet_token_izi62go3h51p369jrie0",
  "type": "inbound_digital_wallet_token_request_simulation_result"
}

Parameters

card_id

string

Required

The identifier of the Card to be authorized.

More about Cards.