Package com.blockchyp.client.dto
Class ReceiptSuggestions
java.lang.Object
com.blockchyp.client.dto.ReceiptSuggestions
EMV fields we recommend developers put on their receipts.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAid()Gets the EMV Application Identifier.Gets a description of the selected AID.getArc()Gets the EMV Authorization Response Code.getArqc()Gets the EMV Application Request Cryptogram.Gets the amount authorized by the payment network.intGets the sequence of the transaction in the batch.Gets the amount of cash back that was approved.Gets the discount applied to the transaction for payment methods ineligible for surcharges.Gets the customer verification method used for the transaction.Gets the method by which the payment card was entered (MSR, CHIP, KEYED, etc.getIad()Gets the EMV Issuer Application Data.Gets the masked primary account number of the payment card, as required.Gets the ID of the merchant.Gets the partially masked merchant key required on EMV receipts.Gets the name of the merchant's business.Gets the amount added to the transaction to cover eligible credit card fees.getTc()Gets the EMV Transaction Certificate.Gets the ID of the payment terminal.Gets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).getTsi()Gets the EMV Transaction Status Indicator.getTvr()Gets the EMV Terminal Verification Response.booleanGets that a chip read failure caused the transaction to fall back to the magstripe.booleanGets that PIN verification was performed.booleanGets that the receipt should contain a signature line.voidSets the EMV Application Identifier.voidsetApplicationLabel(String value) Sets a description of the selected AID.voidSets the EMV Authorization Response Code.voidSets the EMV Application Request Cryptogram.voidsetAuthorizedAmount(String value) Sets the amount authorized by the payment network.voidsetBatchSequence(int value) Sets the sequence of the transaction in the batch.voidsetCashBackAmount(String value) Sets the amount of cash back that was approved.voidsetCashDiscount(String value) Sets the discount applied to the transaction for payment methods ineligible for surcharges.voidsetCvmUsed(CvmType value) Sets the customer verification method used for the transaction.voidsetEntryMethod(String value) Sets the method by which the payment card was entered (MSR, CHIP, KEYED, etc.voidsetFallback(boolean value) Sets that a chip read failure caused the transaction to fall back to the magstripe.voidSets the EMV Issuer Application Data.voidsetMaskedPan(String value) Sets the masked primary account number of the payment card, as required.voidsetMerchantId(String value) Sets the ID of the merchant.voidsetMerchantKey(String value) Sets the partially masked merchant key required on EMV receipts.voidsetMerchantName(String value) Sets the name of the merchant's business.voidsetPinVerified(boolean value) Sets that PIN verification was performed.voidsetRequestSignature(boolean value) Sets that the receipt should contain a signature line.voidsetSurcharge(String value) Sets the amount added to the transaction to cover eligible credit card fees.voidSets the EMV Transaction Certificate.voidsetTerminalId(String value) Sets the ID of the payment terminal.voidsetTransactionType(String value) Sets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).voidSets the EMV Transaction Status Indicator.voidSets the EMV Terminal Verification Response.
-
Constructor Details
-
ReceiptSuggestions
public ReceiptSuggestions()
-
-
Method Details
-
setAid
Sets the EMV Application Identifier.- Parameters:
value- the EMV Application Identifier.
-
getAid
Gets the EMV Application Identifier.- Returns:
- the EMV Application Identifier.
-
setArqc
Sets the EMV Application Request Cryptogram.- Parameters:
value- the EMV Application Request Cryptogram.
-
getArqc
Gets the EMV Application Request Cryptogram.- Returns:
- the EMV Application Request Cryptogram.
-
setIad
Sets the EMV Issuer Application Data.- Parameters:
value- the EMV Issuer Application Data.
-
getIad
Gets the EMV Issuer Application Data.- Returns:
- the EMV Issuer Application Data.
-
setArc
Sets the EMV Authorization Response Code.- Parameters:
value- the EMV Authorization Response Code.
-
getArc
Gets the EMV Authorization Response Code.- Returns:
- the EMV Authorization Response Code.
-
setTc
Sets the EMV Transaction Certificate.- Parameters:
value- the EMV Transaction Certificate.
-
getTc
Gets the EMV Transaction Certificate.- Returns:
- the EMV Transaction Certificate.
-
setTvr
Sets the EMV Terminal Verification Response.- Parameters:
value- the EMV Terminal Verification Response.
-
getTvr
Gets the EMV Terminal Verification Response.- Returns:
- the EMV Terminal Verification Response.
-
setTsi
Sets the EMV Transaction Status Indicator.- Parameters:
value- the EMV Transaction Status Indicator.
-
getTsi
Gets the EMV Transaction Status Indicator.- Returns:
- the EMV Transaction Status Indicator.
-
setTerminalId
Sets the ID of the payment terminal.- Parameters:
value- the ID of the payment terminal.
-
getTerminalId
Gets the ID of the payment terminal.- Returns:
- the ID of the payment terminal.
-
setMerchantName
Sets the name of the merchant's business.- Parameters:
value- the name of the merchant's business.
-
getMerchantName
Gets the name of the merchant's business.- Returns:
- the name of the merchant's business.
-
setMerchantId
Sets the ID of the merchant.- Parameters:
value- the ID of the merchant.
-
getMerchantId
Gets the ID of the merchant.- Returns:
- the ID of the merchant.
-
setMerchantKey
Sets the partially masked merchant key required on EMV receipts.- Parameters:
value- the partially masked merchant key required on EMV receipts.
-
getMerchantKey
Gets the partially masked merchant key required on EMV receipts.- Returns:
- the partially masked merchant key required on EMV receipts.
-
setApplicationLabel
Sets a description of the selected AID.- Parameters:
value- a description of the selected AID.
-
getApplicationLabel
Gets a description of the selected AID.- Returns:
- a description of the selected AID.
-
setRequestSignature
public void setRequestSignature(boolean value) Sets that the receipt should contain a signature line.- Parameters:
value- that the receipt should contain a signature line.
-
isRequestSignature
public boolean isRequestSignature()Gets that the receipt should contain a signature line.- Returns:
- that the receipt should contain a signature line.
-
setMaskedPan
Sets the masked primary account number of the payment card, as required.- Parameters:
value- the masked primary account number of the payment card, as required.
-
getMaskedPan
Gets the masked primary account number of the payment card, as required.- Returns:
- the masked primary account number of the payment card, as required.
-
setAuthorizedAmount
Sets the amount authorized by the payment network.- Parameters:
value- the amount authorized by the payment network. Could be less than the requested amount for partial auth.
-
getAuthorizedAmount
Gets the amount authorized by the payment network.- Returns:
- the amount authorized by the payment network. Could be less than the requested amount for partial auth.
-
setTransactionType
Sets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).- Parameters:
value- the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
-
getTransactionType
Gets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).- Returns:
- the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
-
setEntryMethod
Sets the method by which the payment card was entered (MSR, CHIP, KEYED, etc.- Parameters:
value- the method by which the payment card was entered (MSR, CHIP, KEYED, etc.).
-
getEntryMethod
Gets the method by which the payment card was entered (MSR, CHIP, KEYED, etc.- Returns:
- the method by which the payment card was entered (MSR, CHIP, KEYED, etc.).
-
setPinVerified
public void setPinVerified(boolean value) Sets that PIN verification was performed.- Parameters:
value- that PIN verification was performed.
-
isPinVerified
public boolean isPinVerified()Gets that PIN verification was performed.- Returns:
- that PIN verification was performed.
-
setCvmUsed
Sets the customer verification method used for the transaction.- Parameters:
value- the customer verification method used for the transaction.
-
getCvmUsed
Gets the customer verification method used for the transaction.- Returns:
- the customer verification method used for the transaction.
-
setFallback
public void setFallback(boolean value) Sets that a chip read failure caused the transaction to fall back to the magstripe.- Parameters:
value- that a chip read failure caused the transaction to fall back to the magstripe.
-
isFallback
public boolean isFallback()Gets that a chip read failure caused the transaction to fall back to the magstripe.- Returns:
- that a chip read failure caused the transaction to fall back to the magstripe.
-
setBatchSequence
public void setBatchSequence(int value) Sets the sequence of the transaction in the batch.- Parameters:
value- the sequence of the transaction in the batch.
-
getBatchSequence
public int getBatchSequence()Gets the sequence of the transaction in the batch.- Returns:
- the sequence of the transaction in the batch.
-
setCashBackAmount
Sets the amount of cash back that was approved.- Parameters:
value- the amount of cash back that was approved.
-
getCashBackAmount
Gets the amount of cash back that was approved.- Returns:
- the amount of cash back that was approved.
-
setSurcharge
Sets the amount added to the transaction to cover eligible credit card fees.- Parameters:
value- the amount added to the transaction to cover eligible credit card fees.
-
getSurcharge
Gets the amount added to the transaction to cover eligible credit card fees.- Returns:
- the amount added to the transaction to cover eligible credit card fees.
-
setCashDiscount
Sets the discount applied to the transaction for payment methods ineligible for surcharges.- Parameters:
value- the discount applied to the transaction for payment methods ineligible for surcharges.
-
getCashDiscount
Gets the discount applied to the transaction for payment methods ineligible for surcharges.- Returns:
- the discount applied to the transaction for payment methods ineligible for surcharges.
-