Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Sandbox: Create a digital wallet token request

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

post/simulations/digital_wallet_token_requests

Request body

card_idstring required

The identifier of the Card to be authorized.

Example request

{
  "card_id": "card_oubs0hwk5rn6knuecxg2"
}

Response

Inbound Digital Wallet Token Request Simulation Result

decline_reason'card_not_active' | 'no_verification_method' | 'webhook_timed_out' | 'webhook_declined' | 'incorrect_card_verification_code' | 'declined_by_token_requestor' nullable required

If the simulated tokenization attempt was declined, this field contains details as to why.

digital_wallet_token_idstring nullable required

If the simulated tokenization attempt was accepted, this field contains the id of the Digital Wallet Token that was created.

type'inbound_digital_wallet_token_request_simulation_result' required

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

Example response

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