Digital card API
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}The following object represent the account
The reason why the action is performed.
^[a-zA-Z0-9 ]{1,64}$The reason code why the action is performed.
If not provided , default reason code is ISSUER_DECISION
Successful card suspension request
Operation information.
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}Status of the operation
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}The following object represent the Digital Card Resume request payload
The reason why the action is performed.
^[a-zA-Z0-9 ]{1,64}$The reason code why the action is performed.
If not provided , default reason code is ISSUER_DECISION
Successful card resumption
Operation information.
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}Status of the operation
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}The following object represent the account
The reason why the action is performed.
^[a-zA-Z0-9 ]{1,64}$The reason code why the action is performed.
If not provided , default reason code is ISSUER_DECISION
Successful card deletion request
Operation information.
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}Status of the operation
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}Ciphered digital PAN, this DPAN is encrypted using the JWE encryption (please refer to the Sensitive Information Encryption for more details)
Content
Once deciphered, the plaintext contains:
| JSON field parameter name | type | description | MOC | Length |
|---|---|---|---|---|
| pan | String | The digital pan value. | M | Up to 19 |
^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$The search type
Search Result
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}OK
Provides information about the token. Note that this data is available only if the tokenization is successful or pending.
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Unique identifier of the token specified by the TSP
Last four digits of the token
The state of the digital card (token)
N.B. Tokens in DELETED state are included only if the corresponding issuer onboarding flag (i.e. manageDeletedToken) is set.
ACTIVEPossible values: The type of the token. Following values are supported:
- SE
- HCE
- COF
- ECOM
- QRC
The card identifier provided by the scheme for a given token requestor. Always present for Visa and Mastercard. When token requestor is ApplePay, it corresponds to the FPANID. Each stakeholder uses a different term to identify this entity; for the sake of clarify a summary table is reported below:
| VTS | MDES | Apple Pay |
|---|---|---|
| panReferenceID | panUniqueReference | FPANID |
List of all devices bound to this token. A device is represented by its binding reference.
The provisioning time of the token. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD
The last time the token keys have been replenished. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD
The last time the token status has been changed. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD
Boolean Flag indicating whether the token is primary or auxiliary.
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}OK
The field is the json (cf http://www.json.org/ ) representation of the DIGITAL card. JWE encryption is used to secure the field (please refer to the Sensitive Information Encryption for more details) Details:
{
"pan":"...",
"exp":"..."
}
The PAN is Mandatory, up to 19 digits.
The expiry date in the format MMYY. It is not provided for UPI scheme.
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}OK
Operation details related to a specific operationId
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}The lifecycle operation name performed on the target digital card.
A digital card can be activated(i.e. resumed), suspended, deleted from the wallet application or CCI portal; it can also be renewed when expired by the TSP and updated after a card update/renewal operation (concerning a PAN and/or expiry date update).
Note: DELETE_FROM_APP is only applicable for Mastercard digital cards in case of deletion from wallet application.
Status of the operation
The time the request has been processed. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD
The time the request has been processed. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD
Identifier of the user/entity initiating the operation
- [consumerId if USER]
- [issuerId if ISSUER]
- [cci user id if CCI]
- ["VTS"/"MDES" if TSP]
Container to hold detailed information of other Digital Card operation
Human readable string representing the error, only present in case of operation failure
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Index from which the query starts returning operations – offset 0 (the default) corresponds to the most recent operation.
Number of operations to be returned
10Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}OK
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Resource not found
Internal Server Error
StepUp Auth Result
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}Step-Up Authentication Result request
this will be the "lifeCycleTraceId" for Visa or the "authenticationCorrelationId" for Mastercard
Successful Step-up authentication
Operation result information.
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}Status of the operation
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
A JWT using the Bearer schema.\nThe server checks the validity of the provided token to control access to this protected resource.
The id of the issuer
The id of the digital card
[A-Za-z0-9_-]{1,64}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}Unbind request
Corresponds to Visa device index.
^[0-9]{1,2}$Free text field providing additional info on the reason why the action is performed.
^[a-zA-Z0-9]{1,64}$The reason code why the action is performed.
If not provided , default reason code is ISSUER_DECISION
Successful device binding removal
Operation result information.
Unique identifier of the operation
[A-Za-z0-9_-]{1,64}Status of the operation
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Forbidden action, check the state of the linked end user (consumer) or account or digital card
Resource not found
Internal Server Error
Last updated
Was this helpful?