AuthorizationRequest (com.blockchyp:blockchyp-java 2.2.2 API)

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

All Implemented Interfaces:

ICoreRequest, IPaymentMethod, IPreviousTransaction, IRequestAmount, ISignatureRequest, ISubtotals, ITerminalReference
```
public class AuthorizationRequest
extends Object
implements ICoreRequest, IPaymentMethod, IPreviousTransaction, IRequestAmount, ISignatureRequest, ISubtotals, ITerminalReference
```
An authorization request for a charge, preauth, or reverse transaction.

Constructor Summary

Constructors
Constructor and Description

AuthorizationRequest()

Constructors
Constructor and Description
`AuthorizationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAddress()` Gets the cardholder address for use with address verification.
`Map`	`getAltPrices()` Gets a map of alternate currencies and the price in each currency.
`String`	`getAmount()` Gets the requested amount.
`String`	`getCardholderName()` Gets the cardholder name.
`CardType`	`getCardType()` Gets designates categories of cards: credit, debit, EBT.
`String`	`getCashBackAmount()` Gets the amount of cash back requested.
`String`	`getCurrencyCode()` Gets the transaction currency code.
`Customer`	`getCustomer()` Gets suggested receipt fields.
`String`	`getCvv()` Gets the card CVV for use with PAN based transactions.
`String`	`getDescription()` Gets a narrative description of the transaction.
`String`	`getDestinationAccount()` Gets the settlement account for merchants with split settlements.
`String`	`getEbtEligibleAmount()` Gets the amount of the transaction that should be charged to an EBT card.
`String`	`getExpMonth()` Gets the card expiration month for use with PAN based transactions.
`String`	`getExpYear()` Gets the card expiration year for use with PAN based transactions.
`String`	`getFsaEligibleAmount()` Gets the amount of the transaction that should be charged to an FSA card.
`String`	`getHsaEligibleAmount()` Gets the amount of the transaction that should be charged to an HSA card.
`String`	`getKsn()` Gets the key serial number used for DUKPT encryption.
`String`	`getOnlineAuthCode()` Gets used to validate online gift card authorizations.
`String`	`getOrderRef()` Gets an identifier from an external point of sale system.
`String`	`getPan()` Gets the primary account number.
`String`	`getPaymentType()` Gets designates brands of payment methods: Visa, Discover, etc.
`String`	`getPinBlock()` Gets the encrypted pin block.
`String`	`getPostalCode()` Gets the cardholder postal code for use with address verification.
`String`	`getRoutingNumber()` Gets the ACH routing number for ACH transactions.
`String`	`getSigFile()` Gets a location on the filesystem which a customer signature should be written to.
`SignatureFormat`	`getSigFormat()` Gets the image format to be used for returning signatures.
`int`	`getSigWidth()` Gets the width that the signature image should be scaled to, preserving the aspect ratio.
`String`	`getTaxAmount()` Gets the tax amount.
`String`	`getTerminalName()` Gets the name of the target payment terminal.
`int`	`getTimeout()` Gets the request timeout in seconds.
`String`	`getTipAmount()` Gets the tip amount.
`String`	`getToken()` Gets the payment token to be used for this transaction.
`String`	`getTrack1()` Gets track 1 magnetic stripe data.
`String`	`getTrack2()` Gets track 2 magnetic stripe data.
`String`	`getTransactionId()` Gets the ID of the previous transaction being referenced.
`String`	`getTransactionRef()` Gets the transaction reference string assigned to the transaction request.
`boolean`	`isCashBackEnabled()` Gets that cash back should be enabled for supported cards.
`boolean`	`isDisableSignature()` Gets whether or not signature prompt should be skipped on the terminal.
`boolean`	`isEnroll()` Gets that the payment method should be added to the token vault alongside the authorization.
`boolean`	`isManualEntry()` Gets that the payment entry method is a manual keyed transaction.
`boolean`	`isPromptForTip()` Gets that the terminal should request a tip from the user before starting the transaction.
`boolean`	`isTaxExempt()` Gets that the request is tax exempt.
`boolean`	`isTest()` Gets whether or not to route transaction to the test gateway.
`void`	`setAddress(String value)` Sets the cardholder address for use with address verification.
`void`	`setAltPrices(Map value)` Sets a map of alternate currencies and the price in each currency.
`void`	`setAmount(String value)` Sets the requested amount.
`void`	`setCardholderName(String value)` Sets the cardholder name.
`void`	`setCardType(CardType value)` Sets designates categories of cards: credit, debit, EBT.
`void`	`setCashBackAmount(String value)` Sets the amount of cash back requested.
`void`	`setCashBackEnabled(boolean value)` Sets that cash back should be enabled for supported cards.
`void`	`setCurrencyCode(String value)` Sets the transaction currency code.
`void`	`setCustomer(Customer value)` Sets suggested receipt fields.
`void`	`setCvv(String value)` Sets the card CVV for use with PAN based transactions.
`void`	`setDescription(String value)` Sets a narrative description of the transaction.
`void`	`setDestinationAccount(String value)` Sets the settlement account for merchants with split settlements.
`void`	`setDisableSignature(boolean value)` Sets whether or not signature prompt should be skipped on the terminal.
`void`	`setEbtEligibleAmount(String value)` Sets the amount of the transaction that should be charged to an EBT card.
`void`	`setEnroll(boolean value)` Sets that the payment method should be added to the token vault alongside the authorization.
`void`	`setExpMonth(String value)` Sets the card expiration month for use with PAN based transactions.
`void`	`setExpYear(String value)` Sets the card expiration year for use with PAN based transactions.
`void`	`setFsaEligibleAmount(String value)` Sets the amount of the transaction that should be charged to an FSA card.
`void`	`setHsaEligibleAmount(String value)` Sets the amount of the transaction that should be charged to an HSA card.
`void`	`setKsn(String value)` Sets the key serial number used for DUKPT encryption.
`void`	`setManualEntry(boolean value)` Sets that the payment entry method is a manual keyed transaction.
`void`	`setOnlineAuthCode(String value)` Sets used to validate online gift card authorizations.
`void`	`setOrderRef(String value)` Sets an identifier from an external point of sale system.
`void`	`setPan(String value)` Sets the primary account number.
`void`	`setPaymentType(String value)` Sets designates brands of payment methods: Visa, Discover, etc.
`void`	`setPinBlock(String value)` Sets the encrypted pin block.
`void`	`setPostalCode(String value)` Sets the cardholder postal code for use with address verification.
`void`	`setPromptForTip(boolean value)` Sets that the terminal should request a tip from the user before starting the transaction.
`void`	`setRoutingNumber(String value)` Sets the ACH routing number for ACH transactions.
`void`	`setSigFile(String value)` Sets a location on the filesystem which a customer signature should be written to.
`void`	`setSigFormat(SignatureFormat value)` Sets the image format to be used for returning signatures.
`void`	`setSigWidth(int value)` Sets the width that the signature image should be scaled to, preserving the aspect ratio.
`void`	`setTaxAmount(String value)` Sets the tax amount.
`void`	`setTaxExempt(boolean value)` Sets that the request is tax exempt.
`void`	`setTerminalName(String value)` Sets the name of the target payment terminal.
`void`	`setTest(boolean value)` Sets whether or not to route transaction to the test gateway.
`void`	`setTimeout(int value)` Sets the request timeout in seconds.
`void`	`setTipAmount(String value)` Sets the tip amount.
`void`	`setToken(String value)` Sets the payment token to be used for this transaction.
`void`	`setTrack1(String value)` Sets track 1 magnetic stripe data.
`void`	`setTrack2(String value)` Sets track 2 magnetic stripe data.
`void`	`setTransactionId(String value)` Sets the ID of the previous transaction being referenced.
`void`	`setTransactionRef(String value)` Sets the transaction reference string assigned to the transaction request.

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

- Constructor Detail
  - AuthorizationRequest
```
public AuthorizationRequest()
```
- Method Detail
  - setTransactionRef
```
public void setTransactionRef(String value)
```
    Sets the transaction reference string assigned to the transaction request.
    
    Parameters:
    
    value - the transaction reference string assigned to the transaction request. If no transaction ref was assiged on the request, then the gateway will randomly generate one.
  - getTransactionRef
```
public String getTransactionRef()
```
    Gets the transaction reference string assigned to the transaction request.
    
    Specified by:
    
    getTransactionRef in interface ICoreRequest
    
    Returns:
    
    the transaction reference string assigned to the transaction request. If no transaction ref was assiged on the request, then the gateway will randomly generate one.
  - setOrderRef
```
public void setOrderRef(String value)
```
    Sets an identifier from an external point of sale system.
    
    Parameters:
    
    value - an identifier from an external point of sale system.
  - getOrderRef
```
public String getOrderRef()
```
    Gets an identifier from an external point of sale system.
    
    Specified by:
    
    getOrderRef in interface ICoreRequest
    
    Returns:
    
    an identifier from an external point of sale system.
  - setDestinationAccount
```
public void setDestinationAccount(String value)
```
    Sets the settlement account for merchants with split settlements.
    
    Parameters:
    
    value - the settlement account for merchants with split settlements.
  - getDestinationAccount
```
public String getDestinationAccount()
```
    Gets the settlement account for merchants with split settlements.
    
    Specified by:
    
    getDestinationAccount in interface ICoreRequest
    
    Returns:
    
    the settlement account for merchants with split settlements.
  - setTest
```
public void setTest(boolean value)
```
    Sets whether or not to route transaction to the test gateway.
    
    Parameters:
    
    value - whether or not to route transaction to the test gateway.
  - isTest
```
public boolean isTest()
```
    Gets whether or not to route transaction to the test gateway.
    
    Specified by:
    
    isTest in interface ICoreRequest
    
    Returns:
    
    whether or not to route transaction to the test gateway.
  - setTimeout
```
public void setTimeout(int value)
```
    Sets the request timeout in seconds.
    
    Parameters:
    
    value - the request timeout in seconds.
  - getTimeout
```
public int getTimeout()
```
    Gets the request timeout in seconds.
    
    Specified by:
    
    getTimeout in interface ICoreRequest
    
    Returns:
    
    the request timeout in seconds.
  - setToken
```
public void setToken(String value)
```
    Sets the payment token to be used for this transaction.
    
    Parameters:
    
    value - the payment token to be used for this transaction. This should be used for recurring transactions.
  - getToken
```
public String getToken()
```
    Gets the payment token to be used for this transaction.
    
    Specified by:
    
    getToken in interface IPaymentMethod
    
    Returns:
    
    the payment token to be used for this transaction. This should be used for recurring transactions.
  - setTrack1
```
public void setTrack1(String value)
```
    Sets track 1 magnetic stripe data.
    
    Parameters:
    
    value - track 1 magnetic stripe data.
  - getTrack1
```
public String getTrack1()
```
    Gets track 1 magnetic stripe data.
    
    Specified by:
    
    getTrack1 in interface IPaymentMethod
    
    Returns:
    
    track 1 magnetic stripe data.
  - setTrack2
```
public void setTrack2(String value)
```
    Sets track 2 magnetic stripe data.
    
    Parameters:
    
    value - track 2 magnetic stripe data.
  - getTrack2
```
public String getTrack2()
```
    Gets track 2 magnetic stripe data.
    
    Specified by:
    
    getTrack2 in interface IPaymentMethod
    
    Returns:
    
    track 2 magnetic stripe data.
  - setPan
```
public void setPan(String value)
```
    Sets the primary account number.
    
    Parameters:
    
    value - the primary account number. We recommend using the terminal or e-commerce tokenization libraries instead of passing account numbers in directly, as this would put your application in PCI scope.
  - getPan
```
public String getPan()
```
    Gets the primary account number.
    
    Specified by:
    
    getPan in interface IPaymentMethod
    
    Returns:
    
    the primary account number. We recommend using the terminal or e-commerce tokenization libraries instead of passing account numbers in directly, as this would put your application in PCI scope.
  - setRoutingNumber
```
public void setRoutingNumber(String value)
```
    Sets the ACH routing number for ACH transactions.
    
    Parameters:
    
    value - the ACH routing number for ACH transactions.
  - getRoutingNumber
```
public String getRoutingNumber()
```
    Gets the ACH routing number for ACH transactions.
    
    Specified by:
    
    getRoutingNumber in interface IPaymentMethod
    
    Returns:
    
    the ACH routing number for ACH transactions.
  - setCardholderName
```
public void setCardholderName(String value)
```
    Sets the cardholder name.
    
    Parameters:
    
    value - the cardholder name. Only required if the request includes a primary account number or track data.
  - getCardholderName
```
public String getCardholderName()
```
    Gets the cardholder name.
    
    Specified by:
    
    getCardholderName in interface IPaymentMethod
    
    Returns:
    
    the cardholder name. Only required if the request includes a primary account number or track data.
  - setExpMonth
```
public void setExpMonth(String value)
```
    Sets the card expiration month for use with PAN based transactions.
    
    Parameters:
    
    value - the card expiration month for use with PAN based transactions.
  - getExpMonth
```
public String getExpMonth()
```
    Gets the card expiration month for use with PAN based transactions.
    
    Specified by:
    
    getExpMonth in interface IPaymentMethod
    
    Returns:
    
    the card expiration month for use with PAN based transactions.
  - setExpYear
```
public void setExpYear(String value)
```
    Sets the card expiration year for use with PAN based transactions.
    
    Parameters:
    
    value - the card expiration year for use with PAN based transactions.
  - getExpYear
```
public String getExpYear()
```
    Gets the card expiration year for use with PAN based transactions.
    
    Specified by:
    
    getExpYear in interface IPaymentMethod
    
    Returns:
    
    the card expiration year for use with PAN based transactions.
  - setCvv
```
public void setCvv(String value)
```
    Sets the card CVV for use with PAN based transactions.
    
    Parameters:
    
    value - the card CVV for use with PAN based transactions.
  - getCvv
```
public String getCvv()
```
    Gets the card CVV for use with PAN based transactions.
    
    Specified by:
    
    getCvv in interface IPaymentMethod
    
    Returns:
    
    the card CVV for use with PAN based transactions.
  - setAddress
```
public void setAddress(String value)
```
    Sets the cardholder address for use with address verification.
    
    Parameters:
    
    value - the cardholder address for use with address verification.
  - getAddress
```
public String getAddress()
```
    Gets the cardholder address for use with address verification.
    
    Specified by:
    
    getAddress in interface IPaymentMethod
    
    Returns:
    
    the cardholder address for use with address verification.
  - setPostalCode
```
public void setPostalCode(String value)
```
    Sets the cardholder postal code for use with address verification.
    
    Parameters:
    
    value - the cardholder postal code for use with address verification.
  - getPostalCode
```
public String getPostalCode()
```
    Gets the cardholder postal code for use with address verification.
    
    Specified by:
    
    getPostalCode in interface IPaymentMethod
    
    Returns:
    
    the cardholder postal code for use with address verification.
  - setManualEntry
```
public void setManualEntry(boolean value)
```
    Sets that the payment entry method is a manual keyed transaction.
    
    Parameters:
    
    value - that the payment entry method is a manual keyed transaction. If this is true, no other payment method will be accepted.
  - isManualEntry
```
public boolean isManualEntry()
```
    Gets that the payment entry method is a manual keyed transaction.
    
    Specified by:
    
    isManualEntry in interface IPaymentMethod
    
    Returns:
    
    that the payment entry method is a manual keyed transaction. If this is true, no other payment method will be accepted.
  - setKsn
```
public void setKsn(String value)
```
    Sets the key serial number used for DUKPT encryption.
    
    Parameters:
    
    value - the key serial number used for DUKPT encryption.
  - getKsn
```
public String getKsn()
```
    Gets the key serial number used for DUKPT encryption.
    
    Specified by:
    
    getKsn in interface IPaymentMethod
    
    Returns:
    
    the key serial number used for DUKPT encryption.
  - setPinBlock
```
public void setPinBlock(String value)
```
    Sets the encrypted pin block.
    
    Parameters:
    
    value - the encrypted pin block.
  - getPinBlock
```
public String getPinBlock()
```
    Gets the encrypted pin block.
    
    Specified by:
    
    getPinBlock in interface IPaymentMethod
    
    Returns:
    
    the encrypted pin block.
  - setCardType
```
public void setCardType(CardType value)
```
    Sets designates categories of cards: credit, debit, EBT.
    
    Parameters:
    
    value - designates categories of cards: credit, debit, EBT.
  - getCardType
```
public CardType getCardType()
```
    Gets designates categories of cards: credit, debit, EBT.
    
    Specified by:
    
    getCardType in interface IPaymentMethod
    
    Returns:
    
    designates categories of cards: credit, debit, EBT.
  - setPaymentType
```
public void setPaymentType(String value)
```
    Sets designates brands of payment methods: Visa, Discover, etc.
    
    Parameters:
    
    value - designates brands of payment methods: Visa, Discover, etc.
  - getPaymentType
```
public String getPaymentType()
```
    Gets designates brands of payment methods: Visa, Discover, etc.
    
    Specified by:
    
    getPaymentType in interface IPaymentMethod
    
    Returns:
    
    designates brands of payment methods: Visa, Discover, etc.
  - setTransactionId
```
public void setTransactionId(String value)
```
    Sets the ID of the previous transaction being referenced.
    
    Parameters:
    
    value - the ID of the previous transaction being referenced.
  - getTransactionId
```
public String getTransactionId()
```
    Gets the ID of the previous transaction being referenced.
    
    Specified by:
    
    getTransactionId in interface IPreviousTransaction
    
    Returns:
    
    the ID of the previous transaction being referenced.
  - setCurrencyCode
```
public void setCurrencyCode(String value)
```
    Sets the transaction currency code.
    
    Parameters:
    
    value - the transaction currency code.
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Gets the transaction currency code.
    
    Specified by:
    
    getCurrencyCode in interface IRequestAmount
    
    Returns:
    
    the transaction currency code.
  - setAmount
```
public void setAmount(String value)
```
    Sets the requested amount.
    
    Parameters:
    
    value - the requested amount.
  - getAmount
```
public String getAmount()
```
    Gets the requested amount.
    
    Specified by:
    
    getAmount in interface IRequestAmount
    
    Returns:
    
    the requested amount.
  - setTaxExempt
```
public void setTaxExempt(boolean value)
```
    Sets that the request is tax exempt.
    
    Parameters:
    
    value - that the request is tax exempt. Only required for tax exempt level 2 processing.
  - isTaxExempt
```
public boolean isTaxExempt()
```
    Gets that the request is tax exempt.
    
    Specified by:
    
    isTaxExempt in interface IRequestAmount
    
    Returns:
    
    that the request is tax exempt. Only required for tax exempt level 2 processing.
  - setSigFile
```
public void setSigFile(String value)
```
    Sets a location on the filesystem which a customer signature should be written to.
    
    Parameters:
    
    value - a location on the filesystem which a customer signature should be written to.
  - getSigFile
```
public String getSigFile()
```
    Gets a location on the filesystem which a customer signature should be written to.
    
    Specified by:
    
    getSigFile in interface ISignatureRequest
    
    Returns:
    
    a location on the filesystem which a customer signature should be written to.
  - setSigFormat
```
public void setSigFormat(SignatureFormat value)
```
    Sets the image format to be used for returning signatures.
    
    Parameters:
    
    value - the image format to be used for returning signatures.
  - getSigFormat
```
public SignatureFormat getSigFormat()
```
    Gets the image format to be used for returning signatures.
    
    Specified by:
    
    getSigFormat in interface ISignatureRequest
    
    Returns:
    
    the image format to be used for returning signatures.
  - setSigWidth
```
public void setSigWidth(int value)
```
    Sets the width that the signature image should be scaled to, preserving the aspect ratio.
    
    Parameters:
    
    value - the width that the signature image should be scaled to, preserving the aspect ratio. If not provided, the signature is returned in the terminal's max resolution.
  - getSigWidth
```
public int getSigWidth()
```
    Gets the width that the signature image should be scaled to, preserving the aspect ratio.
    
    Specified by:
    
    getSigWidth in interface ISignatureRequest
    
    Returns:
    
    the width that the signature image should be scaled to, preserving the aspect ratio. If not provided, the signature is returned in the terminal's max resolution.
  - setDisableSignature
```
public void setDisableSignature(boolean value)
```
    Sets whether or not signature prompt should be skipped on the terminal.
    
    Parameters:
    
    value - whether or not signature prompt should be skipped on the terminal. The terminal will indicate whether or not a signature is required by the card in the receipt suggestions response.
  - isDisableSignature
```
public boolean isDisableSignature()
```
    Gets whether or not signature prompt should be skipped on the terminal.
    
    Specified by:
    
    isDisableSignature in interface ISignatureRequest
    
    Returns:
    
    whether or not signature prompt should be skipped on the terminal. The terminal will indicate whether or not a signature is required by the card in the receipt suggestions response.
  - setTipAmount
```
public void setTipAmount(String value)
```
    Sets the tip amount.
    
    Parameters:
    
    value - the tip amount.
  - getTipAmount
```
public String getTipAmount()
```
    Gets the tip amount.
    
    Specified by:
    
    getTipAmount in interface ISubtotals
    
    Returns:
    
    the tip amount.
  - setTaxAmount
```
public void setTaxAmount(String value)
```
    Sets the tax amount.
    
    Parameters:
    
    value - the tax amount.
  - getTaxAmount
```
public String getTaxAmount()
```
    Gets the tax amount.
    
    Specified by:
    
    getTaxAmount in interface ISubtotals
    
    Returns:
    
    the tax amount.
  - setCashBackAmount
```
public void setCashBackAmount(String value)
```
    Sets the amount of cash back requested.
    
    Parameters:
    
    value - the amount of cash back requested.
  - getCashBackAmount
```
public String getCashBackAmount()
```
    Gets the amount of cash back requested.
    
    Specified by:
    
    getCashBackAmount in interface ISubtotals
    
    Returns:
    
    the amount of cash back requested.
  - setFsaEligibleAmount
```
public void setFsaEligibleAmount(String value)
```
    Sets the amount of the transaction that should be charged to an FSA card.
    
    Parameters:
    
    value - the amount of the transaction that should be charged to an FSA card. This amount may be less than the transaction total, in which case only this amount will be charged if an FSA card is presented. If the FSA amount is paid on an FSA card, then the FSA amount authorized will be indicated on the response.
  - getFsaEligibleAmount
```
public String getFsaEligibleAmount()
```
    Gets the amount of the transaction that should be charged to an FSA card.
    
    Specified by:
    
    getFsaEligibleAmount in interface ISubtotals
    
    Returns:
    
    the amount of the transaction that should be charged to an FSA card. This amount may be less than the transaction total, in which case only this amount will be charged if an FSA card is presented. If the FSA amount is paid on an FSA card, then the FSA amount authorized will be indicated on the response.
  - setHsaEligibleAmount
```
public void setHsaEligibleAmount(String value)
```
    Sets the amount of the transaction that should be charged to an HSA card.
    
    Parameters:
    
    value - the amount of the transaction that should be charged to an HSA card.
  - getHsaEligibleAmount
```
public String getHsaEligibleAmount()
```
    Gets the amount of the transaction that should be charged to an HSA card.
    
    Specified by:
    
    getHsaEligibleAmount in interface ISubtotals
    
    Returns:
    
    the amount of the transaction that should be charged to an HSA card.
  - setEbtEligibleAmount
```
public void setEbtEligibleAmount(String value)
```
    Sets the amount of the transaction that should be charged to an EBT card.
    
    Parameters:
    
    value - the amount of the transaction that should be charged to an EBT card.
  - getEbtEligibleAmount
```
public String getEbtEligibleAmount()
```
    Gets the amount of the transaction that should be charged to an EBT card.
    
    Specified by:
    
    getEbtEligibleAmount in interface ISubtotals
    
    Returns:
    
    the amount of the transaction that should be charged to an EBT card.
  - setTerminalName
```
public void setTerminalName(String value)
```
    Sets the name of the target payment terminal.
    
    Parameters:
    
    value - the name of the target payment terminal.
  - getTerminalName
```
public String getTerminalName()
```
    Gets the name of the target payment terminal.
    
    Specified by:
    
    getTerminalName in interface ITerminalReference
    
    Returns:
    
    the name of the target payment terminal.
  - setOnlineAuthCode
```
public void setOnlineAuthCode(String value)
```
    Sets used to validate online gift card authorizations.
    
    Parameters:
    
    value - used to validate online gift card authorizations.
  - getOnlineAuthCode
```
public String getOnlineAuthCode()
```
    Gets used to validate online gift card authorizations.
    
    Returns:
    
    used to validate online gift card authorizations.
  - setEnroll
```
public void setEnroll(boolean value)
```
    Sets that the payment method should be added to the token vault alongside the authorization.
    
    Parameters:
    
    value - that the payment method should be added to the token vault alongside the authorization.
  - isEnroll
```
public boolean isEnroll()
```
    Gets that the payment method should be added to the token vault alongside the authorization.
    
    Returns:
    
    that the payment method should be added to the token vault alongside the authorization.
  - setDescription
```
public void setDescription(String value)
```
    Sets a narrative description of the transaction.
    
    Parameters:
    
    value - a narrative description of the transaction.
  - getDescription
```
public String getDescription()
```
    Gets a narrative description of the transaction.
    
    Returns:
    
    a narrative description of the transaction.
  - setPromptForTip
```
public void setPromptForTip(boolean value)
```
    Sets that the terminal should request a tip from the user before starting the transaction.
    
    Parameters:
    
    value - that the terminal should request a tip from the user before starting the transaction.
  - isPromptForTip
```
public boolean isPromptForTip()
```
    Gets that the terminal should request a tip from the user before starting the transaction.
    
    Returns:
    
    that the terminal should request a tip from the user before starting the transaction.
  - setCashBackEnabled
```
public void setCashBackEnabled(boolean value)
```
    Sets that cash back should be enabled for supported cards.
    
    Parameters:
    
    value - that cash back should be enabled for supported cards.
  - isCashBackEnabled
```
public boolean isCashBackEnabled()
```
    Gets that cash back should be enabled for supported cards.
    
    Returns:
    
    that cash back should be enabled for supported cards.
  - setAltPrices
```
public void setAltPrices(Map value)
```
    Sets a map of alternate currencies and the price in each currency.
    
    Parameters:
    
    value - a map of alternate currencies and the price in each currency.
  - getAltPrices
```
public Map getAltPrices()
```
    Gets a map of alternate currencies and the price in each currency.
    
    Returns:
    
    a map of alternate currencies and the price in each currency.
  - setCustomer
```
public void setCustomer(Customer value)
```
    Sets suggested receipt fields.
    
    Parameters:
    
    value - suggested receipt fields.
  - getCustomer
```
public Customer getCustomer()
```
    Gets suggested receipt fields.
    
    Returns:
    
    suggested receipt fields.

Class AuthorizationRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthorizationRequest

Method Detail

setTransactionRef

getTransactionRef

setOrderRef

getOrderRef

setDestinationAccount

getDestinationAccount

setTest

isTest

setTimeout

getTimeout

setToken

getToken

setTrack1

getTrack1

setTrack2

getTrack2

setPan

getPan

setRoutingNumber

getRoutingNumber

setCardholderName

getCardholderName

setExpMonth

getExpMonth

setExpYear

getExpYear

setCvv

getCvv

setAddress

getAddress

setPostalCode

getPostalCode

setManualEntry

isManualEntry

setKsn

getKsn

setPinBlock

getPinBlock

setCardType

getCardType

setPaymentType

getPaymentType

setTransactionId

getTransactionId

setCurrencyCode

getCurrencyCode

setAmount

getAmount

setTaxExempt

isTaxExempt

setSigFile

getSigFile

setSigFormat

getSigFormat

setSigWidth

getSigWidth

setDisableSignature

isDisableSignature

setTipAmount

getTipAmount

setTaxAmount

getTaxAmount

setCashBackAmount

getCashBackAmount

setFsaEligibleAmount

getFsaEligibleAmount

setHsaEligibleAmount

getHsaEligibleAmount

setEbtEligibleAmount

getEbtEligibleAmount

setTerminalName

getTerminalName

setOnlineAuthCode