Class coresale

Inheritance diagram for com.payments.core.CoreSale:

com.payments.core.CoreSaleTrackContactless

Public Member Functions

CoreSale ()
CoreSale (BigDecimal amount)
CoreSale (BigDecimal amount, String orderId)
BigDecimal getAmount ()
void setAmount (BigDecimal amount)
String getOrderId ()
void setCardType (String cardType)
String getCardType ()
void addTax (CoreTax tax)
CoreTax getTax ()
void setTip (CoreTip tip)
void addTipWithAmount (BigDecimal tipAmount)
CoreTip getTip ()
Boolean getAutoReady ()
void setFallback (Boolean fallback)
Boolean getFallback ()
void setAutoReady (Boolean autoReady)
CoreSignature getSignature ()
void setSignature (CoreSignature signature)
void setDeviceType (String deviceType)
String getDeviceType ()
String getCardHolderName ()
void setCardHolderName (String cardHolderName)
TransactionType getTransactionType ()
void setTransactionType (TransactionType transactionType)
DebitAccountType getDebitAccountType ()
void setDebitAccountType (DebitAccountType debitAccountType)
int getFirstDigitOfPan ()
void setFirstDigitOfPan (int firstDigitOfPan)
String getSerial ()
void setSerial (String serial)
CoreTransactionInputMethod getTransactionInputMethod ()
void setTransactionInputMethod (CoreTransactionInputMethod transactionInputMethod)
SignatureCollection getSignatureCollection ()
void setSignatureCollection (SignatureCollection signatureCollection)
CoreSecureCard getCoreSecureCard ()
void setCoreSecureCard (CoreSecureCard coreSecureCard)
SaleRequestType getSaleRequestType ()
void setSaleRequestType (SaleRequestType saleRequestType)
TerminalCategory getTerminalCategory ()
void setTerminalCategory (TerminalCategory terminalCategory)
boolean isSignatureRequired ()
void setSignatureRequired (boolean isSignatureRequired)
void setDelayedAuthEnabled (boolean isDelayedAuthEnabled)
boolean isDelayedAuthEnabled ()
void setGiftCard (boolean isGiftCard)
boolean isGiftCard ()
void setFallbackReason (FallbackReason fallbackReason)
FallbackReason getFallbackReason ()
void setDeviceFirmware (String deviceFirmware)
String getDeviceFirmware ()
void setEmvType (CoreEmvType emvType)
CoreEmvType getEmvType ()
void setDateTime (String dateTime)
String getDateTime ()
String getMaskedPAN ()
void setMaskedPAN (String maskedPAN)
void setExpiryDate (String expiryDate)
String getExpiryDate ()
void setEncryptedPinBlock (String encryptedPinBlock)
String getEncryptedPinBlock ()
void setPinBlockKsn (String pinBlockKsn)
String getPinBlockKsn ()
List< CoreCustomField > getCustomFields ()
void setCustomFields (List< CoreCustomField > customFields)
Boolean getContactlessMsr ()
void setContactlessMsr (Boolean contactlessMsr)
Public Member Functions inherited from com.payments.core.common.ResponseJson
String getAsJsonObject ()

Protected Attributes

String cardHolderName
String maskedPAN
DebitAccountType debitAccountType = DebitAccountType.NOTSPECIFIED
TransactionType transactionType

Detailed Description

This class represents the sale object used for processing the transaction with the device.

// Device example CoreSale sale = new CoreSale(1.12);
AndroidTerminal.getInstance().processSale(sale);
// or if you use Java, use JavaTerminal.getInstance().processSale(sale);

Constructor & Destructor Documentation

CoreSale() [1/3]

    • com.payments.core.CoreSale.CoreSale
    • (
    • )

  • inline

CoreSale() [2/3]

    • com.payments.core.CoreSale.CoreSale
    • (
    • BigDecimal
    • amount
    • )

  • inline

Constructor 1 initializes a new instance of a class CoreSale.

Parameters

  • amount
  • of a transaction to be processed.

CoreSale() [3/3]

    • com.payments.core.CoreSale.CoreSale
    • (
    • BigDecimal
    • amount,

    • String
    • orderId

    • )

  • inline

Constructor 2 initializes a new instance of a class CoreSale.

Parameters

  • amount
  • of a transaction to be processed.

  • orderId
  • holds order ID.

Member Function Documentation

addTax()

    • void com.payments.core.CoreSale.addTax
    • (
    • CoreTax
    • tax
    • )

  • inline

Sets the value of tax property.

Parameters

  • tax

addTipWithAmount()

    • void com.payments.core.CoreSale.addTipWithAmount
    • (
    • BigDecimal
    • tipAmount
    • )

  • inline

Sets the value of tipAmount property.

sale.addTipWithAmount(BigDecimal.valueOf(2));

Parameters

  • tipAmount
  • amount of tip to be added to the transaction

getAmount()

    • BigDecimal com.payments.core.CoreSale.getAmount
    • (
    • )

  • inline

The BigDecimal instance represents amount set for each transaction.

Returns

amount of a transaction

getAutoReady()

    • Boolean com.payments.core.CoreSale.getAutoReady
    • (
    • )

  • inline

The Boolean instance represents auto ready when it is set to true transactions are automatically set to ready status in the open batch recommended(auto ready set to true).

Returns

autoReady

getCardHolderName()

    • String com.payments.core.CoreSale.getCardHolderName
    • (
    • )

  • inline

Gets the value of the cardholderName property.

Returns

cardholderName - card holder name

getCardType()

    • String com.payments.core.CoreSale.getCardType
    • (
    • )

  • inline

The String instance represents card type eg: Visa,MasterCard.

Returns

cardType which holds the type of a card (e.g VISA)

getContactlessMsr()

    • Boolean com.payments.core.CoreSale.getContactlessMsr
    • (
    • )

  • inline

getCoreSecureCard()

  • inline

getCustomFields()

  • inline

Gets the list of custom fields.

Returns

customFields

getDateTime()

    • String com.payments.core.CoreSale.getDateTime
    • (
    • )

  • inline

Gets the value of the dateTime property.

Returns

emvType - date time

getDebitAccountType()

Gets the value of the debitAccountType property.

Returns

debitAccountType

getDeviceFirmware()

    • String com.payments.core.CoreSale.getDeviceFirmware
    • (
    • )

  • inline

Gets the value of the deviceFirmware property.

Returns

deviceFirmware

getDeviceType()

    • String com.payments.core.CoreSale.getDeviceType
    • (
    • )

  • inline

The String instance representing device type.

Returns

deviceType - type of a device

getEmvType()

    • CoreEmvType com.payments.core.CoreSale.getEmvType
    • (
    • )

  • inline

Gets the value of the emvType property.

Returns

emvType - EMV transaction type

getEncryptedPinBlock()

    • String com.payments.core.CoreSale.getEncryptedPinBlock
    • (
    • )

  • inline

The String instance representing encrypted pin block to be send for MSR and Pin transactions.

Returns

encryptedPinBlock

getExpiryDate()

    • String com.payments.core.CoreSale.getExpiryDate
    • (
    • )

  • inline

The String instance representing card expiry date(month,year) provided on the front of each credit/debit card.

Returns

expiryDate of a card

getFallback()

    • Boolean com.payments.core.CoreSale.getFallback
    • (
    • )

  • inline

The Boolean instance represents fallback.

Returns

fallback

getFallbackReason()

  • inline

Gets the value of the FallbackReason property.

Returns

fallbackReason

getFirstDigitOfPan()

    • int com.payments.core.CoreSale.getFirstDigitOfPan
    • (
    • )

  • inline

Gets the value of the firstDigitOfPan property.

Returns

firstDigitOfPan

getMaskedPAN()

    • String com.payments.core.CoreSale.getMaskedPAN
    • (
    • )

  • inline

getOrderId()

    • String com.payments.core.CoreSale.getOrderId
    • (
    • )

  • inline

The String instance represents order Id assigned to each transaction.

Returns

orderId

getPinBlockKsn()

    • String com.payments.core.CoreSale.getPinBlockKsn
    • (
    • )

  • inline

The String instance representing ksn for encrypted pin block.

Returns

pinBlockKsn

getSaleRequestType()

Gets the value of the saleRequestType property.

Returns

saleRequestType

getSerial()

    • String com.payments.core.CoreSale.getSerial
    • (
    • )

  • inline

Gets the value of the serial port property.

Returns

serial

getSignature()

  • inline

The CoreSignature instance represents signature.

Returns

signature

getSignatureCollection()

Gets the value of the signatureCollection property.

Returns

signatureCollection

getTax()

    • CoreTax com.payments.core.CoreSale.getTax
    • (
    • )

  • inline

The CoreTax instance represents tax that can be set for each transaction.

Returns

tax

getTerminalCategory()

Gets the value of the terminalCategory property.

Returns

terminalCategory

getTip()

    • CoreTip com.payments.core.CoreSale.getTip
    • (
    • )

  • inline

The CoreTip instance represents tip amount that can be set for each transaction.

Returns

tip

getTransactionInputMethod()

Gets the value of the transactionInputMethod property.

Returns

transactionInputMethod

getTransactionType()

Gets the value of the transactionType property.

Returns

transactionType

isDelayedAuthEnabled()

    • boolean com.payments.core.CoreSale.isDelayedAuthEnabled
    • (
    • )

  • inline

isGiftCard()

    • boolean com.payments.core.CoreSale.isGiftCard
    • (
    • )

  • inline

isSignatureRequired()

    • boolean com.payments.core.CoreSale.isSignatureRequired
    • (
    • )

  • inline

setAmount()

    • void com.payments.core.CoreSale.setAmount
    • (
    • BigDecimal
    • amount
    • )

  • inline

Sets the value of the amount property.

Parameters

  • amount
  • - of a transaction to be processed.

setAutoReady()

    • void com.payments.core.CoreSale.setAutoReady
    • (
    • Boolean
    • autoReady
    • )

  • inline

Sets the value of the autoReady property.

Parameters

  • autoReady

setCardHolderName()

    • void com.payments.core.CoreSale.setCardHolderName
    • (
    • String
    • cardHolderName
    • )

  • inline

Sets the value of the cardholderName property.

Parameters

  • cardHolderName
  • - card holder name

setCardType()

    • void com.payments.core.CoreSale.setCardType
    • (
    • String
    • cardType
    • )

  • inline

Sets the value of cardType property.

Parameters

  • cardType
  • of a card

setContactlessMsr()

    • void com.payments.core.CoreSale.setContactlessMsr
    • (
    • Boolean
    • contactlessMsr
    • )

  • inline

setCoreSecureCard()

    • void com.payments.core.CoreSale.setCoreSecureCard
    • (
    • CoreSecureCard
    • coreSecureCard
    • )

  • inline

setCustomFields()

    • void com.payments.core.CoreSale.setCustomFields
    • (
    • List< CoreCustomField >
    • customFields
    • )

  • inline

Sets the value of customFields property.

Parameters

  • customFields
  • for the sale

setDateTime()

    • void com.payments.core.CoreSale.setDateTime
    • (
    • String
    • dateTime
    • )

  • inline

Sets the value of the dateTime property.

Parameters

  • dateTime
  • - date time

setDebitAccountType()

    • void com.payments.core.CoreSale.setDebitAccountType
    • (
    • DebitAccountType
    • debitAccountType
    • )

  • inline

Sets the value of the transactionType property.

Parameters

  • debitAccountType

setDelayedAuthEnabled()

    • void com.payments.core.CoreSale.setDelayedAuthEnabled
    • (
    • boolean
    • isDelayedAuthEnabled
    • )

  • inline

setDeviceFirmware()

    • void com.payments.core.CoreSale.setDeviceFirmware
    • (
    • String
    • deviceFirmware
    • )

  • inline

Sets the value of the deviceFirmware property.

Parameters

  • deviceFirmware
  • - device firmware

setDeviceType()

    • void com.payments.core.CoreSale.setDeviceType
    • (
    • String
    • deviceType
    • )

  • inline

Sets the value of deviceType property.

Parameters

  • deviceType
  • - type of a device

setEmvType()

    • void com.payments.core.CoreSale.setEmvType
    • (
    • CoreEmvType
    • emvType
    • )

  • inline

Sets the value of the emvType property.

Parameters

  • emvType
  • - EMV transaction type

setEncryptedPinBlock()

    • void com.payments.core.CoreSale.setEncryptedPinBlock
    • (
    • String
    • encryptedPinBlock
    • )

  • inline

Sets the value of encryptedPinBlock property.

Parameters

  • encryptedPinBlock
  • - encrypted pin block

setExpiryDate()

    • void com.payments.core.CoreSale.setExpiryDate
    • (
    • String
    • expiryDate
    • )

  • inline

Sets the value of expiryDate property.

Parameters

  • expiryDate
  • of a card

setFallback()

    • void com.payments.core.CoreSale.setFallback
    • (
    • Boolean
    • fallback
    • )

  • inline

Sets the value of the fallback property.

Parameters

  • fallback

setFallbackReason()

    • void com.payments.core.CoreSale.setFallbackReason
    • (
    • FallbackReason
    • fallbackReason
    • )

  • inline

Sets the value of the fallbackReason property.

Parameters

  • fallbackReason
  • - fallback reason used for Empty Candidate Lists

setFirstDigitOfPan()

    • void com.payments.core.CoreSale.setFirstDigitOfPan
    • (
    • int
    • firstDigitOfPan
    • )

  • inline

Sets the value of the firstDigitOfPan property.

Parameters

  • firstDigitOfPan
  • - first digit of a card number

setGiftCard()

    • void com.payments.core.CoreSale.setGiftCard
    • (
    • boolean
    • isGiftCard
    • )

  • inline

setMaskedPAN()

    • void com.payments.core.CoreSale.setMaskedPAN
    • (
    • String
    • maskedPAN
    • )

  • inline

setPinBlockKsn()

    • void com.payments.core.CoreSale.setPinBlockKsn
    • (
    • String
    • pinBlockKsn
    • )

  • inline

Sets the value of pinBlockKsn property.

Parameters

  • pinBlockKsn
  • - pin block KSN

setSaleRequestType()

    • void com.payments.core.CoreSale.setSaleRequestType
    • (
    • SaleRequestType
    • saleRequestType
    • )

  • inline

Sets the value of the saleRequestType property.

Parameters

  • saleRequestType
  • - type of the sale request

setSerial()

    • void com.payments.core.CoreSale.setSerial
    • (
    • String
    • serial
    • )

  • inline

Sets the value of the serial port property.

Parameters

  • serial
  • - serial port

setSignature()

    • void com.payments.core.CoreSale.setSignature
    • (
    • CoreSignature
    • signature
    • )

  • inline

Sets the value of signature property.

Parameters

  • signature
  • which is added to the transaction

setSignatureCollection()

    • void com.payments.core.CoreSale.setSignatureCollection
    • (
    • SignatureCollection
    • signatureCollection
    • )

  • inline

Sets the value of the signatureCollection property.

Parameters

  • signatureCollection
  • - Manual or automatic

setSignatureRequired()

    • void com.payments.core.CoreSale.setSignatureRequired
    • (
    • boolean
    • isSignatureRequired
    • )

  • inline

setTerminalCategory()

    • void com.payments.core.CoreSale.setTerminalCategory
    • (
    • TerminalCategory
    • terminalCategory
    • )

  • inline

Sets the value of the terminalCategory property.

Parameters

  • terminalCategory
  • - category of the terminal

setTip()

    • void com.payments.core.CoreSale.setTip
    • (
    • CoreTip
    • tip
    • )

  • inline

Sets the value of tip property.

Parameters

  • tip
  • which is added to the transaction

setTransactionInputMethod()

Sets the value of the transactionInputMethod property.Start the transaction in different mode.(Swipe, Insert, Tap)

Parameters

  • transactionInputMethod
  • - mode

setTransactionType()

    • void com.payments.core.CoreSale.setTransactionType
    • (
    • TransactionType
    • transactionType
    • )

  • inline

Sets the value of the transactionType property.

Parameters

  • transactionType
  • - transaction type

Member Data Documentation

cardHolderName

    • String com.payments.core.CoreSale.cardHolderName

  • protected

String property representing device type.

debitAccountType

maskedPAN

    • String com.payments.core.CoreSale.maskedPAN

  • protected

String property representing masked card number

transactionType