Digital Wallets Management
The Marqeta platform facilitates the use of digital wallets for storing tokenized cards and making payments. The API provides endpoints that enable mobile applications to provision tokens into a digital wallet. It also provides endpoints for retrieving digital wallet tokens and for managing their lifecycle through state transitions.
For an overview of digital wallet tokens, see Digital Wallets and Tokenization.
Create digital wallet token provision request for Apple Pay
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/applepay
Use this endpoint to return card data for use in provisioning a digital wallet token into Apple Pay.
The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your PCI compliance overhead.
Request body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
certificates
array of strings
|
Leaf and sub-CA certificates provided by Apple. Base 64 encoded. The first element of the array should be the leaf certificate, followed by the sub-CA. Allowable Values: One or more certificates provided by Apple |
device_type
string
|
The type of device into which the digital wallet token will be provisioned. Allowable Values:
|
nonce
string
|
One-time-use nonce provided by Apple for security purposes. Allowable Values: Base64 encoded nonce from Apple |
nonce_signature
string
|
Apple-provided signature to the nonce. Allowable Values: Base64 encoded nonce signature from Apple |
provisioning_app_version
string
|
Version of the application making the provisioning request. Used for debugging and fraud. Allowable Values: 1–50 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
activation_data
string
|
Cryptographic one-time passcode conforming to the payment network operator or service provider specifications. Allowable Values: 255 char max |
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
encrypted_pass_data
string
|
A payload encrypted with a shared key derived from the Apple Public Certificates and the generated ephemeral private key. Allowable Values: 255 char max |
ephemeral_public_key
string
|
The ephemeral public key used for the provisioning attempt. Allowable Values: 255 char max |
last_modified_time
datetime
|
Date and time when the digital wallet token provisioning request was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Create digital wallet token provision request for Google Wallet
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/androidpay
Use this endpoint to return card data for use in provisioning a digital wallet token into Google Wallet.
The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your PCI compliance overhead.
Request body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
device_id
string
|
The unique identifier of the user’s Google device as provided by Google during the provisioning process. Allowable Values: 1–24 chars |
device_type
string
|
The type of device into which the digital wallet token will be provisioned. Allowable Values:
|
provisioning_app_version
string
|
Version of the application making the provisioning request. Used for debugging and fraud. Allowable Values: 1–50 chars |
wallet_account_id
string
|
The user’s Google Wallet account ID, as provided by Google during the provisioning process. Allowable Values: 1–50 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_modified_time
datetime
|
Date and time when the digital wallet token provisioning request was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
push_tokenize_request_data
object
|
Contains details about a card tokenization push request. Allowable Values:
|
push_tokenize_request_data.card_type
string
|
Specifies the type of payment card. Allowable Values:
|
push_tokenize_request_data.display_name
string
|
The display name of the cardholder. Allowable Values: 255 char max |
push_tokenize_request_data.opaque_payment_card
string
|
An encrypted data field created by the issuer and passed to Google Wallet during the push provisioning process. Allowable Values: 255 char max |
push_tokenize_request_data.last_digits
string
|
The last four digits of the primary account number of the physical or virtual card. Allowable Values: 4 chars |
push_tokenize_request_data.network
string
|
Specifies the card network of the physical or virtual card. Allowable Values:
|
push_tokenize_request_data.token_service_provider
string
|
Specifies the network that provides the token service. Allowable Values:
|
push_tokenize_request_data.user_address
object
|
Specifies the cardholder address. Allowable Values: Existing |
push_tokenize_request_data.user_address.name
string
|
The name of the cardholder. Allowable Values: 40 char max |
push_tokenize_request_data.user_address.address1
string
|
The street address of the cardholder. Allowable Values: 255 char max |
push_tokenize_request_data.user_address.address2
string
|
Additional address information for the cardholder, such as a suite or apartment number.
Allowable Values: 255 char max |
push_tokenize_request_data.user_address.city
string
|
The city of the cardholder. Allowable Values: 255 char max |
push_tokenize_request_data.user_address.state
string
|
The two-character state or province code.
Allowable Values: 2 char |
push_tokenize_request_data.user_address.postal_code
string
|
The postal code of the cardholder, such as a ZIP code.
Allowable Values: 255 char max |
push_tokenize_request_data.user_address.country
string
|
The two-character ISO 3166-1 alpha-2 country code.
Allowable Values: 255 char max |
push_tokenize_request_data.user_address.phone
string
|
The phone number of the cardholder. Allowable Values: 255 char max |
Create digital wallet token provision request for Samsung Wallet
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/samsungpay
Note
This endpoint is limited in availability. For more information, contact your Marqeta representative.Use this endpoint to return card data for use in provisioning a digital wallet token into Samsung Wallet.
The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your PCI compliance overhead.
Request body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
device_id
string
|
The user’s Samsung device unique identifier as provided by Samsung during the provisioning process. Allowable Values: 1–24 chars |
device_type
string
|
The type of device into which the digital wallet token will be provisioned. Allowable Values:
|
provisioning_app_version
string
|
Version of the application making the provisioning request. Used for debugging and fraud. Allowable Values: 1–50 chars |
wallet_user_id
string
|
The user’s Samsung Wallet account ID, as provided by Samsung during the provisioning process. Allowable Values: 1–50 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_modified_time
datetime
|
Date and time when the digital wallet token provisioning request was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
push_tokenize_request_data
object
|
Contains details about a card tokenization push request. Allowable Values:
|
push_tokenize_request_data.card_type
string
|
Specifies the type of payment card. Allowable Values:
|
push_tokenize_request_data.display_name
string
|
The display name of the cardholder. Allowable Values: 255 char max |
push_tokenize_request_data.extra_provision_payload
string
|
Encrypted card or cardholder details. Allowable Values: 255 char max |
push_tokenize_request_data.last_digits
string
|
The last four digits of the primary account number of the physical or virtual card. Allowable Values: 4 chars |
push_tokenize_request_data.network
string
|
Specifies the card network of the physical or virtual card. Allowable Values:
|
push_tokenize_request_data.token_service_provider
string
|
Specifies the network that provides the token service, as determined by the Samsung Wallet library. Allowable Values:
|
Create digital wallet token provision request for XPay
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/xpay
Note
This endpoint is limited in availability. For more information, contact your Marqeta representative.Use this endpoint to return card data for use in provisioning a digital wallet token into an XPay digital wallet.
The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your PCI compliance overhead.
Request body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
device_id
string
|
The unique identifier of the user’s XPay device as provided by XPay during the provisioning process. Allowable Values: 1–24 chars |
device_type
string
|
The type of device into which the digital wallet token will be provisioned. Allowable Values:
|
provisioning_app_version
string
|
Version of the application making the provisioning request. Used for debugging and fraud. Allowable Values: 1–50 chars |
token_requestor_id
string
|
Unique numerical identifier of the token requestor within the card network.
These ID numbers map to Mastercard
Visa
Allowable Values: 11 char max Example Values:
|
wallet_account_id
string
|
The user’s XPay account ID, as provided by XPay during the provisioning process. Allowable Values: 1–50 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_modified_time
datetime
|
Date and time when the digital wallet token provisioning request was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
push_tokenize_request_data
object
|
Contains details about a card tokenization push request. Allowable Values:
|
push_tokenize_request_data.card_type
string
|
Specifies the type of payment card. Allowable Values:
|
push_tokenize_request_data.display_name
string
|
The display name of the cardholder. Allowable Values: 255 char max |
push_tokenize_request_data.extra_provision_payload
string
|
Encrypted card or cardholder details. Allowable Values: 255 char max |
push_tokenize_request_data.last_digits
string
|
The last four digits of the primary account number of the physical or virtual card. Allowable Values: 4 chars |
push_tokenize_request_data.network
string
|
Specifies the card network of the physical or virtual card. Allowable Values:
|
push_tokenize_request_data.token_service_provider
string
|
Specifies the network that provides the token service. Allowable Values:
|
Create digital wallet token transition
Copy section link
Action: POST
Endpoint: /digitalwallettokentransitions
Use this endpoint to transition a digital wallet token from one state to another.
Request body
Copy section link
| Fields | Description |
|---|---|
channel
string
|
Mechanism by which the transition was initiated. Allowable Values:
|
digital_wallet_token
object
|
Contains identifiers for the digital wallet token and card objects. Allowable Values: Unique identifier for the digital wallet token and card objects |
digital_wallet_token.token
string
|
The unique identifier of the digital wallet token. Allowable Values: 1–36 chars |
digital_wallet_token.card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
reason
string
|
The reason for the transition. Allowable Values: 255 char max |
reason_code
string
|
The two-digit reason code for the transition:
Allowable Values:
|
state
string
|
Specifies the state to which the digital wallet token will transition. The original state is Allowable Values:
|
token
string
|
The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). If you do not include a value for the Allowable Values: 1–36 chars |
token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
card_swap
object
|
Contains identifiers for swapping digital wallet tokens between cards. Allowable Values:
|
card_swap.new_card_token
string
|
The unique identifier of the new payment card to which the digital wallet tokens are assigned. Allowable Values: 1–36 chars |
card_swap.previous_card_token
string
|
The unique identifier of the existing payment card that has digital wallet tokens assigned to it. Allowable Values: 1–36 chars |
channel
string
|
Mechanism by which the transition was initiated. Allowable Values:
|
created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
digital_wallet_token
object
|
Contains identifiers for the digital wallet token and card objects. Allowable Values: Unique identifier for the digital wallet token and card objects |
digital_wallet_token.token
string
|
The unique identifier of the digital wallet token. Allowable Values: 1–36 chars |
digital_wallet_token.card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
reason
string
|
The reason for the transition. Allowable Values: 255 char max |
reason_code
string
|
The two-digit reason code for the transition:
Allowable Values:
|
state
string
|
Specifies the state to which the digital wallet token is transitioning. Allowable Values:
|
token
string
|
The unique identifier of the digital wallet token transition, and not the identifier of the digital wallet token itself. Allowable Values: 1–36 chars |
type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
Retrieve digital wallet token transition
Copy section link
Action: GET
Endpoint: /digitalwallettokentransitions/{token}
Use this endpoint to retrieve a specific digital wallet token transition.
This endpoint supports field filtering.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the digital wallet token transition. Allowable Values: Existing digital wallet token transition token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
Response body
Copy section link
| Fields | Description |
|---|---|
card_swap
object
|
Contains identifiers for swapping digital wallet tokens between cards. Allowable Values:
|
card_swap.new_card_token
string
|
The unique identifier of the new payment card to which the digital wallet tokens are assigned. Allowable Values: 1–36 chars |
card_swap.previous_card_token
string
|
The unique identifier of the existing payment card that has digital wallet tokens assigned to it. Allowable Values: 1–36 chars |
channel
string
|
Mechanism by which the transition was initiated. Allowable Values:
|
created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
digital_wallet_token
object
|
Contains identifiers for the digital wallet token and card objects. Allowable Values: Unique identifier for the digital wallet token and card objects |
digital_wallet_token.token
string
|
The unique identifier of the digital wallet token. Allowable Values: 1–36 chars |
digital_wallet_token.card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
reason
string
|
The reason for the transition. Allowable Values: 255 char max |
reason_code
string
|
The two-digit reason code for the transition:
Allowable Values:
|
state
string
|
Specifies the state to which the digital wallet token is transitioning. Allowable Values:
|
token
string
|
The unique identifier of the digital wallet token transition, and not the identifier of the digital wallet token itself. Allowable Values: 1–36 chars |
type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
List transitions for digital wallet token
Copy section link
Action: GET
Endpoint: /digitalwallettokentransitions/digitalwallettoken/{token}
Use this endpoint to return an array of all transitions for a particular digital wallet token.
This endpoint supports field filtering, pagination, and sorting.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of digital wallet transitions to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first digital wallet token in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: 1-50 |
data
array of objects
|
Returns an array of digital wallet token transition objects. Allowable Values: One or more digital wallet token transition objects |
data[].card_swap
object
|
Contains identifiers for swapping digital wallet tokens between cards. Allowable Values:
|
data[].card_swap.new_card_token
string
|
The unique identifier of the new payment card to which the digital wallet tokens are assigned. Allowable Values: 1–36 chars |
data[].card_swap.previous_card_token
string
|
The unique identifier of the existing payment card that has digital wallet tokens assigned to it. Allowable Values: 1–36 chars |
data[].channel
string
|
Mechanism by which the transition was initiated. Allowable Values:
|
data[].created_time
datetime
|
Date and time when the digital wallet provisioning request was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].digital_wallet_token
object
|
Contains identifiers for the digital wallet token and card objects. Allowable Values: Unique identifier for the digital wallet token and card objects |
data[].digital_wallet_token.token
string
|
The unique identifier of the digital wallet token. Allowable Values: 1–36 chars |
data[].digital_wallet_token.card_token
string
|
Identifies the card to use for the provision request. Allowable Values: 1–36 chars |
data[].fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
data[].reason
string
|
The reason for the transition. Allowable Values: 255 char max |
data[].reason_code
string
|
The two-digit reason code for the transition:
Allowable Values:
|
data[].state
string
|
Specifies the state to which the digital wallet token is transitioning. Allowable Values:
|
data[].token
string
|
The unique identifier of the digital wallet token transition, and not the identifier of the digital wallet token itself. Allowable Values: 1–36 chars |
data[].type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
List digital wallet tokens
Copy section link
Action: GET
Endpoint: /digitalwallettokens
Use this endpoint to retrieve a list of digital wallet tokens.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of digital wallet tokens to retrieve. Allowable Values: 1-50 |
start_index
integer
|
The sort order index of the first digital wallet token in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
start_date
string
|
Date when the digital wallet token becomes active. Allowable Values: Format: yyyy-MM-dd |
end_date
string
|
Expiration date of the digital wallet token. Allowable Values: Format: yyyy-MM-dd |
pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary, depending on the digital wallet.
For example, the Allowable Values: 255 char max |
token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
correlation_id
string
|
The unique value representing a tokenization request (Mastercard only). Allowable Values: 255 char max |
token_type
string
|
Comma-delimited list of digital wallet token types to display. Allowable Values: 255 char max Example Values:
|
token_requestor_name
string
|
Name of the token requestor within the card network. NOTE: The list of example values for this field is maintained by the card networks and is subject to change. Allowable Values: 255 char max Example Values:
|
state
string
|
Comma-delimited list of digital wallet token states to display. Allowable Values: 255 char max Example Values:
|
embed
string
|
An optional embedded Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: 1-50 |
data
array of objects
|
Returns an array of digital wallet token objects. Allowable Values: One or more digital wallet token objects |
data[].address_verification
object
|
Contains address verification information. Allowable Values: Existing |
data[].address_verification.name
string
|
The name of the cardholder. Allowable Values: 40 char max |
data[].address_verification.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].address_verification.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].address_verification.zip
string
|
ZIP code. Allowable Values: 10 char max |
data[].card_token
string
|
Unique identifier of the card. Allowable Values: Existing card token |
data[].created_time
datetime
|
Date and time when the digital wallet token object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].device
object
|
Contains information related to the device being provisioned. Allowable Values: Existing |
data[].device.device_id
string
|
Identity number of the device. Allowable Values: 20 char max |
data[].device.ip_address
string
|
Device’s IP address. Allowable Values: IP address format, 50 char max |
data[].device.language_code
string
|
Language the device is configured to use. Allowable Values: 50 char max |
data[].device.location
string
|
Geographic coordinates of the device. Allowable Values: Latitude and longitude in NOTE: Both the longitude and latitude are prefixed with either a |
data[].device.name
string
|
Name of the device. Allowable Values: 50 char max |
data[].device.phone_number
string
|
Device’s telephone number. Allowable Values: 50 char max |
data[].device.token
string
|
Unique identifier of the device object. Allowable Values: 36 char max |
data[].device.type
string
|
Type of device being provisioned. Allowable Values:
|
data[].fulfillment_status
string
|
Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create Digital Wallet Token Transition. Allowable Values:
|
data[].issuer_eligibility_decision
string
|
The Marqeta platform’s decision as to whether the digital wallet token should be provisioned.
For all other values, check the value of the NOTE: The value Allowable Values: 0000, |
data[].last_modified_time
datetime
|
Date and time when the digital wallet token object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].metadata
object
|
Contains additional information about the digital wallet token. Allowable Values: Existing |
data[].metadata.cardproduct_preferred_notification_language
string
|
The language specified in the The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes. Allowable Values:
|
data[].metadata.issuer_product_config_id
string
|
The unique identifier of the product configuration on the Marqeta platform. Allowable Values: 255 char max |
data[].state
string
|
State of the digital wallet token. For state descriptions, see Transitioning Token States. Allowable Values:
|
data[].state_reason
string
|
Reason why the digital wallet token transitioned to its current state. Allowable Values: 255 char max |
data[].token
string
|
Unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token. |
data[].token_service_provider
object
|
Contains information held and provided by the token service provider (card network). Allowable Values: Existing |
data[].token_service_provider.correlation_id
string
|
The unique value representing a tokenization request (Mastercard only). Allowable Values: Existing correlation identifier |
data[].token_service_provider.pan_reference_id
string
|
Unique identifier of the digital wallet token PAN within the card network. Allowable Values: Existing PAN Reference ID |
data[].token_service_provider.token_assurance_level
string
|
(Mastercard only) Represents the confidence level in the digital wallet token. Allowable Values: 0-99 |
data[].token_service_provider.token_eligibility_decision
string
|
Digital wallet’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
data[].token_service_provider.token_expiration
string
|
Expiration date of the digital wallet token. Allowable Values: Format: MMyy |
data[].token_service_provider.token_pan
string
|
Primary account number (PAN) of the digital wallet token. Allowable Values: 16 char max |
data[].token_service_provider.token_reference_id
string
|
Unique identifier of the digital wallet token within the card network. Allowable Values: Existing Token Reference ID |
data[].token_service_provider.token_requestor_id
string
|
Unique numerical identifier of the token requestor within the card network.
These ID numbers map to Mastercard
Visa
Allowable Values: 11 char max Example Values:
|
data[].token_service_provider.token_requestor_name
string
|
Name of the token requestor within the card network. NOTE: The list of example values for this field is maintained by the card networks and is subject to change. Allowable Values: 255 char max Example Values:
|
data[].token_service_provider.token_score
string
|
Token score assigned by the digital wallet. Allowable Values: 25 char max |
data[].token_service_provider.token_type
string
|
Type of the digital wallet token. Allowable Values:
|
data[].user
object
|
Contains information about a cardholder. Allowable Values: Existing |
data[].user.account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
data[].user.active
boolean
|
Specifies if the cardholder is in the Allowable Values:
|
data[].user.address1
string
|
Cardholder’s address. Allowable Values: 255 char max |
data[].user.address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
data[].user.authentication
object
|
Contains the cardholder’s email address and password information. Allowable Values:
|
data[].user.authentication.email_verified
boolean
|
Specifies whether the email address has been verified. Allowable Values:
|
data[].user.authentication.email_verified_time
datetime
|
The date and time when the email address was verified. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
data[].user.authentication.last_password_update_time
datetime
|
The date and time when the password was last changed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.birth_date
string
|
Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
data[].user.business_token
string
|
The unique identifier of the Allowable Values: Existing |
data[].user.city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
data[].user.company
string
|
Company name. Allowable Values: 255 char max |
data[].user.corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
data[].user.country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
data[].user.created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.email
string
|
Valid email address of the cardholder. Allowable Values: 1–255 chars |
data[].user.first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
data[].user.gender
string
|
Cardholder’s gender. Allowable Values:
|
data[].user.honorific
string
|
Cardholder’s title or prefix: Ms., Mr., Miss, Mrs., and so on. Allowable Values: 10 char max |
data[].user.id_card_expiration_date
string
|
The expiration date of the cardholder’s identification card. Allowable Values: Format: yyyy-MM-dd |
data[].user.id_card_number
string
|
The cardholder’s identification card number. Allowable Values: 255 char max |
data[].user.identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: One or more identification objects |
data[].user.identifications[].expiration_date
string
|
The expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
data[].user.identifications[].type
string
|
The form of identification. Allowable Values:
|
data[].user.identifications[].value
string
|
The identification number associated with the form of identification. Allowable Values: 255 char max |
data[].user.ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
data[].user.last_modified_time
datetime
|
The date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
data[].user.metadata
object
|
Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
data[].user.middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
data[].user.nationality
string
|
Cardholder’s nationality. Allowable Values: 255 char max |
data[].user.notes
string
|
Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
data[].user.parent_token
string
|
The unique identifier of a Allowable Values: 1–36 chars |
data[].user.passport_expiration_date
string
|
The expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
data[].user.passport_number
string
|
Cardholder’s passport number. Allowable Values: 40 char max |
data[].user.password
string
|
Cardholder’s Allowable Values: 1–255 chars |
data[].user.phone
string
|
Cardholder’s telephone number. Allowable Values: 255 char max |
data[].user.postal_code
string
|
Postal code of the cardholder’s address. Allowable Values: 10 char max |
data[].user.ssn
string
|
The cardholder’s Social Security Number. Allowable Values: Nine digits only, no delimiters. |
data[].user.state
string
|
State in which the cardholder resides. Allowable Values: 2 char max |
data[].user.status
string
|
Specifies the status of the cardholder on the Marqeta platform. Allowable Values:
|
data[].user.token
string
|
The unique identifier of the cardholder. Allowable Values: 1–36 chars |
data[].user.uses_parent_account
boolean
|
Indicates whether the child shares balances with the parent ( Allowable Values:
|
data[].user.zip
string
|
ZIP code of the cardholder’s address. Allowable Values: 10 char max |
data[].wallet_provider_profile
object
|
Contains information held and provided by the digital wallet provider. Allowable Values: Existing |
data[].wallet_provider_profile.account
object
|
Contains information related to the cardholder and provided by the digital wallet provider. Allowable Values: Existing |
data[].wallet_provider_profile.account.email_address
string
|
Digital wallet provider’s email address for the cardholder. Allowable Values: 255 char max |
data[].wallet_provider_profile.account.id
string
|
Digital wallet provider’s identity number for the cardholder. Allowable Values: 20 char max |
data[].wallet_provider_profile.account.score
string
|
Score from the digital wallet provider. Allowable Values: 50 char max |
data[].wallet_provider_profile.device_score
string
|
Score from the device. Allowable Values: 50 char max |
data[].wallet_provider_profile.pan_source
string
|
Source from which the digital wallet provider obtained the card PAN. Allowable Values:
|
data[].wallet_provider_profile.reason_code
string
|
Reason for the wallet provider’s provisioning decision.
Allowable Values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G |
data[].wallet_provider_profile.recommendation_reasons
array of strings
|
An array of recommendation reasons from the digital wallet provider. Allowable Values: One or more recommendation reasons |
data[].wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token. Allowable Values: Existing |
data[].wallet_provider_profile.risk_assessment.score
string
|
Wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
data[].wallet_provider_profile.risk_assessment.version
string
|
Wallet provider’s risk assessment version. Allowable Values: Version information, as provided by the wallet provider |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Retrieve digital wallet token
Copy section link
Action: GET
Endpoint: /digitalwallettokens/{token}
Use this endpoint to retrieve a specific digital wallet token.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token token |
Response body
Copy section link
| Fields | Description |
|---|---|
address_verification
object
|
Contains address verification information. Allowable Values: Existing |
address_verification.name
string
|
The name of the cardholder. Allowable Values: 40 char max |
address_verification.postal_code
string
|
Postal code. Allowable Values: 10 char max |
address_verification.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
address_verification.zip
string
|
ZIP code. Allowable Values: 10 char max |
card_token
string
|
Unique identifier of the card. Allowable Values: Existing card token |
created_time
datetime
|
Date and time when the digital wallet token object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
device
object
|
Contains information related to the device being provisioned. Allowable Values: Existing |
device.device_id
string
|
Identity number of the device. Allowable Values: 20 char max |
device.ip_address
string
|
Device’s IP address. Allowable Values: IP address format, 50 char max |
device.language_code
string
|
Language the device is configured to use. Allowable Values: 50 char max |
device.location
string
|
Geographic coordinates of the device. Allowable Values: Latitude and longitude in NOTE: Both the longitude and latitude are prefixed with either a |
device.name
string
|
Name of the device. Allowable Values: 50 char max |
device.phone_number
string
|
Device’s telephone number. Allowable Values: 50 char max |
device.token
string
|
Unique identifier of the device object. Allowable Values: 36 char max |
device.type
string
|
Type of device being provisioned. Allowable Values:
|
fulfillment_status
string
|
Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create Digital Wallet Token Transition. Allowable Values:
|
issuer_eligibility_decision
string
|
The Marqeta platform’s decision as to whether the digital wallet token should be provisioned.
For all other values, check the value of the NOTE: The value Allowable Values: 0000, |
last_modified_time
datetime
|
Date and time when the digital wallet token object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
metadata
object
|
Contains additional information about the digital wallet token. Allowable Values: Existing |
metadata.cardproduct_preferred_notification_language
string
|
The language specified in the The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes. Allowable Values:
|
metadata.issuer_product_config_id
string
|
The unique identifier of the product configuration on the Marqeta platform. Allowable Values: 255 char max |
state
string
|
State of the digital wallet token. For state descriptions, see Transitioning Token States. Allowable Values:
|
state_reason
string
|
Reason why the digital wallet token transitioned to its current state. Allowable Values: 255 char max |
token
string
|
Unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token. |
token_service_provider
object
|
Contains information held and provided by the token service provider (card network). Allowable Values: Existing |
token_service_provider.correlation_id
string
|
The unique value representing a tokenization request (Mastercard only). Allowable Values: Existing correlation identifier |
token_service_provider.pan_reference_id
string
|
Unique identifier of the digital wallet token PAN within the card network. Allowable Values: Existing PAN Reference ID |
token_service_provider.token_assurance_level
string
|
(Mastercard only) Represents the confidence level in the digital wallet token. Allowable Values: 0-99 |
token_service_provider.token_eligibility_decision
string
|
Digital wallet’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
token_service_provider.token_expiration
string
|
Expiration date of the digital wallet token. Allowable Values: Format: MMyy |
token_service_provider.token_pan
string
|
Primary account number (PAN) of the digital wallet token. Allowable Values: 16 char max |
token_service_provider.token_reference_id
string
|
Unique identifier of the digital wallet token within the card network. Allowable Values: Existing Token Reference ID |
token_service_provider.token_requestor_id
string
|
Unique numerical identifier of the token requestor within the card network.
These ID numbers map to Mastercard
Visa
Allowable Values: 11 char max Example Values:
|
token_service_provider.token_requestor_name
string
|
Name of the token requestor within the card network. NOTE: The list of example values for this field is maintained by the card networks and is subject to change. Allowable Values: 255 char max Example Values:
|
token_service_provider.token_score
string
|
Token score assigned by the digital wallet. Allowable Values: 25 char max |
token_service_provider.token_type
string
|
Type of the digital wallet token. Allowable Values:
|
user
object
|
Contains information about a cardholder. Allowable Values: Existing |
user.account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
user.active
boolean
|
Specifies if the cardholder is in the Allowable Values:
|
user.address1
string
|
Cardholder’s address. Allowable Values: 255 char max |
user.address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
user.authentication
object
|
Contains the cardholder’s email address and password information. Allowable Values:
|
user.authentication.email_verified
boolean
|
Specifies whether the email address has been verified. Allowable Values:
|
user.authentication.email_verified_time
datetime
|
The date and time when the email address was verified. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
user.authentication.last_password_update_time
datetime
|
The date and time when the password was last changed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.birth_date
string
|
Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
user.business_token
string
|
The unique identifier of the Allowable Values: Existing |
user.city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
user.company
string
|
Company name. Allowable Values: 255 char max |
user.corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
user.country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
user.created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.email
string
|
Valid email address of the cardholder. Allowable Values: 1–255 chars |
user.first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
user.gender
string
|
Cardholder’s gender. Allowable Values:
|
user.honorific
string
|
Cardholder’s title or prefix: Ms., Mr., Miss, Mrs., and so on. Allowable Values: 10 char max |
user.id_card_expiration_date
string
|
The expiration date of the cardholder’s identification card. Allowable Values: Format: yyyy-MM-dd |
user.id_card_number
string
|
The cardholder’s identification card number. Allowable Values: 255 char max |
user.identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: One or more identification objects |
user.identifications[].expiration_date
string
|
The expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
user.identifications[].type
string
|
The form of identification. Allowable Values:
|
user.identifications[].value
string
|
The identification number associated with the form of identification. Allowable Values: 255 char max |
user.ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
user.last_modified_time
datetime
|
The date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
user.metadata
object
|
Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
user.middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
user.nationality
string
|
Cardholder’s nationality. Allowable Values: 255 char max |
user.notes
string
|
Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
user.parent_token
string
|
The unique identifier of a Allowable Values: 1–36 chars |
user.passport_expiration_date
string
|
The expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
user.passport_number
string
|
Cardholder’s passport number. Allowable Values: 40 char max |
user.password
string
|
Cardholder’s Allowable Values: 1–255 chars |
user.phone
string
|
Cardholder’s telephone number. Allowable Values: 255 char max |
user.postal_code
string
|
Postal code of the cardholder’s address. Allowable Values: 10 char max |
user.ssn
string
|
The cardholder’s Social Security Number. Allowable Values: Nine digits only, no delimiters. |
user.state
string
|
State in which the cardholder resides. Allowable Values: 2 char max |
user.status
string
|
Specifies the status of the cardholder on the Marqeta platform. Allowable Values:
|
user.token
string
|
The unique identifier of the cardholder. Allowable Values: 1–36 chars |
user.uses_parent_account
boolean
|
Indicates whether the child shares balances with the parent ( Allowable Values:
|
user.zip
string
|
ZIP code of the cardholder’s address. Allowable Values: 10 char max |
wallet_provider_profile
object
|
Contains information held and provided by the digital wallet provider. Allowable Values: Existing |
wallet_provider_profile.account
object
|
Contains information related to the cardholder and provided by the digital wallet provider. Allowable Values: Existing |
wallet_provider_profile.account.email_address
string
|
Digital wallet provider’s email address for the cardholder. Allowable Values: 255 char max |
wallet_provider_profile.account.id
string
|
Digital wallet provider’s identity number for the cardholder. Allowable Values: 20 char max |
wallet_provider_profile.account.score
string
|
Score from the digital wallet provider. Allowable Values: 50 char max |
wallet_provider_profile.device_score
string
|
Score from the device. Allowable Values: 50 char max |
wallet_provider_profile.pan_source
string
|
Source from which the digital wallet provider obtained the card PAN. Allowable Values:
|
wallet_provider_profile.reason_code
string
|
Reason for the wallet provider’s provisioning decision.
Allowable Values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G |
wallet_provider_profile.recommendation_reasons
array of strings
|
An array of recommendation reasons from the digital wallet provider. Allowable Values: One or more recommendation reasons |
wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token. Allowable Values: Existing |
wallet_provider_profile.risk_assessment.score
string
|
Wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
wallet_provider_profile.risk_assessment.version
string
|
Wallet provider’s risk assessment version. Allowable Values: Version information, as provided by the wallet provider |
List digital wallet tokens for card
Copy section link
Action: GET
Endpoint: /digitalwallettokens/card/{card_token}
Use this endpoint to return an array of all digital wallet tokens for a particular card.
This endpoint supports pagination.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
The token that identifies the card and correlates it with the card issuer. This token is used to minimize the need to exchange card details during subsequent calls, and also for troubleshooting. Use a globally unique identifier (GUID) or a pseudo-unique identifier for this token. Allowable Values: Existing card token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of digital wallet tokens to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first digital wallet token in the returned array. Allowable Values: Any integer |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: 1-50 |
data
array of objects
|
Returns an array of digital wallet token objects. Allowable Values: One or more digital wallet token objects |
data[].address_verification
object
|
Contains address verification information. Allowable Values: Existing |
data[].address_verification.name
string
|
The name of the cardholder. Allowable Values: 40 char max |
data[].address_verification.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].address_verification.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].address_verification.zip
string
|
ZIP code. Allowable Values: 10 char max |
data[].card_token
string
|
Unique identifier of the card. Allowable Values: Existing card token |
data[].created_time
datetime
|
Date and time when the digital wallet token object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].device
object
|
Contains information related to the device being provisioned. Allowable Values: Existing |
data[].device.device_id
string
|
Identity number of the device. Allowable Values: 20 char max |
data[].device.ip_address
string
|
Device’s IP address. Allowable Values: IP address format, 50 char max |
data[].device.language_code
string
|
Language the device is configured to use. Allowable Values: 50 char max |
data[].device.location
string
|
Geographic coordinates of the device. Allowable Values: Latitude and longitude in NOTE: Both the longitude and latitude are prefixed with either a |
data[].device.name
string
|
Name of the device. Allowable Values: 50 char max |
data[].device.phone_number
string
|
Device’s telephone number. Allowable Values: 50 char max |
data[].device.token
string
|
Unique identifier of the device object. Allowable Values: 36 char max |
data[].device.type
string
|
Type of device being provisioned. Allowable Values:
|
data[].fulfillment_status
string
|
Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create Digital Wallet Token Transition. Allowable Values:
|
data[].issuer_eligibility_decision
string
|
The Marqeta platform’s decision as to whether the digital wallet token should be provisioned.
For all other values, check the value of the NOTE: The value Allowable Values: 0000, |
data[].last_modified_time
datetime
|
Date and time when the digital wallet token object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].metadata
object
|
Contains additional information about the digital wallet token. Allowable Values: Existing |
data[].metadata.cardproduct_preferred_notification_language
string
|
The language specified in the The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes. Allowable Values:
|
data[].metadata.issuer_product_config_id
string
|
The unique identifier of the product configuration on the Marqeta platform. Allowable Values: 255 char max |
data[].state
string
|
State of the digital wallet token. For state descriptions, see Transitioning Token States. Allowable Values:
|
data[].state_reason
string
|
Reason why the digital wallet token transitioned to its current state. Allowable Values: 255 char max |
data[].token
string
|
Unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token. |
data[].token_service_provider
object
|
Contains information held and provided by the token service provider (card network). Allowable Values: Existing |
data[].token_service_provider.correlation_id
string
|
The unique value representing a tokenization request (Mastercard only). Allowable Values: Existing correlation identifier |
data[].token_service_provider.pan_reference_id
string
|
Unique identifier of the digital wallet token PAN within the card network. Allowable Values: Existing PAN Reference ID |
data[].token_service_provider.token_assurance_level
string
|
(Mastercard only) Represents the confidence level in the digital wallet token. Allowable Values: 0-99 |
data[].token_service_provider.token_eligibility_decision
string
|
Digital wallet’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
data[].token_service_provider.token_expiration
string
|
Expiration date of the digital wallet token. Allowable Values: Format: MMyy |
data[].token_service_provider.token_pan
string
|
Primary account number (PAN) of the digital wallet token. Allowable Values: 16 char max |
data[].token_service_provider.token_reference_id
string
|
Unique identifier of the digital wallet token within the card network. Allowable Values: Existing Token Reference ID |
data[].token_service_provider.token_requestor_id
string
|
Unique numerical identifier of the token requestor within the card network.
These ID numbers map to Mastercard
Visa
Allowable Values: 11 char max Example Values:
|
data[].token_service_provider.token_requestor_name
string
|
Name of the token requestor within the card network. NOTE: The list of example values for this field is maintained by the card networks and is subject to change. Allowable Values: 255 char max Example Values:
|
data[].token_service_provider.token_score
string
|
Token score assigned by the digital wallet. Allowable Values: 25 char max |
data[].token_service_provider.token_type
string
|
Type of the digital wallet token. Allowable Values:
|
data[].user
object
|
Contains information about a cardholder. Allowable Values: Existing |
data[].user.account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
data[].user.active
boolean
|
Specifies if the cardholder is in the Allowable Values:
|
data[].user.address1
string
|
Cardholder’s address. Allowable Values: 255 char max |
data[].user.address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
data[].user.authentication
object
|
Contains the cardholder’s email address and password information. Allowable Values:
|
data[].user.authentication.email_verified
boolean
|
Specifies whether the email address has been verified. Allowable Values:
|
data[].user.authentication.email_verified_time
datetime
|
The date and time when the email address was verified. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
data[].user.authentication.last_password_update_time
datetime
|
The date and time when the password was last changed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.birth_date
string
|
Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
data[].user.business_token
string
|
The unique identifier of the Allowable Values: Existing |
data[].user.city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
data[].user.company
string
|
Company name. Allowable Values: 255 char max |
data[].user.corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
data[].user.country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
data[].user.created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.email
string
|
Valid email address of the cardholder. Allowable Values: 1–255 chars |
data[].user.first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
data[].user.gender
string
|
Cardholder’s gender. Allowable Values:
|
data[].user.honorific
string
|
Cardholder’s title or prefix: Ms., Mr., Miss, Mrs., and so on. Allowable Values: 10 char max |
data[].user.id_card_expiration_date
string
|
The expiration date of the cardholder’s identification card. Allowable Values: Format: yyyy-MM-dd |
data[].user.id_card_number
string
|
The cardholder’s identification card number. Allowable Values: 255 char max |
data[].user.identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: One or more identification objects |
data[].user.identifications[].expiration_date
string
|
The expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
data[].user.identifications[].type
string
|
The form of identification. Allowable Values:
|
data[].user.identifications[].value
string
|
The identification number associated with the form of identification. Allowable Values: 255 char max |
data[].user.ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
data[].user.last_modified_time
datetime
|
The date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].user.last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
data[].user.metadata
object
|
Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
data[].user.middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
data[].user.nationality
string
|
Cardholder’s nationality. Allowable Values: 255 char max |
data[].user.notes
string
|
Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
data[].user.parent_token
string
|
The unique identifier of a Allowable Values: 1–36 chars |
data[].user.passport_expiration_date
string
|
The expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
data[].user.passport_number
string
|
Cardholder’s passport number. Allowable Values: 40 char max |
data[].user.password
string
|
Cardholder’s Allowable Values: 1–255 chars |
data[].user.phone
string
|
Cardholder’s telephone number. Allowable Values: 255 char max |
data[].user.postal_code
string
|
Postal code of the cardholder’s address. Allowable Values: 10 char max |
data[].user.ssn
string
|
The cardholder’s Social Security Number. Allowable Values: Nine digits only, no delimiters. |
data[].user.state
string
|
State in which the cardholder resides. Allowable Values: 2 char max |
data[].user.status
string
|
Specifies the status of the cardholder on the Marqeta platform. Allowable Values:
|
data[].user.token
string
|
The unique identifier of the cardholder. Allowable Values: 1–36 chars |
data[].user.uses_parent_account
boolean
|
Indicates whether the child shares balances with the parent ( Allowable Values:
|
data[].user.zip
string
|
ZIP code of the cardholder’s address. Allowable Values: 10 char max |
data[].wallet_provider_profile
object
|
Contains information held and provided by the digital wallet provider. Allowable Values: Existing |
data[].wallet_provider_profile.account
object
|
Contains information related to the cardholder and provided by the digital wallet provider. Allowable Values: Existing |
data[].wallet_provider_profile.account.email_address
string
|
Digital wallet provider’s email address for the cardholder. Allowable Values: 255 char max |
data[].wallet_provider_profile.account.id
string
|
Digital wallet provider’s identity number for the cardholder. Allowable Values: 20 char max |
data[].wallet_provider_profile.account.score
string
|
Score from the digital wallet provider. Allowable Values: 50 char max |
data[].wallet_provider_profile.device_score
string
|
Score from the device. Allowable Values: 50 char max |
data[].wallet_provider_profile.pan_source
string
|
Source from which the digital wallet provider obtained the card PAN. Allowable Values:
|
data[].wallet_provider_profile.reason_code
string
|
Reason for the wallet provider’s provisioning decision.
Allowable Values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G |
data[].wallet_provider_profile.recommendation_reasons
array of strings
|
An array of recommendation reasons from the digital wallet provider. Allowable Values: One or more recommendation reasons |
data[].wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token. Allowable Values: Existing |
data[].wallet_provider_profile.risk_assessment.score
string
|
Wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
data[].wallet_provider_profile.risk_assessment.version
string
|
Wallet provider’s risk assessment version. Allowable Values: Version information, as provided by the wallet provider |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Retrieve digital wallet token PAN
Copy section link
Action: GET
Endpoint: /digitalwallettokens/{token}/showtokenpan
Use this endpoint to retrieve a digital wallet token with the entire PAN displayed.
The PAN returned is of the digital wallet token and not of the card.
(For security reasons, the PAN is not fully visible on the digital wallet token returned by GET /digitalwallettokens/{token}.)
Warning
Sending a request to this endpoint requires PCI DSS compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder’s primary account number (PAN), personal identification number (PIN), and card expiration date.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token token |
Response body
Copy section link
| Fields | Description |
|---|---|
address_verification
object
|
Contains address verification information. Allowable Values: Existing |
address_verification.name
string
|
The name of the cardholder. Allowable Values: 40 char max |
address_verification.postal_code
string
|
Postal code. Allowable Values: 10 char max |
address_verification.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
address_verification.zip
string
|
ZIP code. Allowable Values: 10 char max |
card_token
string
|
Unique identifier of the card. Allowable Values: Existing card token |
created_time
datetime
|
Date and time when the digital wallet token object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
device
object
|
Contains information related to the device being provisioned. Allowable Values: Existing |
device.device_id
string
|
Identity number of the device. Allowable Values: 20 char max |
device.ip_address
string
|
Device’s IP address. Allowable Values: IP address format, 50 char max |
device.language_code
string
|
Language the device is configured to use. Allowable Values: 50 char max |
device.location
string
|
Geographic coordinates of the device. Allowable Values: Latitude and longitude in NOTE: Both the longitude and latitude are prefixed with either a |
device.name
string
|
Name of the device. Allowable Values: 50 char max |
device.phone_number
string
|
Device’s telephone number. Allowable Values: 50 char max |
device.token
string
|
Unique identifier of the device object. Allowable Values: 36 char max |
device.type
string
|
Type of device being provisioned. Allowable Values:
|
fulfillment_status
string
|
Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create Digital Wallet Token Transition. Allowable Values:
|
issuer_eligibility_decision
string
|
The Marqeta platform’s decision as to whether the digital wallet token should be provisioned.
For all other values, check the value of the NOTE: The value Allowable Values: 0000, |
last_modified_time
datetime
|
Date and time when the digital wallet token object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
metadata
object
|
Contains additional information about the digital wallet token. Allowable Values: Existing |
metadata.cardproduct_preferred_notification_language
string
|
The language specified in the The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes. Allowable Values:
|
metadata.issuer_product_config_id
string
|
The unique identifier of the product configuration on the Marqeta platform. Allowable Values: 255 char max |
state
string
|
State of the digital wallet token. For state descriptions, see Transitioning Token States. Allowable Values:
|
state_reason
string
|
Reason why the digital wallet token transitioned to its current state. Allowable Values: 255 char max |
token
string
|
Unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token. |
token_service_provider
object
|
Contains information held and provided by the token service provider (card network). Allowable Values: Existing |
token_service_provider.correlation_id
string
|
The unique value representing a tokenization request (Mastercard only). Allowable Values: Existing correlation identifier |
token_service_provider.pan_reference_id
string
|
Unique identifier of the digital wallet token PAN within the card network. Allowable Values: Existing PAN Reference ID |
token_service_provider.token_assurance_level
string
|
(Mastercard only) Represents the confidence level in the digital wallet token. Allowable Values: 0-99 |
token_service_provider.token_eligibility_decision
string
|
Digital wallet’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
token_service_provider.token_expiration
string
|
Expiration date of the digital wallet token. Allowable Values: Format: MMyy |
token_service_provider.token_pan
string
|
Primary account number (PAN) of the digital wallet token. Allowable Values: 16 char max |
token_service_provider.token_reference_id
string
|
Unique identifier of the digital wallet token within the card network. Allowable Values: Existing Token Reference ID |
token_service_provider.token_requestor_id
string
|
Unique numerical identifier of the token requestor within the card network.
These ID numbers map to Mastercard
Visa
Allowable Values: 11 char max Example Values:
|
token_service_provider.token_requestor_name
string
|
Name of the token requestor within the card network. NOTE: The list of example values for this field is maintained by the card networks and is subject to change. Allowable Values: 255 char max Example Values:
|
token_service_provider.token_score
string
|
Token score assigned by the digital wallet. Allowable Values: 25 char max |
token_service_provider.token_type
string
|
Type of the digital wallet token. Allowable Values:
|
user
object
|
Contains information about a cardholder. Allowable Values: Existing |
user.account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
user.active
boolean
|
Specifies if the cardholder is in the Allowable Values:
|
user.address1
string
|
Cardholder’s address. Allowable Values: 255 char max |
user.address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
user.authentication
object
|
Contains the cardholder’s email address and password information. Allowable Values:
|
user.authentication.email_verified
boolean
|
Specifies whether the email address has been verified. Allowable Values:
|
user.authentication.email_verified_time
datetime
|
The date and time when the email address was verified. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
user.authentication.last_password_update_time
datetime
|
The date and time when the password was last changed. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.birth_date
string
|
Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
user.business_token
string
|
The unique identifier of the Allowable Values: Existing |
user.city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
user.company
string
|
Company name. Allowable Values: 255 char max |
user.corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
user.country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
user.created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.email
string
|
Valid email address of the cardholder. Allowable Values: 1–255 chars |
user.first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
user.gender
string
|
Cardholder’s gender. Allowable Values:
|
user.honorific
string
|
Cardholder’s title or prefix: Ms., Mr., Miss, Mrs., and so on. Allowable Values: 10 char max |
user.id_card_expiration_date
string
|
The expiration date of the cardholder’s identification card. Allowable Values: Format: yyyy-MM-dd |
user.id_card_number
string
|
The cardholder’s identification card number. Allowable Values: 255 char max |
user.identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: One or more identification objects |
user.identifications[].expiration_date
string
|
The expiration date for the form of identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
user.identifications[].type
string
|
The form of identification. Allowable Values:
|
user.identifications[].value
string
|
The identification number associated with the form of identification. Allowable Values: 255 char max |
user.ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
user.last_modified_time
datetime
|
The date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
user.last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
user.metadata
object
|
Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format |
user.middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
user.nationality
string
|
Cardholder’s nationality. < |