| Name | Description | Type | Additional information |
|---|---|---|---|
| TokenUniqueReference |
A unique reference assigned following the allocation of a token used to identify the token for the duration of its lifetime. Conditional field, present when successfully assigned. 48 character string. |
string |
None. |
| PrimaryAccountNumberUniqueReference |
Unique reference to the Account PAN originally digitized. Conditional field, present when successfully assigned. |
string |
None. |
| TokenSuffix |
Last 4 digits of token in a 4 character string. Conditional field, present once the token has been designated for the digitization. |
string |
None. |
| ExpirationDate |
Expiration date of token. Conditional field, present once the token has been designated for the digitization. Four digit string. Format "mmyy". |
string |
None. |
| AccountPanSequenceNumber |
The Account PAN Sequence Number associated with a specific token, as provided to MDES previously by the issuer. It may be used to distinguish between multiple cardholders for a single Account PAN, to represent an issuance number of a specific card, or to distinguish between different card products, such as debit or credit, that share the same Account PAN. Conditional field, present when successfully assigned. 3 characters in length, max. Supported values - 000 to 099. |
string |
None. |
| ActivationCodeExpirationDateTime |
Date and time when an Activation Code will expire. Conditional field, not present for CoF tokens, and only present when an Activation Code has been generated and activation has not yet occurred. The date and time may be in the future or past. string in ISO 8601 format – YYYY-MM-DDThh:mm:ssTZD . |
string |
None. |
| CorrelationId |
Value linking pre-digitization messages generated during provisioning. Conditional field, not present for CoF tokens. 14 char string. |
string |
None. |
| CurrentStatusCode |
Current status of the Token. Valid values: "U" - Unmapped.The token has not yet been linked to the Account PAN.The process of tokenization is ‘In Progress.'. "A" - Active.The token is linked to the Account PAN and may initiate new transactions to be authorized. "S" - Suspended.The token is linked to the Account PAN but may not perform transactions at the request of one or more suspenders. "D" - Deleted.The token is logically deleted but is still linked to the Account PAN for the purposes of post-authorization transaction processing. |
string |
None. |
| CurrentStatusDescription |
Description of the current status. |
string |
None. |
| CurrentStatusDateTime |
Date and time the status was updated. string, ISO 8601 format – YYYY-MM-DDThh:mm:ssTZD . |
string |
None. |
| DigitizationRequestDateTime |
Date and time of the initial request for digitization of the Account PAN for this token. Conditional field, not present for CoF tokens. string, in ISO 8601 format – YYYY-MM-DDThh:mm:ssTZD . |
string |
None. |
| FinalTokenizationDecision |
Final decision related to the digitization of the Account PAN for this token. One character string. Valid values: "D" - Digitization was declined. "A" - Digitization was approved. "R" - Digitization was approved but required authentication prior to activation. Conditional field, not present for CoF tokens.NOTE - this information is currently subject to archival processes and will be present for only 1 year following digitization. |
string |
None. |
| LastCommentId |
Identifier of the last comment associated with the token. |
string |
None. |
| PaymentAppInstanceId |
Identifier of the Payment App instance within a device that will be provisioned with a token. NOTE - This may contain the identifier of the Secure Element or a mobile device for some programs. Optional, not present for CoF tokens, and only present when supplied by the Payment App Provider. 48 characters string. |
string |
None. |
| ProvisioningStatusCode |
Current provisioning status of the token. Valid values: "P" - Token being prepared. "T" - Awaiting cardholder acceptance of Terms and Conditions. "D" - Token being delivered to Wallet Provider or Device. "A" - Awaiting Activation. "S" - Provisioning successful. "F" - Provisioning failed. NOTE - The order of the statuses above does not indicate any order of status transitions. Conditional field, not present for CoF tokens. |
string |
None. |
| ProvisioningStatusDescription |
Description of the provisioning status. Conditional field, not present for CoF tokens. |
string |
None. |
| StorageTechnology |
The architecture or technology used for token storage. Valid values: "D" - Device memory. "P" - Device memory protected by Trusted Platform Module(TPM). "H" - Server. "E" - Trusted Execution Environment(TEE). "S" - Secure Element(SE). "V" - Virtual Execution Environment(VEE). |
string |
None. |
| Suspender |
Suspender - See Suspender Documentation |
Collection of Suspender |
None. |
| TokenActivatedDateTime |
Date and time that the token was activated. Conditional field, present only once the Token has been activated. string in ISO 8601 format – YYYY-MM-DDThh:mm:ssTZD . |
string |
None. |
| TokenAssuranceLevel |
Indicates the level of Identification and Verification performed to validate the Cardholder and the Cardholder's account at the time the Token was issued (or at any subsquent time post-issuance). Only present when a token has a Token Assurance Level assigned. Supported values are 0 (Not Authenticated) and non-zero (Authenticated). |
string |
None. |
| TokenRequestorId |
Per EMV Co, the entity uniquely recognized by Mastercard as the Token Service Provider. String, up to 11 characters. |
string |
None. |
| TokenRequestorName |
The legal name of the token requestor. There can be more than one Token Requestor Id per Token Requester Name (legal name). So it is important to use both parameters to uniquely identify a token requestor. String, up to 100 characters. |
string |
None. |
| TokenType |
Type of token. Valid values: "S" - Embedded Secure Element Token. "C" - Mastercard Cloud-Based Payments token. "F" - Cof token. |
string |
None. |
| WalletId |
Identifier of the Wallet Provider who requested the digitization or tokenization. Conditional field, not present for CoF tokens, and only present when supplied by the Payment App Provider. |
string |
None. |
| Devices |
Device - See Device Object Documentation |
Collection of Device |
None. |
| TokenDeletedFromConsumerApp |
Indicates whether or not a token has been deleted from the consumer app by the token requestor. Note - This is a "soft delete" that does not affect the actual Token Status. The token may still be active in the system. Supported values - true, false |
string |
None. |
| TokenRequestorConsumerFacingEntityName |
The Token Service Provider name to be displayed to the consumer (consumer-facing name). |
string |
None. |