CardPaymentData (posapplib 1.10.0 API)

java.lang.Object
- se.westpay.posapplib.PaymentData
- - se.westpay.posapplib.CardPaymentData

```
public class CardPaymentData
extends PaymentData
```
The CardPaymentData class contains data about the payment card that was used in a transaction.

Constructor Summary

Constructors
Constructor and Description

CardPaymentData()
Constructor.

Constructors
Constructor and Description
`CardPaymentData()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcquirerName()`
`java.lang.String`	`getAcquirerReference()`
`java.lang.String`	`getApprovalCode()` Deprecated. Use getAuthorisingData().getApprovalCode() instead.
`AuthorisationData`	`getAuthorisationData()`
`AuthorisationMethod`	`getAuthorisationMethod()` Deprecated. Use getAuthorisationData().getAuthorisingChannel() instead.
`AuthorisingEntity`	`getAuthorisingEntity()` Deprecated. Use getAuthorisationData().getAuthorisingEntity() instead.
`java.lang.String`	`getCardExpiryDate()`
`java.lang.String`	`getCardholderObscuredPan()`
`java.lang.String`	`getCardName()`
`java.lang.String`	`getCardNumberAlias()`
`DccData`	`getDccData()`
`DebitCreditSelection`	`getDebitCreditSelection()`
`EmvData`	`getEmvData()` Get EMV data.
`java.lang.Boolean`	`getIsContactless()`
`java.lang.String`	`getLoyaltyId()`
`java.lang.String`	`getMerchantObscuredPan()`
`PosEntryModes`	`getPosEntryMode()`
`VerificationMethod`	`getVerificationMethod()`
`void`	`setAcquirerName(java.lang.String value)`
`void`	`setAcquirerReference(java.lang.String value)`
`void`	`setApprovalCode(java.lang.String value)`
`void`	`setAuthorisationData(AuthorisationData value)`
`void`	`setAuthorisationMethod(AuthorisationMethod value)`
`void`	`setAuthorisingEntity(AuthorisingEntity value)`
`void`	`setCardExpiryDate(java.lang.String value)`
`void`	`setCardholderObscuredPan(java.lang.String value)`
`void`	`setCardName(java.lang.String value)`
`void`	`setCardNumberAlias(java.lang.String cardNumberAlias)`
`void`	`setDccData(DccData value)`
`void`	`setDebitCreditSelection(DebitCreditSelection value)`
`void`	`setEmvData(EmvData value)`
`void`	`setIsContactless(java.lang.Boolean value)` Set contactless card.
`void`	`setLoyaltyId(java.lang.String loyaltyId)`
`void`	`setMerchantObscuredPan(java.lang.String value)`
`void`	`setPosEntryMode(PosEntryModes value)`
`void`	`setVerificationMethod(VerificationMethod value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CardPaymentData
```
public CardPaymentData()
```
    Constructor.
- Method Detail
  - getAuthorisationData
```
public AuthorisationData getAuthorisationData()
```
    Returns:
    
    Information about the authorisation of the transaction.
  - setAuthorisationData
```
public void setAuthorisationData(AuthorisationData value)
```
    Parameters:
    
    value - Information about the authorisation of the transaction.
  - getApprovalCode
```
@Deprecated
public java.lang.String getApprovalCode()
```
    Deprecated. Use getAuthorisingData().getApprovalCode() instead.
    
    Gets the approval code for an authorised transaction.
    
    Returns:
    
    The approval code of the transaction. If the transaction is not authorised, or is declined, then the approval code will be null.
  - setApprovalCode
```
public void setApprovalCode(java.lang.String value)
```
    Parameters:
    
    value - The approval code of the transaction.
  - getAuthorisingEntity
```
@Deprecated
public AuthorisingEntity getAuthorisingEntity()
```
    Deprecated. Use getAuthorisationData().getAuthorisingEntity() instead.
    
    Returns:
    
    The party that authorised the transaction.
  - setAuthorisingEntity
```
public void setAuthorisingEntity(AuthorisingEntity value)
```
    Parameters:
    
    value - The party that authorised the transaction.
  - getAuthorisationMethod
```
@Deprecated
public AuthorisationMethod getAuthorisationMethod()
```
    Deprecated. Use getAuthorisationData().getAuthorisingChannel() instead.
    
    Returns:
    
    The method by which the transaction was authorised.
  - setAuthorisationMethod
```
public void setAuthorisationMethod(AuthorisationMethod value)
```
    Parameters:
    
    value - The method by which the transaction was authorised.
  - getCardName
```
public java.lang.String getCardName()
```
    Returns:
    
    The name of the card.
  - setCardName
```
public void setCardName(java.lang.String value)
```
    Parameters:
    
    value - The name of the card.
  - getCardExpiryDate
```
public java.lang.String getCardExpiryDate()
```
    Returns:
    
    The expiry date of the card.
  - setCardExpiryDate
```
public void setCardExpiryDate(java.lang.String value)
```
    Parameters:
    
    value - The expiry date of the card.
  - getDebitCreditSelection
```
public DebitCreditSelection getDebitCreditSelection()
```
    Returns:
    
    If the card used has been explicitly configured to select between Debit and Credit, this returns the selected value.
  - setDebitCreditSelection
```
public void setDebitCreditSelection(DebitCreditSelection value)
```
    Parameters:
    
    value - The Debit/Credit selection.
  - getEmvData
```
public EmvData getEmvData()
```
    Get EMV data.
    Returns:
    EMV data from the card. This is applies for cards that have EMV data:
    
    Cards inserted and read in the chip reader.
    
    Contactless cards that are tapped to the terminal.
    
    Note! There are contactless cards that does not contain EMV data, but they are not common in Europe. They are more common in North America (which means tourists might have them).
  - setEmvData
```
public void setEmvData(EmvData value)
```
    Parameters:
    
    value - The EMV data of the card.
  - getIsContactless
```
public java.lang.Boolean getIsContactless()
```
    Returns:
    
    true if the card was read with the contactless reader.
  - setIsContactless
```
public void setIsContactless(java.lang.Boolean value)
```
    Set contactless card.
    
    Parameters:
    
    value - true if the card was read with the contactless reader.
  - getCardholderObscuredPan
```
public java.lang.String getCardholderObscuredPan()
```
    Returns:
    
    The card number (PAN - primary account number) obscured.
  - setCardholderObscuredPan
```
public void setCardholderObscuredPan(java.lang.String value)
```
    Parameters:
    
    value - The obscured card number.
  - getMerchantObscuredPan
```
public java.lang.String getMerchantObscuredPan()
```
    Returns:
    
    The card number (PAN - primary account number) obscured.
  - setMerchantObscuredPan
```
public void setMerchantObscuredPan(java.lang.String value)
```
    Parameters:
    
    value - The obscured card number.
  - getVerificationMethod
```
public VerificationMethod getVerificationMethod()
```
    Returns:
    
    The method used to verify the card holder.
  - setVerificationMethod
```
public void setVerificationMethod(VerificationMethod value)
```
    Parameters:
    
    value - The method used to verify the card holder.
  - getDccData
```
public DccData getDccData()
```
    Returns:
    
    Information about the converted currency and amount used in the transaction, if the customer elected for Dynamic Currency Conversion. The DCC was not used, this returns null.
  - setDccData
```
public void setDccData(DccData value)
```
    Parameters:
    
    value - The DCC conversion data of the transaction.
  - getAcquirerName
```
public java.lang.String getAcquirerName()
```
    Returns:
    
    The acquirer's name or null.
  - setAcquirerName
```
public void setAcquirerName(java.lang.String value)
```
    Parameters:
    
    value - The acquirer name.
  - getAcquirerReference
```
public java.lang.String getAcquirerReference()
```
    Returns:
    
    The acquirer's reference number or null.
  - setAcquirerReference
```
public void setAcquirerReference(java.lang.String value)
```
    Parameters:
    
    value - The acquirer's reference number.
  - getPosEntryMode
```
public PosEntryModes getPosEntryMode()
```
    Returns:
    
    The card entry method.
  - setPosEntryMode
```
public void setPosEntryMode(PosEntryModes value)
```
    Parameters:
    
    value - The card entry method.
  - getCardNumberAlias
```
public java.lang.String getCardNumberAlias()
```
    Returns:
    
    The card number alias (CNA). The CNA is a number that can be used to identify a card holder. The CNA is derived from the card number but has been obfuscated in such a way that it is not considered sensitive by the PCI standards.
    The CNA is a string of hexadecimal digits, representing binary data.
    Note! The terminal must be configured to calculate the CNA. If it is not, then this property will be empty. Contact your Westpay representative if you require access to this data.
  - setCardNumberAlias
```
public void setCardNumberAlias(java.lang.String cardNumberAlias)
```
    Parameters:
    
    cardNumberAlias - Sets the card number alias (CNA).
  - getLoyaltyId
```
public java.lang.String getLoyaltyId()
```
    Returns:
    
    The loyalty id that has been registered, if any. The loyalty id is only set if a loyalty card has been registered during the transaction. If no loyalty has been registered, then this returns an empty string.
    If loyalty has been registered, then this returns a string that is divided into two parts: a name and an id. The parts are separated by an equal sign. The name is the name of the loyalty card/application. The id is the specific loyalty account from the card.
    An example could be "S-BONUS=123456789123456"
    Note that an EMV based loyalty application like S-BONUS can only appear hear if it has been activated for the transaction in TransactionRequest.setLoyaltyApplications(String[]).
    
    Since:
    
    Version 1.7. Requires Westpay Payment Application 2.0.11, or later.
    
    See Also:
    
    VerifyCardData#getLoyaltyId()
  - setLoyaltyId
```
public void setLoyaltyId(java.lang.String loyaltyId)
```
    Parameters:
    
    loyaltyId - Sets the loyalty id.

Class CardPaymentData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CardPaymentData

Method Detail

getAuthorisationData

setAuthorisationData

getApprovalCode

setApprovalCode

getAuthorisingEntity

setAuthorisingEntity

getAuthorisationMethod

setAuthorisationMethod

getCardName

setCardName

getCardExpiryDate

setCardExpiryDate

getDebitCreditSelection

setDebitCreditSelection

getEmvData

setEmvData

getIsContactless

setIsContactless

getCardholderObscuredPan

setCardholderObscuredPan

getMerchantObscuredPan

setMerchantObscuredPan

getVerificationMethod

setVerificationMethod

getDccData

setDccData

getAcquirerName

setAcquirerName

getAcquirerReference

setAcquirerReference

getPosEntryMode

setPosEntryMode

getCardNumberAlias

setCardNumberAlias

getLoyaltyId

setLoyaltyId