Skip to main content
API Reference
Cards
Digital Wallet Token Requests

A Digital Wallet Token Request is created each time a digital wallet app, such as Apple Pay or Google Pay, requests to tokenize a Card.

The Digital Wallet Token Request object
{
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "created_at": "2020-01-31T23:59:59Z",
  "declined": null,
  "device": {
    "device_type": "mobile_phone",
    "identifier": "04393EADF4149002225811273840459271E36516DA4875FF",
    "ip_address": "1.2.3.4",
    "name": "My Work Phone"
  },
  "id": "digital_wallet_token_request_dlsq0yabf7ev4xvke6ek",
  "outcome": "provisioned",
  "provisioned": {
    "digital_wallet_token_id": "digital_wallet_token_izi62go3h51p369jrie0"
  },
  "token_reference_identifier": "DNITHE000000000000000000000",
  "token_requestor": "apple_pay",
  "type": "digital_wallet_token_request"
}
Attributes
card_id
string

The identifier of the Card the tokenization was requested for.

More about Cards.
created_at
string

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

declined
dictionary
Nullable

Details of the decline. Present if and only if outcome is declined.

device
dictionary

The device that requested the tokenization.

id
string

The Digital Wallet Token Request identifier.

outcome
enum

The outcome of the tokenization request.

provisioned
dictionary
Nullable

Details of the provisioned Digital Wallet Token. Present if and only if outcome is provisioned.

token_reference_identifier
string

The reference identifier assigned by the card network to the 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_request.

List Digital Wallet Token Requests
curl \
  --url "${INCREASE_URL}/digital_wallet_token_requests?card_id=card_oubs0hwk5rn6knuecxg2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a list response :
{
  "data": [
    { /* Digital Wallet Token Request object */ },
    { /* Digital Wallet Token Request object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}
Parameters
card_id
string

Filter Digital Wallet Token Requests to ones for the specified Card.

More about Cards.
More parameters
Retrieve a Digital Wallet Token Request
curl \
  --url "${INCREASE_URL}/digital_wallet_token_requests/digital_wallet_token_request_dlsq0yabf7ev4xvke6ek" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
digital_wallet_token_request_id
string
Required

The identifier of the Digital Wallet Token Request.