Tokenization-as-a-Service (Beta)
Note
This feature is currently in beta and subject to change. It also requires additional activation steps. To learn more about the beta program for this feature and about activating it for your program, contact your Marqeta representative.Marqeta offers tokenization as a service, allowing you to use Marqeta’s tokenization features even if Marqeta is not your issuer processor.
-
Use the
/digitalwallettokensendpoint to retrieve digital wallet tokens by list, by card, or by individual token. -
Use the
/digitalwallettokentransitionsendpoint to create or retrieve digital wallet token transitions. -
Use the
/digitalwalletprovisionrequestsendpoints to instantly issue new virtual cards and provision digital wallets. -
Use the
/cardactionsendpoint to transfer digital wallet tokens to new cards, or update the expiry date of a digital wallet token. -
Use the
/webhooksendpoint to send optional customer notifications for system events.
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-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: A 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
|
The date when the digital wallet token can be active Allowable Values: Format: yyyy-MM-dd |
end_date
string
|
The 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 on a per-digital wallet basis.
For example, the Allowable Values: An existing PAN reference identifier |
token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: An existing token reference identifier |
correlation_id
string
|
The unique value representing a tokenization request (Mastercard only). Allowable Values: An existing correlation identifier |
token_type
string
|
Comma-delimited list of digital wallet token types to display.
Example values: Allowable Values: An existing token type |
token_requestor_name
string
|
Comma-delimited list of digital wallet token wallet providers to display.
Example values: Allowable Values: An existing token requestor name |
state
string
|
Comma-delimited list of digital wallet token states to display.
Example values: Allowable Values: An existing state |
embed
string
|
An optional embedded object, such as a card or a user. Allowable Values: An existing |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: Any integer |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
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:
|
data
array of objects
|
Contains the returned resources. Allowable Values: A valid |
data[].token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 36 char max |
data[].card_token
string
|
The token that identifies the card and correlates it with the card issuer. Allowable Values: An existing card token |
data[].state
string
|
The current state of the digital wallet token.
For example, Allowable Values: 255 char max |
data[].state_reason
string
|
A descriptive reason for the current state of the digital wallet token. Allowable Values: 255 char max |
data[].fulfillment_status
string
|
The digital wallet token’s provisioning status.
Example values: Allowable Values: 255 char max |
data[].issuer_eligibility_decision
string
|
The Marqeta platform’s recommendation as to whether the digital wallet token should be provisioned.
Example values: Allowable Values: 255 char max |
data[].wallet_provider_profile
object
|
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: A valid |
data[].wallet_provider_profile.account
object
|
Contains information related to the cardholder, as provided by the digital wallet provider. Allowable Values: A valid |
data[].wallet_provider_profile.account.id
string
|
The digital wallet provider’s unique identity number for the cardholder. This identity number does not correlate with other information. Allowable Values: 255 char max |
data[].wallet_provider_profile.account.email_address
string
|
A hashed version of the email address linked to the digital wallet. Allowable Values: 255 char max |
data[].wallet_provider_profile.account.score
string
|
The score from the digital wallet provider. This value is returned if it is provided by the digital wallet provider. Allowable Values: 255 char max |
data[].wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token, as returned by the digital wallet provider. Allowable Values: An existing |
data[].wallet_provider_profile.risk_assessment.score
string
|
The digital wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
data[].wallet_provider_profile.risk_assessment.version
string
|
The digital wallet provider’s risk version. Changes in the version may indicate differences in other fields. Allowable Values: 255 char max |
data[].wallet_provider_profile.device_score
string
|
The score from the device, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].wallet_provider_profile.pan_source
string
|
The source from which the digital wallet provider obtained the card PAN, as returned by the digital wallet provider. Allowable Values:
|
data[].wallet_provider_profile.reason_code
string
|
The reason for the digital wallet provider’s provisioning decision. Allowable Values: 100 char max |
data[].wallet_provider_profile.recommendation_reasons
array of strings
|
Provisioning decision recommendations, from Mastercard only. Allowable Values: A valid |
data[].created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].encrypted_data
object
|
The Allowable Values: An existing |
data[].encrypted_data.token_service_provider
object
|
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: An existing |
data[].encrypted_data.token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: An existing |
data[].encrypted_data.token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: An existing |
data[].encrypted_data.token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: An existing |
data[].encrypted_data.token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
data[].encrypted_data.token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
data[].encrypted_data.token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
data[].encrypted_data.token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: A valid |
data[].encrypted_data.token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
data[].encrypted_data.token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
data[].encrypted_data.token_service_provider.token_score
string
|
The 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
|
The 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
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
data[].encrypted_data.device.type
string
|
The type of device being provisioned. Allowable Values:
|
data[].encrypted_data.device.device_id
string
|
The 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
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
data[].encrypted_data.device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
data[].encrypted_data.device.location
string
|
The 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
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: An existing IP address |
data[].encrypted_data.device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
data[].encrypted_data.device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
data[].encrypted_data.address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: A valid |
data[].encrypted_data.address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].encrypted_data.address_verification.street_address
string
|
The 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
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
data[].token_service_provider
object
|
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: An existing |
data[].token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
data[].token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: An existing |
data[].token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: An existing |
data[].token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
data[].token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
data[].token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
data[].token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: An existing token PAN |
data[].token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
data[].token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
data[].token_service_provider.token_score
string
|
The 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[].token_service_provider.token_eligibility_decision
string
|
The token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
data[].device
object
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
data[].device.type
string
|
The type of device being provisioned. Allowable Values:
|
data[].device.device_id
string
|
The 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[].device.phone_number
string
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
data[].device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
data[].device.location
string
|
The 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[].device.ip_address
string
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: A valid IP address |
data[].device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
data[].device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
data[].address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
data[].address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].address_verification.street_address
string
|
The street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].address_verification.postal_code
string
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
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 Marqeta unique identifier for the digital wallet token. Allowable Values: An existing digital wallet token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 36 char max |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
state
string
|
The current state of the digital wallet token.
For example, Allowable Values: 255 char max |
state_reason
string
|
A descriptive reason for the current state of the digital wallet token. Allowable Values: 255 char max |
fulfillment_status
string
|
The digital wallet token’s provisioning status.
Example values: Allowable Values: 255 char max |
issuer_eligibility_decision
string
|
The Marqeta platform’s recommendation as to whether the digital wallet token should be provisioned.
Example values: Allowable Values: 255 char max |
wallet_provider_profile
object
|
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: A valid |
wallet_provider_profile.account
object
|
Contains information related to the cardholder, as provided by the digital wallet provider. Allowable Values: An existing |
wallet_provider_profile.account.id
string
|
The digital wallet provider’s unique identity number for the cardholder. This identity number does not correlate with other information. Allowable Values: 255 char max |
wallet_provider_profile.account.email_address
string
|
A hashed version of the email address linked to the digital wallet. Allowable Values: 255 char max |
wallet_provider_profile.account.score
string
|
The score from the digital wallet provider. This value is returned if it is provided by the digital wallet provider. Allowable Values: 255 char max |
wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token, as returned by the digital wallet provider. Allowable Values: An existing |
wallet_provider_profile.risk_assessment.score
string
|
The digital wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
wallet_provider_profile.risk_assessment.version
string
|
The digital wallet provider’s risk version. Changes in the version may indicate differences in other fields. Allowable Values: 255 char max |
wallet_provider_profile.device_score
string
|
The score from the device, as returned by the digital wallet provider. Allowable Values: 255 char max |
wallet_provider_profile.pan_source
string
|
The source from which the digital wallet provider obtained the card PAN, as returned by the digital wallet provider. Allowable Values:
|
wallet_provider_profile.reason_code
string
|
The reason for the digital wallet provider’s provisioning decision. Allowable Values: 100 char max |
wallet_provider_profile.recommendation_reasons
array of strings
|
Provisioning decision recommendations, from Mastercard only. Allowable Values: A valid |
created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
encrypted_data
object
|
The Allowable Values: An existing |
encrypted_data.token_service_provider
object
|
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: An existing |
encrypted_data.token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
encrypted_data.token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
encrypted_data.token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: 255 char max |
encrypted_data.token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
encrypted_data.token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
encrypted_data.token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
encrypted_data.token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: 255 char max |
encrypted_data.token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
encrypted_data.token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
encrypted_data.token_service_provider.token_score
string
|
The 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 |
encrypted_data.token_service_provider.token_eligibility_decision
string
|
The token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
encrypted_data.device
object
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
encrypted_data.device.type
string
|
The type of device being provisioned. Allowable Values:
|
encrypted_data.device.device_id
string
|
The identity number of the device. This value is returned if it is available for a given digital wallet token. Allowable Values: 255 char max |
encrypted_data.device.phone_number
string
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
encrypted_data.device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
encrypted_data.device.location
string
|
The geographic coordinates of the device at the time of the tokenization request, as returned by the digital wallet provider. Allowable Values: 25 char max |
encrypted_data.device.ip_address
string
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: A valid IP address |
encrypted_data.device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
encrypted_data.device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
encrypted_data.address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
encrypted_data.address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
encrypted_data.address_verification.street_address
string
|
The street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
encrypted_data.address_verification.postal_code
string
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
token_service_provider
object
|
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: An existing |
token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: 255 char max |
token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: 255 char max |
token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
token_service_provider.token_score
string
|
The 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 |
token_service_provider.token_eligibility_decision
string
|
The token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
device
object
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: A valid |
device.type
string
|
The type of device being provisioned. Allowable Values:
|
device.device_id
string
|
The identity number of the device. This value is returned if it is available for a given digital wallet token. Allowable Values: 255 char max |
device.phone_number
string
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
device.location
string
|
The geographic coordinates of the device at the time of the tokenization request, as returned by the digital wallet provider. Allowable Values: 25 char max |
device.ip_address
string
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: A valid IP address |
device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
address_verification.street_address
string
|
The street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
address_verification.postal_code
string
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
List digital wallet tokens by card
Copy section link
Action: GET
Endpoint: /digitalwallettokens/card/{card_token}
Retrieve a list of digital wallet tokens for the specified card.
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An 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-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
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:
|
data
array of objects
|
Contains the returned resources. Allowable Values: A valid |
data[].token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 36 char max |
data[].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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
data[].state
string
|
The current state of the digital wallet token.
For example, Allowable Values: 255 char max |
data[].state_reason
string
|
A descriptive reason for the current state of the digital wallet token. Allowable Values: 255 char max |
data[].fulfillment_status
string
|
The digital wallet token’s provisioning status.
Example values: Allowable Values: 255 char max |
data[].issuer_eligibility_decision
string
|
The Marqeta platform’s recommendation as to whether the digital wallet token should be provisioned.
Example values: Allowable Values: 255 char max |
data[].wallet_provider_profile
object
|
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: An existing |
data[].wallet_provider_profile.account
object
|
Contains information related to the cardholder, as provided by the digital wallet provider. Allowable Values: An existing |
data[].wallet_provider_profile.account.id
string
|
The digital wallet provider’s unique identity number for the cardholder. This identity number does not correlate with other information. Allowable Values: 255 char max |
data[].wallet_provider_profile.account.email_address
string
|
A hashed version of the email address linked to the digital wallet. Allowable Values: A valid email address |
data[].wallet_provider_profile.account.score
string
|
The score from the digital wallet provider. This value is returned if it is provided by the digital wallet provider. Allowable Values: 255 char max |
data[].wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token, as returned by the digital wallet provider. Allowable Values: An existing |
data[].wallet_provider_profile.risk_assessment.score
string
|
The digital wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
data[].wallet_provider_profile.risk_assessment.version
string
|
The digital wallet provider’s risk version. Changes in the version may indicate differences in other fields. Allowable Values: 255 char max |
data[].wallet_provider_profile.device_score
string
|
The score from the device, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].wallet_provider_profile.pan_source
string
|
The source from which the digital wallet provider obtained the card PAN, as returned by the digital wallet provider. Allowable Values:
|
data[].wallet_provider_profile.reason_code
string
|
The reason for the digital wallet provider’s provisioning decision. Allowable Values: 100 char max |
data[].wallet_provider_profile.recommendation_reasons
array of strings
|
Provisioning decision recommendations, from Mastercard only. Allowable Values: A valid |
data[].created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].encrypted_data
object
|
The Allowable Values: An existing |
data[].encrypted_data.token_service_provider
object
|
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: An existing |
data[].encrypted_data.token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
data[].encrypted_data.token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
data[].encrypted_data.token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: 255 char max |
data[].encrypted_data.token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
data[].encrypted_data.token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
data[].encrypted_data.token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
data[].encrypted_data.token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: 255 char max |
data[].encrypted_data.token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
data[].encrypted_data.token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
data[].encrypted_data.token_service_provider.token_score
string
|
The 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
|
The 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
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
data[].encrypted_data.device.type
string
|
The type of device being provisioned. Allowable Values:
|
data[].encrypted_data.device.device_id
string
|
The 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
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
data[].encrypted_data.device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
data[].encrypted_data.device.location
string
|
The 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
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: A valid IP address |
data[].encrypted_data.device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
data[].encrypted_data.device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
data[].encrypted_data.address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
data[].encrypted_data.address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].encrypted_data.address_verification.street_address
string
|
The 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
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
data[].token_service_provider
object
|
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: An existing |
data[].token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
data[].token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
data[].token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: 255 char max |
data[].token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
data[].token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
data[].token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
data[].token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: 255 char max |
data[].token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
data[].token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
data[].token_service_provider.token_score
string
|
The 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[].token_service_provider.token_eligibility_decision
string
|
The token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
data[].device
object
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
data[].device.type
string
|
The type of device being provisioned. Allowable Values:
|
data[].device.device_id
string
|
The 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[].device.phone_number
string
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
data[].device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
data[].device.location
string
|
The 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[].device.ip_address
string
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: A valid IP address |
data[].device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
data[].device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
data[].address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
data[].address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].address_verification.street_address
string
|
The street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
data[].address_verification.postal_code
string
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
Retrieve digital wallet token with PAN visible
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}.)
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: An existing digital wallet token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 36 char max |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
state
string
|
The current state of the digital wallet token.
For example, Allowable Values: 255 char max |
state_reason
string
|
A descriptive reason for the current state of the digital wallet token. Allowable Values: 255 char max |
fulfillment_status
string
|
The digital wallet token’s provisioning status.
Example values: Allowable Values: 255 char max |
issuer_eligibility_decision
string
|
The Marqeta platform’s recommendation as to whether the digital wallet token should be provisioned.
Example values: Allowable Values: 255 char max |
wallet_provider_profile
object
|
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: An existing |
wallet_provider_profile.account
object
|
Contains information related to the cardholder, as provided by the digital wallet provider. Allowable Values: An existing |
wallet_provider_profile.account.id
string
|
The digital wallet provider’s unique identity number for the cardholder. This identity number does not correlate with other information. Allowable Values: 255 char max |
wallet_provider_profile.account.email_address
string
|
A hashed version of the email address linked to the digital wallet. Allowable Values: 255 char max |
wallet_provider_profile.account.score
string
|
The score from the digital wallet provider. This value is returned if it is provided by the digital wallet provider. Allowable Values: 255 char max |
wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token, as returned by the digital wallet provider. Allowable Values: An existing |
wallet_provider_profile.risk_assessment.score
string
|
The digital wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
wallet_provider_profile.risk_assessment.version
string
|
The digital wallet provider’s risk version. Changes in the version may indicate differences in other fields. Allowable Values: 255 char max |
wallet_provider_profile.device_score
string
|
The score from the device, as returned by the digital wallet provider. Allowable Values: 255 char max |
wallet_provider_profile.pan_source
string
|
The source from which the digital wallet provider obtained the card PAN, as returned by the digital wallet provider. Allowable Values:
|
wallet_provider_profile.reason_code
string
|
The reason for the digital wallet provider’s provisioning decision. Allowable Values: 100 char max |
wallet_provider_profile.recommendation_reasons
array of strings
|
Provisioning decision recommendations, from Mastercard only. Allowable Values: A valid |
created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
encrypted_data
object
|
The Allowable Values: An existing |
encrypted_data.token_service_provider
object
|
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: An existing |
encrypted_data.token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
encrypted_data.token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
encrypted_data.token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: 255 char max |
encrypted_data.token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
encrypted_data.token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
encrypted_data.token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
encrypted_data.token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: 255 char max |
encrypted_data.token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
encrypted_data.token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
encrypted_data.token_service_provider.token_score
string
|
The 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 |
encrypted_data.token_service_provider.token_eligibility_decision
string
|
The token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
encrypted_data.device
object
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
encrypted_data.device.type
string
|
The type of device being provisioned. Allowable Values:
|
encrypted_data.device.device_id
string
|
The identity number of the device. This value is returned if it is available for a given digital wallet token. Allowable Values: 255 char max |
encrypted_data.device.phone_number
string
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
encrypted_data.device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
encrypted_data.device.location
string
|
The geographic coordinates of the device at the time of the tokenization request, as returned by the digital wallet provider. Allowable Values: 25 char max |
encrypted_data.device.ip_address
string
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: 255 char max |
encrypted_data.device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
encrypted_data.device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
encrypted_data.address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
encrypted_data.address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
encrypted_data.address_verification.street_address
string
|
The street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
encrypted_data.address_verification.postal_code
string
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
token_service_provider
object
|
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: An existing |
token_service_provider.pan_reference_id
string
|
The unique identifier of the digital wallet token PAN within the card network.
This value may vary on a per-digital wallet basis.
For example, the Allowable Values: 255 char max |
token_service_provider.token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: 255 char max |
token_service_provider.correlation_id
string
|
The unique identifier of the digital wallet token within the Mastercard card network. Allowable Values: 255 char max |
token_service_provider.token_requestor_id
string
|
The unique numerical identifier of the token requestor within the card network.
The Allowable Values: 50 char max |
token_service_provider.token_requestor_name
string
|
Specifies the name of the token requestor.
Example values: Allowable Values: 100 char max |
token_service_provider.token_type
string
|
The name of the token requestor within the card network. Allowable Values:
|
token_service_provider.token_pan
string
|
The digital wallet token primary account number (PAN), also known as Digital Account Number, Token Number, or Digital PAN (DPAN). These are unique only at a given point in time and are subject to reuse. This value is provided after a token is activated. The token PAN appears in masked format.
To view the token PAN in clear text, use the Allowable Values: 255 char max |
token_service_provider.token_expiration
string
|
The expiration date of the digital wallet token in Allowable Values: 4 char max |
token_service_provider.token_assurance_level
string
|
Specifies the assurance level of the token-to-PAN binding as defined by the payment network.
Represents a general risk value from Allowable Values: 2 char max |
token_service_provider.token_score
string
|
The 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 |
token_service_provider.token_eligibility_decision
string
|
The token service provider’s recommendation as to whether the digital wallet token should be provisioned. Allowable Values: 50 char max |
device
object
|
Contains information related to the 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 Pay and Apple Pay only. Allowable Values: An existing |
device.type
string
|
The type of device being provisioned. Allowable Values:
|
device.device_id
string
|
The identity number of the device. This value is returned if it is available for a given digital wallet token. Allowable Values: 255 char max |
device.phone_number
string
|
The telephone number of the device, as returned by the digital wallet provider. This value may be the full phone number, or just the last four digits. Allowable Values: 20 char max |
device.name
string
|
The name of the device, as returned by the digital wallet provider. Allowable Values: 128 char max |
device.location
string
|
The geographic coordinates of the device at the time of the tokenization request, as returned by the digital wallet provider. Allowable Values: 25 char max |
device.ip_address
string
|
The IP address of the device, as returned by the digital wallet provider. Allowable Values: A valid IP address |
device.token
string
|
The unique identifier of the device object. This value, along with the subsequent data block, is returned if it is available for a given digital wallet token. It is typically available for Google Pay, Samsung Pay, and Apple Pay but not for ecommerce token requestors such as PayPal. Allowable Values: 50 char max |
device.language_code
string
|
The language the device is configured to use. Allowable Values: 36 char max |
address_verification
object
|
Contains the name and address of the cardholder for address verification. Allowable Values: An existing |
address_verification.name
string
|
The name of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
address_verification.street_address
string
|
The street address of the cardholder, as returned by the digital wallet provider. Allowable Values: 255 char max |
address_verification.postal_code
string
|
The postal code of the cardholder, such as a ZIP code, as returned by the digital wallet provider. Allowable Values: 50 char max |
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 |
|---|---|
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 token field, the system will generate one automatically. This value is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
reason_code
string
|
The two-digit reason code for the transition. Allowable Values: Two digits |
token_reference_id
string
|
The unique identifier of the digital wallet token within the card network.
The Allowable Values: An existing |
channel
string
|
The mechanism by which the transition was initiated.
Allowable Values:
|
state
string
|
Specifies the state to which the digital wallet token transitions. Allowable Values:
|
digital_wallet_token
object
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: An existing |
digital_wallet_token.token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 1-36 chars |
reason
string
|
A descriptive reason for the transition. Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). Allowable Values: 1-36 chars |
digital_wallet_token
object
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: An existing |
digital_wallet_token.token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 1-36 chars |
card_swap
object
|
Specifies the old and new payment card tokens that were swapped. Allowable Values: An existing |
card_swap.previousCardToken
string
|
The existing payment card token that has digital wallet tokens assigned to it. Allowable Values: 1-36 chars |
card_swap.newCardToken
string
|
The new payment card token to which the digital wallet tokens are assigned. Allowable Values: 1-36 chars |
type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
channel
string
|
The mechanism by which the transition was initiated. Allowable Values:
|
state
string
|
Specifies the state to which the digital wallet token transitions. Allowable Values:
|
fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
reason
string
|
A descriptive reason for the transition. Allowable Values: 255 char max |
reason_code
string
|
The two-digit reason code for the transition. Allowable Values: Two digits |
created_time
datetime
|
The date and time when the digital wallet token transition was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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 specific digital wallet token.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The digital wallet token associated with the transitions. Allowable Values: An existing digital wallet token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of digital wallet token transitions to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first digital wallet token transition 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:
|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: A comma-delimited list of fields, or blank |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
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:
|
data
array of objects
|
Returns an array of objects related to the digital wallet token transition. Allowable Values: A valid |
data[].token
string
|
The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). Allowable Values: 1-36 chars |
data[].digital_wallet_token
object
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: An existing |
data[].digital_wallet_token.token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 1-36 chars |
data[].card_swap
object
|
Specifies the old and new payment card tokens that were swapped. Allowable Values: An existing |
data[].card_swap.previousCardToken
string
|
The existing payment card token that has digital wallet tokens assigned to it. Allowable Values: 1-36 chars |
data[].card_swap.newCardToken
string
|
The new payment card token to which the digital wallet tokens are assigned. Allowable Values: 1-36 chars |
data[].type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
data[].channel
string
|
The mechanism by which the transition was initiated. Allowable Values:
|
data[].state
string
|
Specifies the state to which the digital wallet token transitions. Allowable Values:
|
data[].fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
data[].reason
string
|
A descriptive reason for the transition. Allowable Values: 255 char max |
data[].reason_code
string
|
The two-digit reason code for the transition. Allowable Values: Two digits |
data[].created_time
datetime
|
The date and time when the digital wallet token transition was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve digital wallet token transition
Copy section link
Action: GET
Endpoint: /digitalwallettokentransitions/{token}
Retrieve a specific digital wallet token transition.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The transition token. Allowable Values: An existing transition token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: A comma-delimited list of fields, or blank |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
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:
|
data
array of objects
|
Returns an array of objects related to the digital wallet token transition. Allowable Values: A valid |
data[].token
string
|
The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). Allowable Values: 1-36 chars |
data[].digital_wallet_token
object
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: An existing |
data[].digital_wallet_token.token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 1-36 chars |
data[].card_swap
object
|
Specifies the old and new payment card tokens that were swapped. Allowable Values: An existing |
data[].card_swap.previousCardToken
string
|
The existing payment card token that has digital wallet tokens assigned to it. Allowable Values: 1-36 chars |
data[].card_swap.newCardToken
string
|
The new payment card token to which the digital wallet tokens are assigned. Allowable Values: 1-36 chars |
data[].type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
data[].channel
string
|
The mechanism by which the transition was initiated. Allowable Values:
|
data[].state
string
|
Specifies the state to which the digital wallet token transitions. Allowable Values:
|
data[].fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
data[].reason
string
|
A descriptive reason for the transition. Allowable Values: 255 char max |
data[].reason_code
string
|
The two-digit reason code for the transition. Allowable Values: Two digits |
data[].created_time
datetime
|
The date and time when the digital wallet token transition was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Create digital wallet provision request for Android Pay
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/androidpay
Create and validate Android Pay-specific provisioning request data.
Request body
Copy section link
| Fields | Description |
|---|---|
encrypted_card_data
object
|
The card details encrypted using JSON Web Encryption (JWE). Allowable Values: A valid |
encrypted_card_data.expiration
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
encrypted_card_data.expiration.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
encrypted_card_data.expiration.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
encrypted_card_data.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 GUID or a pseudo-unique identifier for this token. Allowable Values: 1-36 chars |
encrypted_card_data.primary_account_number
string
|
The primary account number of the card that is being tokenized. Typically expected to be 16 digits. Allowable Values: 12-19 chars |
encrypted_card_data.card_type
string
|
The type of card. This field is required for Samsung Pay. Allowable Values:
|
encrypted_card_data.cardholder_info
object
|
Contains the personal information of the cardholder. Allowable Values: A valid |
encrypted_card_data.cardholder_info.first_name
string
|
The first or given name of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.last_name
string
|
The last or family name of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.cardholder_address
object
|
The cardholder address. Allowable Values: A valid |
encrypted_card_data.cardholder_info.cardholder_address.address_line_1
string
|
The street address of the cardholder. Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.cardholder_address.address_line_2
string
|
Additional address information for the cardholder, such as a suite or apartment number.
Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.cardholder_address.postal_code
string
|
The postal code of the cardholder, such as a ZIP code.
Allowable Values: 1-10 chars |
encrypted_card_data.cardholder_info.cardholder_address.city
string
|
The city of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.cardholder_address.state
string
|
The two-character state or province code.
Allowable Values: 2 char max |
encrypted_card_data.cardholder_info.cardholder_address.country_code
string
|
The two-character ISO 3166-1 alpha-2 country code.
Allowable Values: 2 char max |
encrypted_card_data.cardholder_info.email_address
string
|
The email address of the cardholder.
Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.phone_number
string
|
The phone number of the cardholder. Allowable Values: 255 char max |
encrypted_card_data.metadata
array of objects
|
Additional metadata related to the card details object. Allowable Values: A valid |
encrypted_card_data.metadata[].name
string
|
The metadata attribute name.
Allowable Values: 255 char max |
encrypted_card_data.metadata[].value
string
|
The metadata attribute value. Allowable Values: 255 char max |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
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: 50 char max |
wallet_account_id
string
|
The user’s Google wallet account ID as provided by Google during the provisioning process. Allowable Values: 1-50 chars |
device_id
string
|
The user’s Google device ID; the device’s unique identifier as provided by Google during the provisioning process. Allowable Values: 1-24 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
created_time
datetime
|
The 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
|
The date and time when the digital wallet token provisioning request was last updated, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
push_tokenize_request_data
object
|
Specifies the data provided in the push tokenization request. Allowable Values: An existing |
push_tokenize_request_data.display_name
string
|
The display name of the cardholder. 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.opaque_payment_card
string
|
An encrypted data field created by the issuer and passed to Google Pay during the push provisioning process. Allowable Values: 255 char max |
push_tokenize_request_data.user_address
object
|
Specifies the cardholder address. Allowable Values: An existing |
push_tokenize_request_data.user_address.name
string
|
The name of the cardholder. Allowable Values: 255 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: Two char max |
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: Two char max |
push_tokenize_request_data.user_address.phone
string
|
The phone number of the cardholder.
Allowable Values: 255 char max |
Create digital wallet provision request for Samsung Pay
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/samsungpay
Create and validate Samsung Pay-specific provisioning request data.
Request body
Copy section link
| Fields | Description |
|---|---|
encrypted_card_data
object
|
The card details encrypted using JSON Web Encryption (JWE). Allowable Values: A valid |
encrypted_card_data.expiration
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
encrypted_card_data.expiration.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
encrypted_card_data.expiration.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
encrypted_card_data.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 GUID or a pseudo-unique identifier for this token. Allowable Values: 1-36 chars |
encrypted_card_data.primary_account_number
string
|
The primary account number of the card that is being tokenized. Typically expected to be 16 digits. Allowable Values: 12-19 chars |
encrypted_card_data.card_type
string
|
The type of card. This field is required for Samsung Pay. Allowable Values:
|
encrypted_card_data.cardholder_info
object
|
Contains the personal information of the cardholder. Allowable Values: A valid |
encrypted_card_data.cardholder_info.first_name
string
|
The first or given name of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.last_name
string
|
The last or family name of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.cardholder_address
object
|
The cardholder address. Allowable Values: A valid |
encrypted_card_data.cardholder_info.cardholder_address.address_line_1
string
|
The street address of the cardholder. Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.cardholder_address.address_line_2
string
|
Additional address information for the cardholder, such as a suite or apartment number.
Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.cardholder_address.postal_code
string
|
The postal code of the cardholder, such as a ZIP code.
Allowable Values: 1-10 chars |
encrypted_card_data.cardholder_info.cardholder_address.city
string
|
The city of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.cardholder_address.state
string
|
The two-character state or province code.
Allowable Values: 2 char max |
encrypted_card_data.cardholder_info.cardholder_address.country_code
string
|
The two-character ISO 3166-1 alpha-2 country code.
Allowable Values: 2 char max |
encrypted_card_data.cardholder_info.email_address
string
|
The email address of the cardholder.
Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.phone_number
string
|
The phone number of the cardholder. Allowable Values: 255 char max |
encrypted_card_data.metadata
array of objects
|
Additional metadata related to the card details object. Allowable Values: A valid |
encrypted_card_data.metadata[].name
string
|
The metadata attribute name.
Allowable Values: 255 char max |
encrypted_card_data.metadata[].value
string
|
The metadata attribute value. Allowable Values: 255 char max |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
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: 50 char max |
wallet_user_id
string
|
The user’s Samsung wallet account identifier as provided by Google during the provisioning process. Allowable Values: 1-50 chars |
device_id
string
|
The user’s Samsung device unique identifier as provided by Samsung during the provisioning process. Allowable Values: 1-24 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
created_time
datetime
|
The 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
|
The date and time when the digital wallet token provisioning request was last updated, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
push_tokenize_request_data
object
|
Returns tokenization request data. Allowable Values: An existing |
push_tokenize_request_data.display_name
string
|
The display name of the cardholder. 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 Pay library. Allowable Values:
|
push_tokenize_request_data.extra_provision_payload
string
|
Encrypted card or cardholder details. Allowable Values: 255 char max |
push_tokenize_request_data.card_type
string
|
Specifies the type of payment card. Allowable Values:
|
Create digital wallet provision request for Apple Pay
Copy section link
Action: POST
Endpoint: /digitalwalletprovisionrequests/applepay
Validate Apple certificates and create Apple Pay-specific provisioning request data.
Request body
Copy section link
| Fields | Description |
|---|---|
encrypted_card_data
object
|
The card details encrypted using JSON Web Encryption (JWE). Allowable Values: A valid |
encrypted_card_data.expiration
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
encrypted_card_data.expiration.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
encrypted_card_data.expiration.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
encrypted_card_data.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 GUID or a pseudo-unique identifier for this token. Allowable Values: 1-36 chars |
encrypted_card_data.primary_account_number
string
|
The primary account number of the card that is being tokenized. Typically expected to be 16 digits. Allowable Values: 12-19 chars |
encrypted_card_data.card_type
string
|
The type of card. This field is required for Samsung Pay. Allowable Values:
|
encrypted_card_data.cardholder_info
object
|
Contains the personal information of the cardholder. Allowable Values: A valid |
encrypted_card_data.cardholder_info.first_name
string
|
The first or given name of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.last_name
string
|
The last or family name of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.cardholder_address
object
|
The cardholder address. Allowable Values: A valid |
encrypted_card_data.cardholder_info.cardholder_address.address_line_1
string
|
The street address of the cardholder. Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.cardholder_address.address_line_2
string
|
Additional address information for the cardholder, such as a suite or apartment number.
Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.cardholder_address.postal_code
string
|
The postal code of the cardholder, such as a ZIP code.
Allowable Values: 1-10 chars |
encrypted_card_data.cardholder_info.cardholder_address.city
string
|
The city of the cardholder. Allowable Values: 40 char max |
encrypted_card_data.cardholder_info.cardholder_address.state
string
|
The two-character state or province code.
Allowable Values: 2 char max |
encrypted_card_data.cardholder_info.cardholder_address.country_code
string
|
The two-character ISO 3166-1 alpha-2 country code.
Allowable Values: 2 char max |
encrypted_card_data.cardholder_info.email_address
string
|
The email address of the cardholder.
Allowable Values: 255 char max |
encrypted_card_data.cardholder_info.phone_number
string
|
The phone number of the cardholder. Allowable Values: 255 char max |
encrypted_card_data.metadata
array of objects
|
Additional metadata related to the card details object. Allowable Values: A valid |
encrypted_card_data.metadata[].name
string
|
The metadata attribute name.
Allowable Values: 255 char max |
encrypted_card_data.metadata[].value
string
|
The metadata attribute value. Allowable Values: 255 char max |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
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: 50 char max |
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: A valid |
nonce
string
|
One-time-use nonce provided by Apple for security purposes. Base 64 encoded. Allowable Values: 255 char max |
nonce_signature
string
|
Apple-provided signature to the nonce. Base 64 encoded. Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
created_time
datetime
|
The date and time when the digital wallet token provisioning request was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_modified_time
datetime
|
The date and time when the digital wallet token provisioning request was last updated, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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 GUID or a pseudo-unique identifier for this token. Allowable Values: An existing card token |
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 |
activation_data
string
|
Cryptographic one-time passcode conforming to the payment network operator or service provider specifications. Allowable Values: 255 char max |
ephemeral_public_key
string
|
The ephemeral public key used for the provisioning attempt. Allowable Values: 255 char max |
Update expiry dates
Copy section link
Action: PUT
Endpoint: /cardactions/updateexpiration
Update the expiry dates of a digital wallet token.
Request body
Copy section link
| Fields | Description |
|---|---|
primary_account_number
string
|
The primary account number (PAN) of the card. Allowable Values: 12-19 chars |
old_card_token
string
|
The existing payment card token that has digital wallet tokens assigned to it. Allowable Values: 255 char max |
old_pan_expiry
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
old_pan_expiry.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
old_pan_expiry.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
new_card_token
string
|
The new payment card token to which the digital wallet tokens are assigned. Allowable Values: 255 char max |
new_pan_expiry
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
new_pan_expiry.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
new_pan_expiry.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
Response body
Copy section link
| Fields | Description |
|---|---|
success
boolean
|
Indicates success if Allowable Values:
|
Transfer digital wallet tokens
Copy section link
Action: PUT
Endpoint: /cardactions/cardswap
Transfer digital wallet tokens to a new card with a different primary account number.
Request body
Copy section link
| Fields | Description |
|---|---|
old_primary_account_number
string
|
The primary account number for the existing payment card that has digital wallet tokens assigned to it. Allowable Values: 12-19 chars |
old_pan_expiry
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
old_pan_expiry.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
old_pan_expiry.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
old_card_token
string
|
The existing payment card token that has digital wallet tokens assigned to it. Allowable Values: 255 char max |
new_primary_account_number
string
|
The primary account number for the new payment card to which the digital wallet tokens are assigned. Allowable Values: 12-19 chars |
new_pan_expiry
object
|
Specifies the expiry date for the card. Allowable Values: A valid |
new_pan_expiry.month
string
|
Specifies the expiry month for the card in MM format.
Allowable Values: Format: MM |
new_pan_expiry.year
string
|
Specifies the expiry year for the card in yyyy format.
Allowable Values: Format: yyyy |
new_card_token
string
|
The new payment card token to which the digital wallet tokens are assigned. Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
success
boolean
|
Indicates success if Allowable Values:
|
Create webhook
Copy section link
Action: POST
Endpoint: /webhooks/{token}/{event_type}/{event_token}
Resends an event notification to your webhook endpoint.
Although you send this request as a POST, all parameters are passed in the URL and the body is empty.
The event notification is resent to your webhook endpoint and also returned in the response to this request.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The webhook token. Allowable Values: 1-36 chars |
event_type
string
|
The event type. Allowable Values:
|
event_token
string
|
The event token. Allowable Values: 255 char max |
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). Allowable Values: 1-36 chars |
digital_wallet_token
object
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: An existing |
digital_wallet_token.token
string
|
The Marqeta unique identifier for the digital wallet token. Allowable Values: 1-36 chars |
card_swap
object
|
Specifies the old and new payment card tokens that were swapped. Allowable Values: A valid |
card_swap.previousCardToken
string
|
The existing payment card token that has digital wallet tokens assigned to it. Allowable Values: 1-36 chars |
card_swap.newCardToken
string
|
The new payment card token to which the digital wallet tokens are assigned. Allowable Values: 1-36 chars |
type
string
|
The type of digital wallet token transition.
Allowable Values: 36 char max |
channel
string
|
The mechanism by which the transition was initiated. Allowable Values:
|
state
string
|
Specifies the state to which the digital wallet token transitions. Allowable Values:
|
fulfillment_status
string
|
The digital wallet token’s provisioning status. Allowable Values:
|
reason
string
|
A descriptive reason for the transition. Allowable Values: 255 char max |
reason_code
string
|
The two-digit reason code for the transition. Allowable Values: Two digits |
created_time
datetime
|
The date and time when the digital wallet token transition was created, in UTC.
Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |