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.

Events

Your application can listen to webhooks about this resource. All of the events about Digital Wallet Token Requests will have the category "digital_wallet_token_request.created" .

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.

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const digitalWalletTokenRequest of client.digitalWalletTokenRequests.list()) {
  console.log(digitalWalletTokenRequest.id);
}

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.digital_wallet_token_requests.list()
page = page.data[0]
print(page.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.digital_wallet_token_requests.list

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.DigitalWalletTokenRequests.List(context.TODO(), increase.DigitalWalletTokenRequestListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequestListPage;
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequestListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalWalletTokenRequestListPage page = client.digitalWalletTokenRequests().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequestListPage
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequestListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val page: DigitalWalletTokenRequestListPage = client.digitalWalletTokenRequests().list()
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->digitalWalletTokenRequests->list(
    cardID: 'card_id',
    createdAt: [
      'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    ],
    cursor: 'cursor',
    limit: 1,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalWalletTokenRequests;

IncreaseClient client = new();

DigitalWalletTokenRequestListParams parameters = new();

var page = await client.DigitalWalletTokenRequests.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const digitalWalletTokenRequest = await client.digitalWalletTokenRequests.retrieve(
  'digital_wallet_token_request_dlsq0yabf7ev4xvke6ek',
);

console.log(digitalWalletTokenRequest.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
digital_wallet_token_request = client.digital_wallet_token_requests.retrieve(
    "digital_wallet_token_request_dlsq0yabf7ev4xvke6ek",
)
print(digital_wallet_token_request.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

digital_wallet_token_request = increase.digital_wallet_token_requests.retrieve("digital_wallet_token_request_dlsq0yabf7ev4xvke6ek")

puts(digital_wallet_token_request)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	digitalWalletTokenRequest, err := client.DigitalWalletTokenRequests.Get(context.TODO(), "digital_wallet_token_request_dlsq0yabf7ev4xvke6ek")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", digitalWalletTokenRequest.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequest;
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequestRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalWalletTokenRequest digitalWalletTokenRequest = client.digitalWalletTokenRequests().retrieve("digital_wallet_token_request_dlsq0yabf7ev4xvke6ek");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequest
import com.increase.api.models.digitalwallettokenrequests.DigitalWalletTokenRequestRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val digitalWalletTokenRequest: DigitalWalletTokenRequest = client.digitalWalletTokenRequests().retrieve("digital_wallet_token_request_dlsq0yabf7ev4xvke6ek")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $digitalWalletTokenRequest = $client->digitalWalletTokenRequests->retrieve(
    'digital_wallet_token_request_dlsq0yabf7ev4xvke6ek'
  );

  var_dump($digitalWalletTokenRequest);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalWalletTokenRequests;

IncreaseClient client = new();

DigitalWalletTokenRequestRetrieveParams parameters = new()
{
    DigitalWalletTokenRequestID = "digital_wallet_token_request_dlsq0yabf7ev4xvke6ek",
};

var digitalWalletTokenRequest = await client.DigitalWalletTokenRequests.Retrieve(parameters);

Console.WriteLine(digitalWalletTokenRequest);

Parameters

digital_wallet_token_request_id

string

Required

The identifier of the Digital Wallet Token Request.

More about Digital Wallet Token Requests.