Logo
Developer SDK
Version 1.9.632.913d652c-152450467.
Classes | Public Member Functions | Static Public Attributes | List of all members
CardInformation Class Reference
Inheritance diagram for CardInformation:
CPBaseParcel BaseParcel StoredValueCardInformation

Classes

enum  PresentationMethod
 
enum  TokenizationMethod
 

Public Member Functions

PresentationMethod getPresentationMethod ()
 
String getCardCurrency ()
 
String getCardCountry ()
 
String getCardPreferredLanguages ()
 
String getCardToken ()
 
TokenizationMethod getCardTokenizationMethod ()
 
String getBankUserData ()
 
String getPanHandle ()
 
String getPanLast4 ()
 
String getPanFirst2 ()
 
HashMap< String, String > getEmvTags ()
 
String getBin ()
 
String getEncryptedTracks ()
 
String getEncryptedTracksKsn ()
 
String getEncryptedPan ()
 
String getEncryptedPanKsn ()
 
String getCardHolderName ()
 
String getCardTrack1 ()
 
String getCardTrack2 ()
 
String getCardTrack3 ()
 
String getCardPan ()
 
String getCardExpiry ()
 
String getCardStatus ()
 
String getPaymentBrand ()
 
BigDecimal getAvailableBalance ()
 
String getAccountReference ()
 
void setCardCurrency (String cardCurrency)
 
void setCardCountry (String cardCountry)
 
void setCardPreferredLanguages (String cardPreferredLanguages)
 
void setCardHolderName (String cardHolderName)
 
void setCardTrack1 (String cardTrack1)
 
void setCardTrack2 (String cardTrack2)
 
void setCardTrack3 (String cardTrack3)
 
void setCardPan (String cardPan)
 
void setCardExpiry (String cardExpiry)
 
void setCardStatus (String cardStatus)
 
void setPresentationMethod (PresentationMethod presentationMethod)
 
void setPanHandle (String panHandle)
 
void setPanLast4 (String panLast4)
 
void setPanFirst2 (String panFirst2)
 
void setEmvTags (HashMap< String, String > emvTags)
 
void setBin (String bin)
 
void setEncryptedTracks (String encryptedTracks)
 
void setEncryptedTracksKsn (String encryptedTracksKsn)
 
void setEncryptedPan (String encryptedPan)
 
void setEncryptedPanKsn (String encryptedPanKsn)
 
void setPaymentBrand (String paymentBrand)
 
void setCardToken (String cardToken)
 
void setCardTokenizationMethod (TokenizationMethod method)
 
void setBankUserData (String bankUserData)
 
void setAvailableBalance (BigDecimal availableBalance)
 
void setAccountReference (String accountReference)
 
 CardInformation (Parcel in, int parcelVersion)
 
void writeToJson (JSONObject jsonObject) throws JSONException
 
void writeToParcel (Parcel dest, int flags)
 
- Public Member Functions inherited from CPBaseParcel
 CPBaseParcel (Parcel in, int parcelVersion)
 
- Public Member Functions inherited from BaseParcel
 BaseParcel (Parcel in, int parcelVersion)
 
void setParcelVersion (int targetParcelVersion)
 
final int getParcelVersion ()
 
String getClassName ()
 
void writeToParcel (Parcel dest, int flags)
 
int describeContents ()
 

Static Public Attributes

static final String UNSET_PAYMENT_BRAND = ""
 
static final String UNKNOWN_PAYMENT_BRAND = "Unknown"
 
static final String AMEX = "American Express"
 
static final String DISCOVER = "Discover"
 
static final String MASTER_CARD = "MasterCard"
 
static final String VISA = "Visa"
 
static final String JCB = "JCB"
 
static final String PCI_CARD = "PCI_CARD"
 
static final String NON_PCI_CARD_STATUS = "NON_PCI_CARD"
 
static final String USER_CANCEL_STATUS = "USER_CANCEL"
 
static final String LANGUAGES_SEPARATOR = ","
 
static final Creator< CardInformation > CREATOR
 
- Static Public Attributes inherited from BaseParcel
static final Parcelable.Creator< BaseParcel > CREATOR
 

Additional Inherited Members

- Static Public Member Functions inherited from CPBaseParcel
static< CPEntityType extends CPBaseParcel > CPEntityType buildFromCpJson ( @NonNull JSONObject jsonObject, @NonNull Class< CPEntityType > clazz, @Nullable CPEntityType parentObject)
 
- Protected Member Functions inherited from CPBaseParcel
abstract< CPEntityType extends CPBaseParcel > CPEntityType buildFromCpJson ( @NonNull JSONObject jsonObject, @Nullable CPEntityType parentObject)
 
- Static Protected Member Functions inherited from CPBaseParcel
static< CPEntityType extends CPBaseParcel > ArrayList< CPEntityType > buildListFromCpJson ( @NonNull JSONObject jsonObject, @NonNull Class< CPEntityType > clazz, @NonNull String targetJsonAlias)
 
- Static Protected Member Functions inherited from BaseParcel
static void safelySetParcelVersion (final int targetParcelVersion, @Nullable BaseParcel item)
 
static void safelySetParcelVersion (final int targetParcelVersion, @Nullable List<? extends BaseParcel > items)
 
static< T extends BaseParcel > void safelySetParcelVersion (final int targetParcelVersion, @Nullable T[] items)
 

Detailed Description

This represents the data that is shared between the terminal and the Android application. Setting the fields is only relevant when sending the data to the terminal, and conversely, getting the fields is only relevant when receiving this object from the terminal.

Definition at line 35 of file CardInformation.java.

Member Function Documentation

◆ getAccountReference()

String getAccountReference ( )

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.

Definition at line 381 of file CardInformation.java.

◆ getAvailableBalance()

BigDecimal getAvailableBalance ( )

The balance remaining on the card.

Definition at line 371 of file CardInformation.java.

◆ getBankUserData()

String getBankUserData ( )

Depending on the host, sometimes specific user data is provided to supplement the token.

Definition at line 222 of file CardInformation.java.

◆ getBin()

String getBin ( )

The first six digits of the card holder PAN. Generally not present alongside the last four digits, this is only provided during specific triggers.

Definition at line 264 of file CardInformation.java.

◆ getCardCountry()

String getCardCountry ( )

Present only with EMV cards and is representation of EMV Tag5F28.

Definition at line 190 of file CardInformation.java.

◆ getCardCurrency()

String getCardCurrency ( )

Present only with EMV cards and is representation of EMV Tag9F42.

Definition at line 182 of file CardInformation.java.

◆ getCardExpiry()

String getCardExpiry ( )

This is included only when specifically requested using the Commerce API, and when the card status is NON_PCI_CARD.

Definition at line 350 of file CardInformation.java.

◆ getCardHolderName()

String getCardHolderName ( )

This is included only when specifically requested using the Commerce API, and when the card status is NON_PCI_CARD.

Definition at line 305 of file CardInformation.java.

◆ getCardPan()

String getCardPan ( )

This is included only when specifically requested using the Commerce API, and when the card status is NON_PCI_CARD.

Definition at line 341 of file CardInformation.java.

◆ getCardPreferredLanguages()

String getCardPreferredLanguages ( )

Present only with EMV cards and is representation of EMV Tag5F2D.

Definition at line 198 of file CardInformation.java.

◆ getCardStatus()

String getCardStatus ( )

The status of the card when the card data is requested specifically using the Commerce API.

Definition at line 358 of file CardInformation.java.

◆ getCardToken()

String getCardToken ( )

The token representation of the card.

Definition at line 205 of file CardInformation.java.

◆ getCardTokenizationMethod()

TokenizationMethod getCardTokenizationMethod ( )

The method by which the card was tokenized. This is particularly relevant when the tokenization is requested through the CP API call, but not relevant in the context of running a payment.

Definition at line 214 of file CardInformation.java.

◆ getCardTrack1()

String getCardTrack1 ( )

This is included only when specifically requested using the Commerce API, and when the card status is NON_PCI_CARD.

Definition at line 314 of file CardInformation.java.

◆ getCardTrack2()

String getCardTrack2 ( )

This is included only when specifically requested using the Commerce API, and when the card status is NON_PCI_CARD.

Definition at line 323 of file CardInformation.java.

◆ getCardTrack3()

String getCardTrack3 ( )

This is included only when specifically requested using the Commerce API, and when the card status is NON_PCI_CARD.

Definition at line 332 of file CardInformation.java.

◆ getEmvTags()

HashMap<String, String> getEmvTags ( )

Present only with EMV cards, this is the relevant EMV Tags necessary for record keeping.

Definition at line 255 of file CardInformation.java.

◆ getEncryptedPan()

String getEncryptedPan ( )

This is included only when specifically requested using the Commerce API.

Definition at line 288 of file CardInformation.java.

◆ getEncryptedPanKsn()

String getEncryptedPanKsn ( )

This is included only when specifically requested using the Commerce API.

Definition at line 296 of file CardInformation.java.

◆ getEncryptedTracks()

String getEncryptedTracks ( )

This is included only when specifically requested using the Commerce API.

Definition at line 272 of file CardInformation.java.

◆ getEncryptedTracksKsn()

String getEncryptedTracksKsn ( )

This is included only when specifically requested using the Commerce API.

Definition at line 280 of file CardInformation.java.

◆ getPanFirst2()

String getPanFirst2 ( )

The first two digits of the card holder PAN.

Definition at line 248 of file CardInformation.java.

◆ getPanHandle()

String getPanHandle ( )

A reference returned by the Payment Application to refer to the PAN in question. A Commerce Application may choose to use PAN_Handle to request an encrypted PAN via API CP_APP_REQUESTS_ENCRYPTED_CARD.

Definition at line 232 of file CardInformation.java.

◆ getPanLast4()

String getPanLast4 ( )

The last four digits of the card holder PAN.

Definition at line 240 of file CardInformation.java.

◆ getPaymentBrand()

String getPaymentBrand ( )

The brand for the card. Returns a constant value, see VISA as an example.

Definition at line 365 of file CardInformation.java.

◆ getPresentationMethod()

PresentationMethod getPresentationMethod ( )

The method used to obtain the card data.

Definition at line 174 of file CardInformation.java.

◆ setAccountReference()

void setAccountReference ( String  accountReference)

Refer to getAccountReference().

Definition at line 563 of file CardInformation.java.

◆ setAvailableBalance()

void setAvailableBalance ( BigDecimal  availableBalance)

Refer to getAvailableBalance().

Definition at line 556 of file CardInformation.java.

◆ setBankUserData()

void setBankUserData ( String  bankUserData)

Refer to getBankUserData().

Definition at line 549 of file CardInformation.java.

◆ setBin()

void setBin ( String  bin)

Refer to getBin().

Definition at line 493 of file CardInformation.java.

◆ setCardCountry()

void setCardCountry ( String  cardCountry)

Refer to getCardCountry().

Definition at line 395 of file CardInformation.java.

◆ setCardCurrency()

void setCardCurrency ( String  cardCurrency)

Refer to getCardCurrency().

Definition at line 388 of file CardInformation.java.

◆ setCardExpiry()

void setCardExpiry ( String  cardExpiry)

Refer to getCardExpiry().

Definition at line 444 of file CardInformation.java.

◆ setCardHolderName()

void setCardHolderName ( String  cardHolderName)

Refer to getCardHolderName().

Definition at line 409 of file CardInformation.java.

◆ setCardPan()

void setCardPan ( String  cardPan)

Refer to getCardPan().

Definition at line 437 of file CardInformation.java.

◆ setCardPreferredLanguages()

void setCardPreferredLanguages ( String  cardPreferredLanguages)

Refer to getCardPreferredLanguages().

Definition at line 402 of file CardInformation.java.

◆ setCardStatus()

void setCardStatus ( String  cardStatus)

Refer to getCardStatus().

Definition at line 451 of file CardInformation.java.

◆ setCardToken()

void setCardToken ( String  cardToken)

Refer to getCardToken().

Definition at line 535 of file CardInformation.java.

◆ setCardTokenizationMethod()

void setCardTokenizationMethod ( TokenizationMethod  method)

Refer to getCardTokenizationMethod().

Definition at line 542 of file CardInformation.java.

◆ setCardTrack1()

void setCardTrack1 ( String  cardTrack1)

Refer to getCardTrack1().

Definition at line 416 of file CardInformation.java.

◆ setCardTrack2()

void setCardTrack2 ( String  cardTrack2)

Refer to getCardTrack2().

Definition at line 423 of file CardInformation.java.

◆ setCardTrack3()

void setCardTrack3 ( String  cardTrack3)

Refer to getCardTrack3().

Definition at line 430 of file CardInformation.java.

◆ setEmvTags()

void setEmvTags ( HashMap< String, String >  emvTags)

Refer to getEmvTags().

Definition at line 486 of file CardInformation.java.

◆ setEncryptedPan()

void setEncryptedPan ( String  encryptedPan)

Refer to getEncryptedPan().

Definition at line 514 of file CardInformation.java.

◆ setEncryptedPanKsn()

void setEncryptedPanKsn ( String  encryptedPanKsn)

Refer to getEncryptedPanKsn().

Definition at line 521 of file CardInformation.java.

◆ setEncryptedTracks()

void setEncryptedTracks ( String  encryptedTracks)

Refer to getEncryptedTracks().

Definition at line 500 of file CardInformation.java.

◆ setEncryptedTracksKsn()

void setEncryptedTracksKsn ( String  encryptedTracksKsn)

Refer to getEncryptedTracksKsn().

Definition at line 507 of file CardInformation.java.

◆ setPanFirst2()

void setPanFirst2 ( String  panFirst2)

Refer to getPanFirst2().

Definition at line 479 of file CardInformation.java.

◆ setPanHandle()

void setPanHandle ( String  panHandle)

Refer to getPanHandle().

Definition at line 465 of file CardInformation.java.

◆ setPanLast4()

void setPanLast4 ( String  panLast4)

Refer to getPanLast4().

Definition at line 472 of file CardInformation.java.

◆ setPaymentBrand()

void setPaymentBrand ( String  paymentBrand)

Refer to getPaymentBrand().

Definition at line 528 of file CardInformation.java.

◆ setPresentationMethod()

void setPresentationMethod ( PresentationMethod  presentationMethod)

Refer to getPresentationMethod().

Definition at line 458 of file CardInformation.java.

Member Data Documentation

◆ AMEX

final String AMEX = "American Express"
static

The constant value for the American Express Payment Brand.

Definition at line 48 of file CardInformation.java.

◆ CREATOR

final Creator<CardInformation> CREATOR
static
Initial value:
=
new CardInformation.ParcelCreator<CardInformation>() {
@Override
public CardInformation createFromParcel(Parcel source) {
BaseParcel createdObject = super.createFromParcel(source);
if (createdObject == null || !CardInformation.class.isInstance(createdObject))
return new CardInformation(source, getRecommendedParcelVersion());
else
return (CardInformation) createdObject;
}
@Override
public CardInformation[] newArray(int size) {
return new CardInformation[size];
}
}

Definition at line 777 of file CardInformation.java.

◆ DISCOVER

final String DISCOVER = "Discover"
static

The constant value for the Discover Payment Brand.

Definition at line 52 of file CardInformation.java.

◆ JCB

final String JCB = "JCB"
static

The constant value for the JCB Payment Brand.

Definition at line 64 of file CardInformation.java.

◆ MASTER_CARD

final String MASTER_CARD = "MasterCard"
static

The constant value for the Master Card Payment Brand.

Definition at line 56 of file CardInformation.java.

◆ NON_PCI_CARD_STATUS

final String NON_PCI_CARD_STATUS = "NON_PCI_CARD"
static

The card status for a card that is not regulated, often times a loyalty card or membership card.

Definition at line 74 of file CardInformation.java.

◆ PCI_CARD

final String PCI_CARD = "PCI_CARD"
static

The card status for a card that must be treated according to PCI regulations.

Definition at line 69 of file CardInformation.java.

◆ UNKNOWN_PAYMENT_BRAND

final String UNKNOWN_PAYMENT_BRAND = "Unknown"
static

The constant value when the payment brand is not recognized but present.

Definition at line 44 of file CardInformation.java.

◆ UNSET_PAYMENT_BRAND

final String UNSET_PAYMENT_BRAND = ""
static

The default constant value for the payment brand, instead of null.

Definition at line 40 of file CardInformation.java.

◆ USER_CANCEL_STATUS

final String USER_CANCEL_STATUS = "USER_CANCEL"
static

The card status for a card read that was cancelled by the user.

Definition at line 78 of file CardInformation.java.

◆ VISA

final String VISA = "Visa"
static

The constant value for the Visa Payment Brand.

Definition at line 60 of file CardInformation.java.

The documentation for this class was generated from the following file:

This document is the confidential property of Verifone, Inc. Any reproduction or distribution of this document, in whole or in part, or the disclosure of any of the information contained herein, without the prior written consent of Verifone, Inc. is prohibited. This document and any supplemental material supplied as part of any review must be returned to Verifone, Inc. upon request. Notice: This document may go through material revisions over time. While the Company will make every effort to keep readers updated as changes occur, care must be taken by the reader to make sure they are reading the latest version. Version numbers appear in the title page and revision history page of this document. All rights reserved. Verifone, the Verifone logo are either trademarks or registered trademarks of Verifone in the United States and/or other countries. All other trademarks or brand names are properties of their respective holders.