GET/
Use this endpoint if you use Marqeta only for tokenization as a service and are not a Marqeta card issuer.
If Marqeta is your card issuer, use the Digital Wallets Management endpoint instead.
/digitalwallettokens endpoint to retrieve a list of digital wallet tokens.
Header parameter
| Fields | Description |
|---|---|
| req-sys-id string Optional | Random pseudo-unique identifier of a request, used for troubleshooting between multiple parties. Usually a globally unique identifier (GUID). Allowable Values: 1–36 chars |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of resources to retrieve. Allowable Values: Any integer |
| start_index integer Optional | Sort order index of the first resource to retrieve. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource model |
| start_date string Optional | Date when the digital wallet token becomes active. Allowable Values: Format: yyyy-MM-dd |
| end_date string Optional | Expiration date of the digital wallet token. Allowable Values: Format: yyyy-MM-dd |
| pan_reference_id string Optional | Unique identifier of the digital wallet token’s primary account number (PAN) within the card network. This value may vary, depending on the digital wallet. For example, the pan_reference_id may be different in an Apple Wallet and a Google Wallet for the same digital wallet token.Allowable Values: 36 char max |
| token_reference_id string Optional | Unique identifier of the digital wallet token within the card network. The token_reference_id is unique at the card network level. This is the primary identifier for Visa.Allowable Values: 36 char max |
| correlation_id string Optional | Unique value representing a tokenization request (Mastercard only). Allowable Values: 36 char max |
| device_id string Optional | Unique identifier of the user’s device, as provided by the digital wallet provider during the provisioning process. Allowable Values: 36 char max |
| token_type string Optional | Comma-delimited list of digital wallet token types to display. Allowable Values: 255 char max Example Values: DEVICE_SECURE_ELEMENT, MERCHANT_CARD_ON_FILE, DEVICE_CLOUD_BASED, ECOMMERCE_DIGITAL_WALLET, PSEUDO_ACCOUNT. |
| token_requestor_name string Optional | 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: - Mastercard - APPLE_PAY, ANDROID_PAY, SAMSUNG_PAY- Visa - APPLE_PAY, ANDROID_PAY, SAMSUNG_PAY, MICROSOFT_PAY, VISA_CHECKOUT, FACEBOOK, NETFLIX, FITBIT_PAY, GARMIN_PAY |
| state string Optional | Comma-delimited list of digital wallet token states to display. Allowable Values: 255 char max Example Values: REQUESTED, REQUEST_DECLINED, TERMINATED, SUSPENDED, ACTIVE |
| embed string Optional | Optional embedded user object.Allowable Values: Existing user object |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of resources returned. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| start_index integer Returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| end_index integer Returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| data array of undefineds Conditionally returned | Array of digital wallet token objects. Allowable Values: Valid data array of one or more digital wallet token objects. Objects are returned as appropriate to your query. |
| data[].encrypted_data object Conditionally returned | Contains encrypted data about the token service provider, device, or address verification. Allowable Values: address_verification, device, token_service_provider |
| data[].encrypted_data.token_service_provider object Conditionally returned | Contains information held and provided by the token service provider (card network). This object is returned when relevant information is provided by the token service provider. Allowable Values: correlation_id, pan_reference_id, token_assurance_level, token_eligibility_decision, token_pan, token_reference_id, token_requestor_id, token_requestor_name, token_score, token_type |
| data[].encrypted_data.token_service_provider.pan_reference_id string Returned | Unique identifier of the digital wallet token’s PAN within the card network. This value may vary, depending on the digital wallet. For example, the pan_reference_id may be different in an Apple Wallet and a Google Wallet for the same digital wallet token.Allowable Values: 1–255 chars |
| data[].encrypted_data.token_service_provider.token_reference_id string Conditionally returned | Identifier that correlates the digital wallet token with the card network. This is the primary identifier for Visa. For Mastercard, this field is not populated until the token is active. Allowable Values: 255 char max |
| data[].encrypted_data.token_service_provider.correlation_id string Conditionally returned | Unique value representing a tokenization request (Mastercard only). Allowable Values: 14 char max |
| data[].encrypted_data.token_service_provider.token_requestor_id string Returned | Identifier of the token requestor. This identifier differs for each card network. Allowable Values: 1–50 chars |
| data[].encrypted_data.token_service_provider.token_requestor_name string Returned | Human-readable name for the token requestor. In your code, we recommend using the token requestor identifier instead, because it is immutable once it has been created. Allowable Values: 1–100 chars |
| data[].encrypted_data.token_service_provider.token_type string Returned | Comma-delimited list of digital wallet token types to display. Allowable Values: DEVICE_CLOUD_BASED, DEVICE_SECURE_ELEMENT, ECOMMERCE_DIGITAL_WALLET, MERCHANT_CARD_ON_FILE, PSEUDO_ACCOUNT |
| data[].encrypted_data.token_service_provider.token_assurance_level string Conditionally returned | Specifies the assurance level of the token-to-PAN binding as defined by the payment network. Represents a general risk value from 00 to 99.Allowable Values: 2 char max |
| data[].encrypted_data.token_service_provider.token_pan string Conditionally returned | Digital wallet token primary account number (PAN), also known as the Digital Account Number, Token Number, or Digital PAN (DPAN). Token PAN appears in masked format. To view the token PAN in clear text, use the /showtokenpan endpoint.Allowable Values: 19 char max |
| data[].encrypted_data.token_service_provider.token_expiration string Conditionally returned | Expiration of the digital wallet token. Allowable Values: Format: MMyy |
| data[].encrypted_data.token_service_provider.token_score string Conditionally returned | Token score assigned by the token service provider. This value is provided when it is received by the token service provider. Allowable Values: 25 char max |
| data[].encrypted_data.token_service_provider.token_eligibility_decision string Conditionally returned | Token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
| data[].encrypted_data.device object Conditionally returned | Contains data about the provisioned device. Allowable Values: device_id, ip_address, language_code, location, name, phone_number, type |
| data[].encrypted_data.device.type string Returned | Specifies the type of device being provisioned. This object is returned when relevant information is provided by the token service provider, typically for device-based digital wallets such as Google Wallet and Apple Wallet only. Allowable Values: APPLIANCE, GAMING_DEVICE, LAPTOP, MOBILE_PHONE, MOBILE_PHONE_OR_TABLET, PERSONAL_COMPUTER, TABLET, UNKNOWN, UNRECOGNIZED, WATCH, VEHICLE |
| data[].encrypted_data.device.device_id string Conditionally returned | Identity number of the device. This value is returned if it is available for a given digital wallet token. Allowable Values: 255 char max |
| data[].encrypted_data.device.phone_number string Conditionally returned | Telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, the last four digits, or null. Allowable Values: 20 char max |
| data[].encrypted_data.device.name string Conditionally returned | Name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
| data[].encrypted_data.device.location string Conditionally returned | Geographic coordinates of the device at the time of the tokenization request, as returned by the digital wallet provider. Allowable Values: 25 char max |
| data[].encrypted_data.device.ip_address string Conditionally returned | IPv4 address, as returned by the digital wallet provider. Allowable Values: 25 char max |
| data[].encrypted_data.device.language_code string Conditionally returned | Language the device is configured to use, such as eng for English.Allowable Values: 36 char max |
| data[].encrypted_data.address_verification object Conditionally returned | Contains the name and address of the cardholder for address verification. Allowable Values: name, postal_code, street_address |
| data[].encrypted_data.address_verification.name string Conditionally returned | Name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
| data[].encrypted_data.address_verification.street_address string Conditionally returned | Street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
| data[].encrypted_data.address_verification.postal_code string Conditionally returned | Postal code of the cardholder, such as a United States ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
| data[].card_token string Conditionally returned | Unique identifier of the card. Allowable Values: 1–36 chars |
| data[].created_time datetime Conditionally returned | Date and time when the resource was created, in UTC. Allowable Values: date-time Format: yyyy-MM-ddThh:mm:ssZ |
| data[].fulfillment_status string Conditionally returned | Digital wallet token’s provisioning status. Allowable Values: DECISION_GREEN, DECISION_RED, DECISION_YELLOW, PROVISIONED, REJECTED |
| data[].issuer_eligibility_decision string Conditionally returned | Card issuer’s recommendation as to whether the digital wallet token should be provisioned. Example values: 0000 (Approved), invalid.cid, avs.decline, token.activation, token.activation.verification.required.tspdecision, decision due to TSP risk managerAllowable Values: 255 char max |
| data[].last_modified_time datetime Conditionally returned | Date and time when the resource was created, in UTC. Allowable Values: date-time Format: yyyy-MM-ddThh:mm:ssZ |
| data[].state string Conditionally returned | Current state of the digital wallet token. Allowable Values: 1–255 chars |
| data[].state_reason string Conditionally returned | Descriptive reason for the current state of the digital wallet token. Allowable Values: 255 char max |
| data[].token string Conditionally returned | Unique identifier for the digital wallet token on the Marqeta platform. Allowable Values: 1–36 chars |
| data[].wallet_provider_profile object Conditionally returned | Contains information held and provided by the digital wallet provider. This object is returned when relevant information is provided by the digital wallet provider. Allowable Values: account, device_score, obs_result, pan_source, reason_code, risk_assessment |
| data[].wallet_provider_profile.account object Returned | Contains information related to the cardholder, as provided by the digital wallet provider. Allowable Values: email_address, id, score |
| data[].wallet_provider_profile.account.id string Returned | Digital wallet provider’s unique identity number for the cardholder. This identity number does not correlate with other information. Allowable Values: 1–255 chars |
| data[].wallet_provider_profile.account.email_address string Conditionally returned | Hashed version of the email address linked to the digital wallet. The exact hashing algorithm may vary, depending on the wallet and network. You can use this field to validate that email associated with digital wallet matches what is on file for the account. Data is hexBinary encoded.Allowable Values: Hex-encoded string |
| data[].wallet_provider_profile.account.score string Conditionally returned | Wallet provider’s account score, indicating the confidence level associated with the account. The scale ranges from 1 to 5, where 5 indicates the highest level of confidence. The value in this file may be presented with or without a leading 0. Allowable Values: 2 char max |
| data[].wallet_provider_profile.risk_assessment object Conditionally returned | Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token, as returned by the digital wallet provider. Allowable Values: score, version |
| data[].wallet_provider_profile.risk_assessment.score string Conditionally returned | Digital wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values: DECISION_GREEN, DECISION_RED, DECISION_YELLOW |
| data[].wallet_provider_profile.risk_assessment.version string Conditionally returned | Digital wallet provider’s risk version. NOTE: Changes in the version might indicate differences in other fields. Allowable Values: Version information, as provided by the wallet provider |
| data[].wallet_provider_profile.device_score string Conditionally returned | Wallet provider device score on a scale from 1 to 5, indicating the confidence level of the device, where 5 indicates the highest level of confidence. Allowable Values: 1 to 5 |
| data[].wallet_provider_profile.pan_source string Returned | Source from which the digital wallet provider obtained the card primary account number (PAN), as returned by the digital wallet provider. Allowable Values: CONTACTLESS_TAP, KEY_ENTERED, MOBILE_BANKING_APP, ON_FILE |
| data[].wallet_provider_profile.reason_code string Conditionally returned | Comma-separated list of wallet provider reason codes, describing the reason for the wallet provider’s provisioning decision. NOTE: This list of reason codes is subject to change. Apple Wallet (Visa/Mastercard), Google Wallet/Samsung Wallet (Mastercard only) - 01 - Cardholder’s wallet account is too new relative to launch. - 02 - Cardholder’s wallet account is too new relative to provisioning request. - 03 - Cardholder’s wallet account/card pair is newer than date threshold. - 04 - Changes made to account data within the account threshold. - 05 - Suspicious transactions linked to this account. - 06 - Account has not had activity in the last year. - 07 - Suspended cards in the secure element. - 08 - Device was put in lost mode in the last seven days for longer than the duration threshold. - 09 - The number of provisioning attempts on this device in 24 hours exceeds threshold. - 0A - There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours. - 0B - The card provisioning attempt contains a distinct name in excess of the threshold. - 0C - The device score is less than 3. - 0D - The account score is less than 4. - 0E - Device provisioning location outside of the cardholder’s wallet account home country. - 0G - Suspected fraud. - 0H - The phone number score is less than 3. Google Wallet/Samsung Wallet (Visa only) - A0 - Cardholder PAN associated with account within threshold days. - A1 - Wallet account holder name on file does not match cardholder entered name. - A2 - User’s account on device less than threshold days. - A3 - User account was created within threshold days. - A4 - Wallet account created within threshold days. - A5 - Changes made to account data within threshold days. - A6 - The number of provisioning attempts across all cards on this device in the last 24 hours exceeds the threshold. - A7 - The wallet account into which the card is being provisioned contains distinct names greater than threshold. - A8 - Device provisioning location outside of cardholder’s wallet account home country. - A9 - Suspended cards in the wallet account is greater than threshold. - AA - This account has not had activity within threshold period. - AB - Number of days since device was last reported lost is less than threshold days. - AC - Number of transactions in last 12 months less than threshold number. - AD - Number of active tokens greater than threshold. - AE - Number of devices with Same UserID with token is greater than threshold. - AF - Number of active tokens on all devices is greater than threshold. - AG - Issuer deferred ID&V decision. - AH - Issuer encrypted payment instrument data expired. - AI - User/device receiving encrypted payment instrument data is different than the one that is provisioning the token. - AL - Encrypted payment instrument data is pushed to a different device than the one that issuer application authenticated. - AM - Encrypted payment instrument data is pushed to a different user than the cardholder. - AN - Encrypted Payment Instrument Data is being pushed by the Issuer to the same device that the Issuer application authenticated, but without any upfront authentication. - AO - Encrypted Payment Instrument Data is being pushed by the Issuer to the same device that the Issuer application authenticated, but with successful upfront authentication. Allowable Values: 100 char max |