CardData class abstract

Information related to the payment card used for the transaction. Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition, or BalanceInquiry request to the POI. It can also be sent in the CardAcquisition response, to be processed by the Sale System.

Properties:

  • paymentBrand - Type of payment card. If card PAN is readable. Indicates the card used to pay in the PaymentResponse. Sent in the CardAcquisitionResponse, to leave the Cashier to choose between several applications in a smartcard, or several brand in a co-branded card. In this case, the CardAcquisitionRequest.ForceCustomerSelectionFlag must contain the value False. Brands are part of the POI and Sale Systems configurations.
  • maskedPan - Masked Primary Account Number Part of the PAN is replaced by a string of * characters, to identify a customer account or relationship. Presence of this data element, which replace the PAN when SensitiveCardData is protected and replaced by ProtectedCardData. Alternatively the MaskedPAN can be used as a token to identify a customer.
  • paymentAccountRef - Reference of the PAN, which identifies the PAN or the card uniquely, named also PAR (Payment Account Reference). This reference may be defined by the card issuer or by a token service provider under the control of the card issuer, and cannot be used for a payment transaction.
  • entryMode - Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values: * Contactless * File * ICC * Keyed * MagStripe * Manual * Mobile * RFID * Scanned * SynchronousICC * Tapped
  • cardCountryCode - Country Code attached to the card (3 numerics). If available in the card.
  • protectedCardData - Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
  • sensitiveCardData - Sensitive information related to the payment card, entered or read by the Sale System. If structure non empty and unprotected.
  • paymentToken - Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer. Restriction of product payable by a card.
Annotations
  • @BuiltValue.new()

Constructors

CardData([void updates(CardDataBuilder b)])
factory

Properties

cardCountryCode → int?
Country Code attached to the card (3 numerics). If available in the card.
no setter
entryMode → BuiltList<CardDataEntryModeEnum>?
Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values: * Contactless * File * ICC * Keyed * MagStripe * Manual * Mobile * RFID * Scanned * SynchronousICC * Tapped
no setter
hashCode → int
The hash code for this object.
no setterinherited
maskedPan → String?
Masked Primary Account Number Part of the PAN is replaced by a string of * characters, to identify a customer account or relationship. Presence of this data element, which replace the PAN when SensitiveCardData is protected and replaced by ProtectedCardData. Alternatively the MaskedPAN can be used as a token to identify a customer.
no setter
paymentAccountRef → String?
Reference of the PAN, which identifies the PAN or the card uniquely, named also PAR (Payment Account Reference). This reference may be defined by the card issuer or by a token service provider under the control of the card issuer, and cannot be used for a payment transaction.
no setter
paymentBrand → String?
Type of payment card. If card PAN is readable. Indicates the card used to pay in the PaymentResponse. Sent in the CardAcquisitionResponse, to leave the Cashier to choose between several applications in a smartcard, or several brand in a co-branded card. In this case, the CardAcquisitionRequest.ForceCustomerSelectionFlag must contain the value False. Brands are part of the POI and Sale Systems configurations.
no setter
paymentToken → PaymentToken?
Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer. Restriction of product payable by a card.
no setter
protectedCardData → String?
Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sensitiveCardData → SensitiveCardData?
Sensitive information related to the payment card, entered or read by the Sale System. If structure non empty and unprotected.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(CardDataBuilder)) → CardData
Rebuilds the instance.
inherited
toBuilder() → CardDataBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<CardData>
no setter