ReceiptSuggestions (com.blockchyp:blockchyp-java 2.11.0 API)

java.lang.Object
- com.blockchyp.client.dto.ReceiptSuggestions

```
public class ReceiptSuggestions
extends Object
```
EMV fields we recommend developers put on their receipts.

Constructor Summary

Constructors
Constructor and Description

ReceiptSuggestions()

Constructors
Constructor and Description
`ReceiptSuggestions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAid()` Gets the EMV Application Identifier.
`String`	`getApplicationLabel()` Gets a description of the selected AID.
`String`	`getArc()` Gets the EMV Authorization Response Code.
`String`	`getArqc()` Gets the EMV Application Request Cryptogram.
`String`	`getAuthorizedAmount()` Gets the amount authorized by the payment network.
`int`	`getBatchSequence()` Gets the sequence of the transaction in the batch.
`String`	`getCashBackAmount()` Gets the amount of cash back that was approved.
`String`	`getCashDiscount()` Gets the discount applied to the transaction for payment methods ineligible for surcharges.
`CvmType`	`getCvmUsed()` Gets the customer verification method used for the transaction.
`String`	`getEntryMethod()` Gets the method by which the payment card was entered (MSR, CHIP, KEYED, etc.
`String`	`getIad()` Gets the EMV Issuer Application Data.
`String`	`getMaskedPan()` Gets the masked primary account number of the payment card, as required.
`String`	`getMerchantId()` Gets the ID of the merchant.
`String`	`getMerchantKey()` Gets the partially masked merchant key required on EMV receipts.
`String`	`getMerchantName()` Gets the name of the merchant's business.
`String`	`getSurcharge()` Gets the amount added to the transaction to cover eligible credit card fees.
`String`	`getTc()` Gets the EMV Transaction Certificate.
`String`	`getTerminalId()` Gets the ID of the payment terminal.
`String`	`getTransactionType()` Gets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
`String`	`getTsi()` Gets the EMV Transaction Status Indicator.
`String`	`getTvr()` Gets the EMV Terminal Verification Response.
`boolean`	`isFallback()` Gets that a chip read failure caused the transaction to fall back to the magstripe.
`boolean`	`isPinVerified()` Gets that PIN verification was performed.
`boolean`	`isRequestSignature()` Gets that the receipt should contain a signature line.
`void`	`setAid(String value)` Sets the EMV Application Identifier.
`void`	`setApplicationLabel(String value)` Sets a description of the selected AID.
`void`	`setArc(String value)` Sets the EMV Authorization Response Code.
`void`	`setArqc(String value)` Sets the EMV Application Request Cryptogram.
`void`	`setAuthorizedAmount(String value)` Sets the amount authorized by the payment network.
`void`	`setBatchSequence(int value)` Sets the sequence of the transaction in the batch.
`void`	`setCashBackAmount(String value)` Sets the amount of cash back that was approved.
`void`	`setCashDiscount(String value)` Sets the discount applied to the transaction for payment methods ineligible for surcharges.
`void`	`setCvmUsed(CvmType value)` Sets the customer verification method used for the transaction.
`void`	`setEntryMethod(String value)` Sets the method by which the payment card was entered (MSR, CHIP, KEYED, etc.
`void`	`setFallback(boolean value)` Sets that a chip read failure caused the transaction to fall back to the magstripe.
`void`	`setIad(String value)` Sets the EMV Issuer Application Data.
`void`	`setMaskedPan(String value)` Sets the masked primary account number of the payment card, as required.
`void`	`setMerchantId(String value)` Sets the ID of the merchant.
`void`	`setMerchantKey(String value)` Sets the partially masked merchant key required on EMV receipts.
`void`	`setMerchantName(String value)` Sets the name of the merchant's business.
`void`	`setPinVerified(boolean value)` Sets that PIN verification was performed.
`void`	`setRequestSignature(boolean value)` Sets that the receipt should contain a signature line.
`void`	`setSurcharge(String value)` Sets the amount added to the transaction to cover eligible credit card fees.
`void`	`setTc(String value)` Sets the EMV Transaction Certificate.
`void`	`setTerminalId(String value)` Sets the ID of the payment terminal.
`void`	`setTransactionType(String value)` Sets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
`void`	`setTsi(String value)` Sets the EMV Transaction Status Indicator.
`void`	`setTvr(String value)` Sets the EMV Terminal Verification Response.

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

- Constructor Detail
  - ReceiptSuggestions
```
public ReceiptSuggestions()
```
- Method Detail
  - setAid
```
public void setAid(String value)
```
    Sets the EMV Application Identifier.
    
    Parameters:
    
    value - the EMV Application Identifier.
  - getAid
```
public String getAid()
```
    Gets the EMV Application Identifier.
    
    Returns:
    
    the EMV Application Identifier.
  - setArqc
```
public void setArqc(String value)
```
    Sets the EMV Application Request Cryptogram.
    
    Parameters:
    
    value - the EMV Application Request Cryptogram.
  - getArqc
```
public String getArqc()
```
    Gets the EMV Application Request Cryptogram.
    
    Returns:
    
    the EMV Application Request Cryptogram.
  - setIad
```
public void setIad(String value)
```
    Sets the EMV Issuer Application Data.
    
    Parameters:
    
    value - the EMV Issuer Application Data.
  - getIad
```
public String getIad()
```
    Gets the EMV Issuer Application Data.
    
    Returns:
    
    the EMV Issuer Application Data.
  - setArc
```
public void setArc(String value)
```
    Sets the EMV Authorization Response Code.
    
    Parameters:
    
    value - the EMV Authorization Response Code.
  - getArc
```
public String getArc()
```
    Gets the EMV Authorization Response Code.
    
    Returns:
    
    the EMV Authorization Response Code.
  - setTc
```
public void setTc(String value)
```
    Sets the EMV Transaction Certificate.
    
    Parameters:
    
    value - the EMV Transaction Certificate.
  - getTc
```
public String getTc()
```
    Gets the EMV Transaction Certificate.
    
    Returns:
    
    the EMV Transaction Certificate.
  - setTvr
```
public void setTvr(String value)
```
    Sets the EMV Terminal Verification Response.
    
    Parameters:
    
    value - the EMV Terminal Verification Response.
  - getTvr
```
public String getTvr()
```
    Gets the EMV Terminal Verification Response.
    
    Returns:
    
    the EMV Terminal Verification Response.
  - setTsi
```
public void setTsi(String value)
```
    Sets the EMV Transaction Status Indicator.
    
    Parameters:
    
    value - the EMV Transaction Status Indicator.
  - getTsi
```
public String getTsi()
```
    Gets the EMV Transaction Status Indicator.
    
    Returns:
    
    the EMV Transaction Status Indicator.
  - setTerminalId
```
public void setTerminalId(String value)
```
    Sets the ID of the payment terminal.
    
    Parameters:
    
    value - the ID of the payment terminal.
  - getTerminalId
```
public String getTerminalId()
```
    Gets the ID of the payment terminal.
    
    Returns:
    
    the ID of the payment terminal.
  - setMerchantName
```
public void setMerchantName(String value)
```
    Sets the name of the merchant's business.
    
    Parameters:
    
    value - the name of the merchant's business.
  - getMerchantName
```
public String getMerchantName()
```
    Gets the name of the merchant's business.
    
    Returns:
    
    the name of the merchant's business.
  - setMerchantId
```
public void setMerchantId(String value)
```
    Sets the ID of the merchant.
    
    Parameters:
    
    value - the ID of the merchant.
  - getMerchantId
```
public String getMerchantId()
```
    Gets the ID of the merchant.
    
    Returns:
    
    the ID of the merchant.
  - setMerchantKey
```
public void setMerchantKey(String value)
```
    Sets the partially masked merchant key required on EMV receipts.
    
    Parameters:
    
    value - the partially masked merchant key required on EMV receipts.
  - getMerchantKey
```
public String getMerchantKey()
```
    Gets the partially masked merchant key required on EMV receipts.
    
    Returns:
    
    the partially masked merchant key required on EMV receipts.
  - setApplicationLabel
```
public void setApplicationLabel(String value)
```
    Sets a description of the selected AID.
    
    Parameters:
    
    value - a description of the selected AID.
  - getApplicationLabel
```
public String 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
```
public void setMaskedPan(String value)
```
    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
```
public String 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
```
public void setAuthorizedAmount(String value)
```
    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
```
public String 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
```
public void setTransactionType(String value)
```
    Sets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
    
    Parameters:
    
    value - the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
  - getTransactionType
```
public String getTransactionType()
```
    Gets the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
    
    Returns:
    
    the type of transaction performed (CHARGE, PREAUTH, REFUND, etc).
  - setEntryMethod
```
public void setEntryMethod(String value)
```
    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
```
public String 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
```
public void setCvmUsed(CvmType value)
```
    Sets the customer verification method used for the transaction.
    
    Parameters:
    
    value - the customer verification method used for the transaction.
  - getCvmUsed
```
public CvmType 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
```
public void setCashBackAmount(String value)
```
    Sets the amount of cash back that was approved.
    
    Parameters:
    
    value - the amount of cash back that was approved.
  - getCashBackAmount
```
public String getCashBackAmount()
```
    Gets the amount of cash back that was approved.
    
    Returns:
    
    the amount of cash back that was approved.
  - setSurcharge
```
public void setSurcharge(String value)
```
    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
```
public String 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
```
public void setCashDiscount(String value)
```
    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
```
public String 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.

Class ReceiptSuggestions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReceiptSuggestions

Method Detail

setAid

getAid

setArqc

getArqc

setIad

getIad

setArc

getArc

setTc

getTc

setTvr

getTvr

setTsi

getTsi

setTerminalId

getTerminalId

setMerchantName

getMerchantName

setMerchantId

getMerchantId

setMerchantKey

getMerchantKey

setApplicationLabel

getApplicationLabel

setRequestSignature

isRequestSignature

setMaskedPan

getMaskedPan

setAuthorizedAmount

getAuthorizedAmount

setTransactionType

getTransactionType

setEntryMethod

getEntryMethod

setPinVerified

isPinVerified

setCvmUsed

getCvmUsed

setFallback

isFallback

setBatchSequence

getBatchSequence

setCashBackAmount

getCashBackAmount

setSurcharge

getSurcharge

setCashDiscount

getCashDiscount