# Parameters
source: https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md

## Composite data types {#composite-data-types}

### Identity Validation Channel {#identity-validation-channel}

```javascript
dictionary IdentityValidationChannel {
  optional String validationChannelID;
  optional String identityProvider;
  required enum identityType;
  required String maskedValidationChannel;
}
```

Description of data elements:

|            Name             |  Type  | Mandate  |                                                             Description                                                              |
|-----------------------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------------|
| **validationChannelID**     | String | Optional | ID for the validation channel.                                                                                                       |
| **identityProvider**        | String | Optional | Entity or organization that can validate the identity.                                                                               |
| **identityType**            | Enum   | Required | Type if Identity validation channel. Supported values are EMAIL_ADDRESS and MOBILE_PHONE_NUMBER.                                     |
| **maskedValidationChannel** | String | Required | Masked value of the channel used to deliver the Validation code (like OTP). It can be either a masked email address or phone number. |

### DPA data {#dpa-data}

This structure represents the configuration parameters that are common across all transactions. This originates from the DPA.

```javascript
dictionary DpaData {
  conditional String dpaPresentationName;
  conditional String dpaUri;
}
```

Description of data elements:

|          Name           |  Type  |   Mandate   |           Description            |
|-------------------------|--------|-------------|----------------------------------|
| **dpaPresentationName** | String | Conditional | Display name of the DPA website. |
| **dpaUri**              | URL    | Conditional | URL of the DPA website.          |

### DPA transaction options {#dpa-transaction-options}

The DpaTransactionOptions represents the DPA transaction configuration parameters that are specific to the transaction.

```javascript
dictionary DpaTransactionOptions {
   optional List<CountryCode2> dpaAcceptedBillingCountries;
   optional List<CountryCode2> dpaAcceptedShippingCountries;
   optional Enum dpaBillingPreference;
   optional Enum dpaShippingPreference;
   required Locale dpaLocale;
   optional Boolean consumerNameRequested;
   optional Boolean consumerEmailAddressRequested;
   optional Boolean consumerPhoneNumberRequested;
   optional PaymentOptions paymentOptions;
   optional Enum transactionType;
   conditional TransactionAmount transactionAmount;
   optional Boolean isGuestCheckout;
   optional Enum payloadTypeIndicatorCheckout;
   optional Enum payloadTypeIndicatorPayload;
   optional CustomInputData customInputData;
   optional Boolean confirmPayment;
}
```

Description of data elements:

|               Name                |                                                                   Type                                                                   |   Mandate   |                                                                                                                                                                                                                                                                                                                                                                                                                                             Description                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **dpaAcceptedBillingCountries**   | List\<CountryCode2\>                                                                                                                     | Optional    | **Note: Mastercard does not currently support declining payments based on the cardholder's billing address. You should specify an empty array.**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **dpaAcceptedShippingCountries**  | List\<CountryCode2\>                                                                                                                     | Optional    | Shipping restrictions. Array of country codes in ISO 3166-1 alpha-2 format - Shipping region country codes that limits the selection of eligible shipping addresses. If this list is empty, then it means all countries are accepted.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **dpaBillingPreference**          | Enum                                                                                                                                     | Optional    | Verbosity of billing address required by the DPA. Valid values for enum: * `FULL` * `NONE` * `POSTAL_COUNTRY` If not provided, the default is `NONE`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **dpaShippingPreference**         | Enum                                                                                                                                     | Optional    | Verbosity of shipping address required by the DPA. Valid values for enum: * `FULL` * `NONE` If not provided the default is `FULL`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **dpaLocale**                     | Locale                                                                                                                                   | Required    | **Click to Pay:** Mastercard SRC uses the default dpaLocale value to create user profile and deliver Click to Pay experience. Cardholders can change/select the default country/language passed in `dpaLocale` from a country/language selection option in the DCF (Digital Card Facilitator). On selecting, the profile is created in the user selected country and language and the same is also used to deliver the experience for future checkouts. **Passkey Enrollment:** For C2P passkey enrollment, the `dpaLocale` value is used by the DCF and Authentication UI screens to deliver the language supported by the card-issuing country. When not supported, Mastercard uses the default language for that country. Cardholders can change the default country/language before creating the passkey. On changing, the passkey profile is created in the user-selected country and language. |
| **consumerNameRequested**         | Boolean                                                                                                                                  | Optional    | Default is true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **consumerEmailAddressRequested** | Boolean                                                                                                                                  | Optional    | Default is true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **consumerPhoneNumberRequested**  | Boolean                                                                                                                                  | Optional    | Default is true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **paymentOptions**                | [PaymentOptions](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#payment-options)       | Optional    | Payment options requested by the DPA.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **transactionType**               | Enum                                                                                                                                     |             | **Note: Not currently supported by Mastercard SRC**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **transactionAmount**             | [TransactionAmount](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#transaction-amount) | Conditional | Container for amount and currency code. Must be included in either the `init` or `checkout` call.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| **isGuestCheckout**               | Boolean                                                                                                                                  | Optional    | Whether this is a guest checkout.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| **payloadTypeIndicatorCheckout**  | Enum                                                                                                                                     |             | **Note: Not currently supported by Mastercard SRC**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **payloadTypeIndicatorPayload**   | Enum                                                                                                                                     |             | **Note: Not currently supported by Mastercard SRC**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **customInputData**               | [customInputData](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#custom-input-data)    | Optional    | Extensible container that allows DPA to pass a network specific set of data to Click to Pay System.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **confirmPayment**                | Boolean                                                                                                                                  | Optional    | Key parameter to distinguish if a network-specific DCF or a loading screen is displayed after card selection. Default is `FALSE`. When set to `False`, consumer is prompted to 'Continue' the payment on a loading screen; when set to `True`, consumer is prompted with a Confirm payment message on DCF. Set this parameter along with [customInputData](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#custom-input-data) to enable Embedded checkout experience.                                                                                                                                                                                                                                                                                                                                                                               |

### Payment Options {#payment-options}

This structure details of a transaction.

```javascript
dictionary PaymentOptions {
   optional String dpaDynamicDataTtlMinutes;
   optional Enum dynamicDataType;
}
```

Description of data elements:

|             Name             |  Type  | Mandate  |                                                                                                                                                           Description                                                                                                                                                            |
|------------------------------|--------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **dpaDynamicDataTtlMinutes** | Digits | Optional | **Note: Not currently supported by Mastercard SRC**                                                                                                                                                                                                                                                                              |
| **dynamicDataType**          | String | Optional | Type of cryptogram or token used for the card data. Must be `CARD_APPLICATION_CRYPTOGRAM_SHORT_FORM` for DSRP format. Refer to [View the Decrypted Payload](https://developer.mastercard.com/mastercard-checkout-solutions/tutorial/integrate_apis/step3/index.md) for a description of the formats returned by the API request. |

). This is needed to ensure correct language and user experience. The value of the \`dpaLocale\` will be used by Mastercard SRC to create user profile and deliver Click to Pay experience by default. Users can choose to change the default country/language passed in \`dpaLocale\` from a country/language selection option in the DCF screen before profile creation. If user's opt to choose that, then the profile will be created in the user selected country and language and the same will also be used to deliver the experience in all future checkouts by the same user.

RJ removed `NONE` should be hidden. Only allowed on an ad hoc basis were the SRCI has permission to receive an FPAN --\>

### Transaction Amount {#transaction-amount}

The TransactionAmount object is:

```javascript
transactionAmount: {
  Required number transactionAmount;
  Required string transactionCurrencyCode;
}
```

|            Name             |     Type     | Mandate  |                                                                                                                                                                                                  Description                                                                                                                                                                                                  |
|-----------------------------|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **transactionAmount**       | Amount       | Required | Transaction amount given in the format corresponding to the ISO 4217 currency code specified by **transactionCurrencyCode**. For example if the currency is USD, a transaction of $100 would be given as '100.00'. Note that the decimal separator should be a dot (.) and the number of digits required after the separator depends on the currency used. Ensure you use the correct precision at all times. |
| **transactionCurrencyCode** | CurrencyCode | Required | String specifying the ISO 4217 currency code (e.g., `USD`).                                                                                                                                                                                                                                                                                                                                                   |

### Custom Input Data {#custom-input-data}

The CustomInputData object is:

```javascript
customInputData: {
  optional string com.mastercard.dcfExperience;
}
```

|               Name               |  Type  | Mandate  |                                                                                                                                                                                                                                                                                                                                                                                                                                                  Description                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|----------------------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **com.mastercard.dcfExperience** | String | Optional | Configure when card enrollment is offered to the cardholder. This only applies to Mastercard cards. Supported values: * `WITHIN_CHECKOUT` -- This experience offers Click to Pay as a payment option to complete Checkout for an order. (Guest Checkout Option) * `PAYMENT_SETTINGS` -- This experience offers Click to Pay to enroll and add their cards for faster checkout. (No Guest Checkout Option) Either one of these values must be set to enable Embedded checkout experience along with [confirmPayment](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#dpa-transaction-options) parameter. See the DCF Fallback scenarios within the [**UI guide**](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/tutorials-and-guides/index.md#guides) to understand what happens when the required data is not passed to SRCI. |

### SRC profile {#src-profile}

The SrcProfile object is:

```javascript
dictionary SrcProfile {
   optional MaskedConsumer consumer;
   required List<MaskedCard> cards;
   required List<ShippingAddresses> shippingAddresses;
   required List<authorization> authorization;
}
```

Description of data elements:

|           Name            |                                                                Type                                                                |   Mandate   |                 Description                 |
|---------------------------|------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------------------------------------|
| **consumer**              | [MaskedConsumer](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#masked-consumer) | Optional    | Recognized user.                            |
| **cards**                 | List\<[MaskedCard](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#masked-card)\> | Required    | Card list of recognized/authenticated user. |
| **shippingAddresses**     | List                                                                                                                               | Required    | List of known shipping addresses.           |
| **consumerAuthorisation** | List                                                                                                                               | Conditional | List of authorizations.                     |

### Masked consumer {#masked-consumer}

Description of data elements:

|             Name             |                                                                        Type                                                                         | Mandate  |                                                                    Description                                                                    |
|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| **srcConsumerId**            | UUID                                                                                                                                                | Optional | SRC Consumer Reference Identifier as generated by the Click to Pay System.                                                                        |
| **maskedConsumerIdentity**   | [MaskedConsumerIdentity](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#masked-consumer-identity) | Required | Represents the masked value of the primary verifiable consumer identifier within an SRC Profile, e.g., an email address or a mobile phone number. |
| **maskedEmailAddress**       | String                                                                                                                                              | Optional | Max Length = 255. Masked Consumer email address.                                                                                                  |
| **maskedMobileNumber**       | [PhoneNumber](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#phone-number)                        | Optional | Masked Consumer mobile phone number.                                                                                                              |
| **maskedNationalIdentifier** | String                                                                                                                                              | Optional | Max Length = 20 Masked Consumer national identifier.                                                                                              |
| **complianceSettings**       | [ComplianceSettings](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#compliance-settings)          | Optional | Consumer compliance settings.                                                                                                                     |
| **countryCode**              | CountryCode2                                                                                                                                        | Optional | ISO 3166 alpha 2 country code. Consumer provided country code.                                                                                    |
| **languageCode**             | LanguageCode                                                                                                                                        | Optional | ISO 639-1 Code. Consumer provided language choice.                                                                                                |
| **status**                   | Enum                                                                                                                                                | Optional | Signifies the state of the consumer at any given time at the Click to Pay System. Values: * `ACTIVE` * `SUSPENDED` * `LOCKED`                     |
| **maskedFirstName**          | String                                                                                                                                              | Optional | Max Length = 30. Masked first name of the consumer.                                                                                               |
| **maskedLastName**           | String                                                                                                                                              | Optional | Max Length = 30. Masked last name of the consumer.                                                                                                |
| **maskedFullname**           | String                                                                                                                                              | Optional | Max Length = 60. Masked full name of the consumer.                                                                                                |
| **dateConsumerAdded**        | Timestamp                                                                                                                                           | Required | UTC timestamp when consumer was added to the Click to Pay System.                                                                                 |
| **dateConsumerLastUsed**     | Timestamp                                                                                                                                           | Optional | UTC timestamp when consumer last transacted in the Click to Pay System.                                                                           |

### Masked consumer identity {#masked-consumer-identity}

Description of data elements:

|          Name           |  Type  | Mandate  |                                                            Description                                                             |
|-------------------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------|
| **identityProvider**    | Enum   | Optional | The entity or organisation that collected and verifies the identity. Values: * `SRC`                                               |
| **identityType**        | Enum   | Required | Identifies the type of Consumer Identity transmitted or collected. Values: * `EMAIL_ADDRESS` * `MOBILE_PHONE_NUMBER`               |
| **maskedIdentityValue** | String | Required | Max Length = 255. Masked consumer identifier value, e.g., masked email address or masked mobile phone number as per masking rules. |

### Phone Number {#phone-number}

Description of data elements:

|      Name       |  Type  | Mandate  |                                      Description                                      |
|-----------------|--------|----------|---------------------------------------------------------------------------------------|
| **countryCode** | Digits | Required | Length = 1 to 4 digits. Phone number country code. International calling code format. |
| **phoneNumber** | Digits | Required | Length = 4 to 14 digits. Phone number without country code.                           |

### Compliance settings {#compliance-settings}

Description of data elements:

|        Name        |                                                        Type                                                         | Mandate  |             Description             |
|--------------------|---------------------------------------------------------------------------------------------------------------------|----------|-------------------------------------|
| **privacy**        | [Consent](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#consent) | Optional | Privacy consent status.             |
| **tnc**            | [Consent](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#consent) | Optional | "T\&Cs" consent status.             |
| **cookie**         | [Consent](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#consent) | Optional | Consumer's "cookie" consent status. |
| **marketingOptIn** | Boolean                                                                                                             | Optional | Marketing opt in.                   |

### Consent {#consent}

Each consent takes three forms. For instance the "privacy" consent has three parameters:

* privacyAcceptedVersion
* privacyLatestVersion
* privacyLatestVersionUri

Description of data elements:

|         Name         |  Type  | Mandate  |                            Description                            |
|----------------------|--------|----------|-------------------------------------------------------------------|
| **acceptedVersion**  | String | Optional | Max Length = 10. Represents the version accepted by the Consumer. |
| **latestVersion**    | String | Optional | Max Length = 10. Represents the latest version.                   |
| **latestVersionUri** | String | Optional | Max Length = 1024. Represents the URI of the latest version.      |

### Masked card {#masked-card}

|            Name             |                                                                        Type                                                                         |   Mandate   |                                                                                                                                                                                                                                                                                Description                                                                                                                                                                                                                                                                                |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **srcDigitalCardId**        | String                                                                                                                                              | Conditional | Max Length=36. Unique Identifier of the card. A reference representing the PAN or Payment Token that enables a non-SRCPI entity to identify the underlying PAN. A single PAN can have one or more SRC Digital Card Reference Identifiers. Digital Card information can be accompanied with SRC Digital Card Reference Identifier. It is associated with the SRC Profile to which the Digital Card belongs and is unique within an Click to Pay System. *Conditionality:* Supplied when returned to SRCI or DCF; not required when returned to an SRC-PI.                  |
| **srcPaymentCardId**        | String                                                                                                                                              | Conditional | Max Length = 36. A reference representing the PAN that enables the Click to Pay System to communicate with the SRCPI without transmitting the actual PAN. It is associated with the SRC Profile to which the Payment Card belongs and is unique within an Click to Pay System. *Conditionality:* Supplied when returned to the SRC-PI.                                                                                                                                                                                                                                    |
| **panBin**                  | Digits                                                                                                                                              | Required    | Max Length = (PAN Length - 10). First significant digits of the PAN, included in an unmasked form.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **panLastFour**             | Digits                                                                                                                                              | Required    | Length = 4. Attribute of the Payment Card that represents the Last 4 digits of the PAN included in an unmasked form.                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| **tokenBinRange**           | Digits                                                                                                                                              | Conditional | Max Length = (Payment Token Length - 10). A specific BIN Range or subset of the BIN Range that has been designated only for the purpose of issuing Payment Tokens, included in an unmasked form. *Conditionality:* must be supplied if token is used.                                                                                                                                                                                                                                                                                                                     |
| **tokenLastFour**           | Digits                                                                                                                                              | Conditional | Length = 4. Last 4 digits of the Payment Token included in an unmasked form. *Conditionality:* must be supplied if token is used.                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **digitalCardData**         | [DigitalCardData](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#digital-card-data)               | Required    | Digital Card Data contains digital card information that is used in the acceptance environment and in the user interface. Its purpose is to provide reference to the actual PAN or Payment Token without actually disclosing either. Digital Card Data is grouped based on the following: * Digital Card Information: data used in Request and Response Messages * UI/UX Presentation Data: data used user interfaces to provide the user with a recognizable descriptor * Digital Card Art: image that accompanies Digital Card information for user interface purposes. |
| **panExpirationMonth**      | Digits                                                                                                                                              | Conditional | Length = 2. Expiration month of the Payment Card, expressed as a Calendar Month used for presentation purposes. *Conditionality*: Supplied when specified for the card (PAN).                                                                                                                                                                                                                                                                                                                                                                                             |
| **panExpirationYear**       | Digits                                                                                                                                              | Conditional | Length = 4. Expiration year of the Payment Card expressed as four-digit year, used for presentation purposes. *Conditionality:* Supplied when specified for the card (PAN).                                                                                                                                                                                                                                                                                                                                                                                               |
| **paymentCardDescriptor**   | String                                                                                                                                              | Optional    | Max Length = 32. Conveys the card brand, and will be a free-form string, to be defined within a program.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **paymentCardType**         | String                                                                                                                                              | Optional    | Max Length = 32. Conveys the card type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **digitalCardFeatures**     | List\<[DigitalCardFeature](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#digital-card-feature)\> | Optional    | Set of digital card attributes related to digital card features that should be displayed to the consumer.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **countryCode**             | CountryCode2                                                                                                                                        | Optional    | ISO 3166-1 alpha 2 country code. Country code of issuance associated with the Card Issuer's BIN license.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **maskedBillingAddress**    | [MaskedAddress](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#masked-address)                    | Optional    | Masked billing address associated with the card.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **dcf**                     | [Dcf](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#dcf)                                         | Optional    | Digital Card Facilitator (DCF) associated with the card                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **serviceId**               | String                                                                                                                                              | Optional    | Max Length = 255. A service identifier associated to a specific configuration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **paymentAccountReference** | String                                                                                                                                              | Optional    | Max Length = 29. A value assigned to the underlying cardholder account that uniquely identifies the underlying account to which a Payment Card is associated.                                                                                                                                                                                                                                                                                                                                                                                                             |
| **dateOfCardCreated**       | Timestamp                                                                                                                                           | Required    | UTC timestamp when card was enrolled into the Click to Pay System.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **dateOfCardLastUsed**      | Timestamp                                                                                                                                           | Optional    | UTC timestamp when card was last used for a SRC transaction.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| **digitalCardRelatedData**  | String                                                                                                                                              | Optional    | This can be used to pass custom information about the card.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

### Digital card data {#digital-card-data}

```javascript
dictionary DigitalCardData {
   Required Enum status;
   optional String presentationName;
   optional String descriptorName;
   optional URL artUri;
   optional Digits artHeight;
   optional Digits artWidth;
 }
```

|         Name         |  Type  | Mandate  |                                                                                                    Description                                                                                                    |
|----------------------|--------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **status**           | Enum   | Required | Status of the Card in the Click to Pay System. Values: * `ACTIVE`                                                                                                                                                 |
| **presentationName** | String | Optional | Name that can be used for display. Presentation text created by the Consumer to enable recognition of the PAN entered into the DCF. This value is unique to the DCF and defined by the Consumer (e.g., Nickname). |
| **descriptorName**   | String | Optional | Presentation text defined by the SRC Program that describes the PAN presented as a Digital Card. This descriptor is the same across all DCFs.                                                                     |
| **artUri**           | URL    | Optional | HTTPS (full) URL for the cardArt. Can be card or issuer specific value, e.g, `https://dcf.sbx.src‑stub.masterpass.com/static/img/card.0ae19b4.svg`.                                                               |
| **artHeight**        | Digits | Optional | Height of the card art image in pixels.                                                                                                                                                                           |
| **artWidth**         | Digits | Optional | Width of the card art image in pixels.                                                                                                                                                                            |

### Digital card feature {#digital-card-feature}

|      Name       |  Type  | Mandate  |                                                                                                                                                                                                                                                          Description                                                                                                                                                                                                                                                          |
|-----------------|--------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **content**     | String | Required | Max Length = 74. Content of the digital card feature. If any card benefits exist for a card, Mastercard Click to Pay System will populate this field with the card benefits message. As an SRCI, you will need to display the card benefits message with the card in the card list screen. The card benefits message is passed to the DCF via the SDK through `srcDigitalCardId` when [checkout](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#checkout) method is called. |
| **contentType** | Enum   | Required | Type of the content of the digital card feature. Values: * `TEXT_STRING` * `IMAGE_URL` * `CONTENT_URL` * `LINK_URL`                                                                                                                                                                                                                                                                                                                                                                                                           |
| **style**       | URL    | Optional | Location of a CSS style sheet that describes how to present the card feature.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **width**       | Digits | Optional | Width to be applied to display of card feature.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **height**      | Digits | Optional | Height to be applied to display of card feature.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

### Masked address {#masked-address}

|       Name       |     Type     |   Mandate   |                                                                                                        Description                                                                                                        |
|------------------|--------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **addressId**    | UUID         | Required    | Identifier used to point to the address.                                                                                                                                                                                  |
| **name**         | String       | Conditional | Max Length = 60. Name of the individual receiving the delivered goods or service. Only applicable for the shipping address. *Conditionality:* If known to the Click to Pay System then must be supplied for that address. |
| **line1**        | AddressLine  | Optional    | Max Length = 75. Address line 1.                                                                                                                                                                                          |
| **line2**        | AddressLine  | Optional    | Max Length = 75. Address line 2.                                                                                                                                                                                          |
| **line3**        | AddressLine  | Optional    | Max Length = 75. Address line 3.                                                                                                                                                                                          |
| **city**         | AddressLine  | Optional    | Max Length = 50. Address city.                                                                                                                                                                                            |
| **state**        | AddressLine  | Optional    | Max Length = 30. Address state.                                                                                                                                                                                           |
| **countryCode**  | CountryCode2 | Optional    | ISO 3166-1 alpha 2 country code. Address country code.                                                                                                                                                                    |
| **zip**          | String       | Optional    | Max Length = 16. Address zip or postal code.                                                                                                                                                                              |
| **createTime**   | Timestamp    | Optional    | UTC timestamp the address was created.                                                                                                                                                                                    |
| **lastUsedTime** | Timestamp    | Optional    | UTC timestamp the address was last used.                                                                                                                                                                                  |

### Address {#address}

Note: When following values are provided, they appear pre-filled on DCF screen for [First Time Users](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/use-cases/click-to-pay/firsttimeuser_usecase/index.md) flow.

|      Name       |     Type     | Mandate  |                                        Description                                         |
|-----------------|--------------|----------|--------------------------------------------------------------------------------------------|
| **name**        | String       | Optional | Max Length = 60. Name of the individual getting billed for the delivered goods or service. |
| **line1**       | AddressLine  | Optional | Max Length = 75. Address line 1.                                                           |
| **line2**       | AddressLine  | Optional | Max Length = 75. Address line 2.                                                           |
| **line3**       | AddressLine  | Optional | Max Length = 75. Address line 3.                                                           |
| **city**        | AddressLine  | Optional | Max Length = 50. Address city.                                                             |
| **state**       | AddressLine  | Optional | Max Length = 30. Address state.                                                            |
| **countryCode** | CountryCode2 | Optional | ISO 3166-1 alpha 2 country code. Address country code.                                     |
| **zip**         | String       | Optional | Max Length = 16. Address zip or postal code.                                               |

### Consumer {#consumer}

Note: When following values are provided, they appear pre-filled on DCF screen for [First Time Users](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/use-cases/click-to-pay/firsttimeuser_usecase/index.md) flow.

|       Name       |                                                             Type                                                             | Mandate  |                    Description                     |
|------------------|------------------------------------------------------------------------------------------------------------------------------|----------|----------------------------------------------------|
| **emailAddress** | String                                                                                                                       | Optional | Max Length = 255. Consumer-provided email address. |
| **firstName**    | String                                                                                                                       | Optional | Consumer-provided first name.                      |
| **lastName**     | String                                                                                                                       | Optional | Consumer-provided last name.                       |
| **mobileNumber** | [PhoneNumber](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/parameters/index.md#phone-number) | Optional | Consumer-provided mobile number.                   |

### DCF {#dcf}

|        Name         |  Type  | Mandate  |                                             Description                                             |
|---------------------|--------|----------|-----------------------------------------------------------------------------------------------------|
| **applicationType** | Enum   | Optional | Type of the environment of the DCF. Values: * `WEB_BROWSER` * `MOBILE_APP` * `IOT_DEVICE` * `OTHER` |
| **uri**             | URL    | Optional | Max Length = 255. DCF URI as provided by DCF.                                                       |
| **logoUri**         | URL    | Optional | Max Length = 255. Logo image URI provided by the DCF to support presentation.                       |
| **name**            | String | Optional | Max Length = 60. Legal Name of DCF onboarded to the Click to Pay System.                            |

### Consumer authorization {#consumer-authorization}

Presence of the `consumerAuthorisation` object in the response body is conditional on the consumer application instance being recognized and the customer having previously enrolled CustomerIdentity data.
