Package com.blockchyp.client.dto

Class AuthorizationRequest

java.lang.Object
com.blockchyp.client.dto.AuthorizationRequest
All Implemented Interfaces:
ICoreRequest, IPaymentMethod, IPreviousTransaction, IRequestAmount, ISignatureRequest, ISubtotals, ITerminalReference, ITimeoutRequest
public class AuthorizationRequest extends Object implements ITimeoutRequest, ICoreRequest, IPaymentMethod, IPreviousTransaction, IRequestAmount, ISignatureRequest, ISubtotals, ITerminalReference
An authorization request for a charge, preauth, or reverse transaction.

  • Constructor Details

    • AuthorizationRequest

      public AuthorizationRequest()

  • Method Details

    • 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 ITimeoutRequest
      Returns:
      the request timeout in seconds.

    • 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 ITimeoutRequest
      Returns:
      whether or not to route transaction to the test gateway.

    • setTransactionRef

      public void setTransactionRef(String value)
      Sets a user-assigned reference that can be used to recall or reverse transactions.
      Parameters:
      value - a user-assigned reference that can be used to recall or reverse transactions.

    • getTransactionRef

      public String getTransactionRef()
      Gets a user-assigned reference that can be used to recall or reverse transactions.
      Specified by:
      getTransactionRef in interface ICoreRequest
      Returns:
      a user-assigned reference that can be used to recall or reverse transactions.

    • setAutogeneratedRef

      public void setAutogeneratedRef(boolean value)
      Sets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
      Parameters:
      value - that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.

    • isAutogeneratedRef

      public boolean isAutogeneratedRef()
      Gets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
      Specified by:
      isAutogeneratedRef in interface ICoreRequest
      Returns:
      that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.

    • setAsync

      public void setAsync(boolean value)
      Sets defers the response to the transaction and returns immediately.
      Parameters:
      value - defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • isAsync

      public boolean isAsync()
      Gets defers the response to the transaction and returns immediately.
      Specified by:
      isAsync in interface ICoreRequest
      Returns:
      defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • setQueue

      public void setQueue(boolean value)
      Sets adds the transaction to the queue and returns immediately.
      Parameters:
      value - adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • isQueue

      public boolean isQueue()
      Gets adds the transaction to the queue and returns immediately.
      Specified by:
      isQueue in interface ICoreRequest
      Returns:
      adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • setWaitForRemovedCard

      public void setWaitForRemovedCard(boolean value)
      Sets whether or not the request should block until all cards have been removed from the card reader.
      Parameters:
      value - whether or not the request should block until all cards have been removed from the card reader.

    • isWaitForRemovedCard

      public boolean isWaitForRemovedCard()
      Gets whether or not the request should block until all cards have been removed from the card reader.
      Specified by:
      isWaitForRemovedCard in interface ICoreRequest
      Returns:
      whether or not the request should block until all cards have been removed from the card reader.

    • setForce

      public void setForce(boolean value)
      Sets override any in-progress transactions.
      Parameters:
      value - override any in-progress transactions.

    • isForce

      public boolean isForce()
      Gets override any in-progress transactions.
      Specified by:
      isForce in interface ICoreRequest
      Returns:
      override any in-progress transactions.

    • 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.

    • setTestCase

      public void setTestCase(String value)
      Sets can include a code used to trigger simulated conditions for the purposes of testing and certification.
      Parameters:
      value - can include a code used to trigger simulated conditions for the purposes of testing and certification. Valid for test merchant accounts only.

    • getTestCase

      public String getTestCase()
      Gets can include a code used to trigger simulated conditions for the purposes of testing and certification.
      Specified by:
      getTestCase in interface ICoreRequest
      Returns:
      can include a code used to trigger simulated conditions for the purposes of testing and certification. Valid for test merchant accounts only.

    • 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.

    • setCountry

      public void setCountry(String value)
      Sets the cardholder country.
      Parameters:
      value - the cardholder country.

    • getCountry

      public String getCountry()
      Gets the cardholder country.
      Specified by:
      getCountry in interface IPaymentMethod
      Returns:
      the cardholder country.

    • 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.

    • 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.

    • setSurcharge

      public void setSurcharge(boolean value)
      Sets a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
      Parameters:
      value - a flag to add a surcharge to the transaction to cover credit card fees, if permitted.

    • isSurcharge

      public boolean isSurcharge()
      Gets a flag to add a surcharge to the transaction to cover credit card fees, if permitted.
      Specified by:
      isSurcharge in interface IRequestAmount
      Returns:
      a flag to add a surcharge to the transaction to cover credit card fees, if permitted.

    • setCashDiscount

      public void setCashDiscount(boolean value)
      Sets a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
      Parameters:
      value - a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.

    • isCashDiscount

      public boolean isCashDiscount()
      Gets a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.
      Specified by:
      isCashDiscount in interface IRequestAmount
      Returns:
      a flag that applies a discount to negate the surcharge for debit transactions or other surcharge ineligible payment methods.

    • 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.

    • 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.

    • setResetConnection

      public void setResetConnection(boolean value)
      Sets forces the terminal cloud connection to be reset while a transactions is in flight.
      Parameters:
      value - forces the terminal cloud connection to be reset while a transactions is in flight. This is a diagnostic settings that can be used only for test transactions.

    • isResetConnection

      public boolean isResetConnection()
      Gets forces the terminal cloud connection to be reset while a transactions is in flight.
      Specified by:
      isResetConnection in interface ITerminalReference
      Returns:
      forces the terminal cloud connection to be reset while a transactions is in flight. This is a diagnostic settings that can be used only for test transactions.

    • setTransactionId

      public void setTransactionId(String value)
      Sets can be used to update a pre-auth to a new amount, sometimes called incremental auth.
      Parameters:
      value - can be used to update a pre-auth to a new amount, sometimes called incremental auth.

    • getTransactionId

      public String getTransactionId()
      Gets can be used to update a pre-auth to a new amount, sometimes called incremental auth.
      Specified by:
      getTransactionId in interface IPreviousTransaction
      Returns:
      can be used to update a pre-auth to a new amount, sometimes called incremental auth.

    • 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.

    • setBypassDupeFilter

      public void setBypassDupeFilter(boolean value)
      Sets duplicate detection should be bypassed.
      Parameters:
      value - duplicate detection should be bypassed.

    • isBypassDupeFilter

      public boolean isBypassDupeFilter()
      Gets duplicate detection should be bypassed.
      Returns:
      duplicate detection should be bypassed.

    • 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.

    • setCardOnFile

      public void setCardOnFile(boolean value)
      Sets that this transaction should be treated as MOTO with a card on file.
      Parameters:
      value - that this transaction should be treated as MOTO with a card on file.

    • isCardOnFile

      public boolean isCardOnFile()
      Gets that this transaction should be treated as MOTO with a card on file.
      Returns:
      that this transaction should be treated as MOTO with a card on file.

    • setRecurring

      public void setRecurring(boolean value)
      Sets that this transaction should be treated as a recurring transaction.
      Parameters:
      value - that this transaction should be treated as a recurring transaction.

    • isRecurring

      public boolean isRecurring()
      Gets that this transaction should be treated as a recurring transaction.
      Returns:
      that this transaction should be treated as a recurring transaction.

    • setCit

      public void setCit(boolean value)
      Sets manually sets the CIT (Customer Initiated Transaction) flag.
      Parameters:
      value - manually sets the CIT (Customer Initiated Transaction) flag.

    • isCit

      public boolean isCit()
      Gets manually sets the CIT (Customer Initiated Transaction) flag.
      Returns:
      manually sets the CIT (Customer Initiated Transaction) flag.

    • setMit

      public void setMit(boolean value)
      Sets manually sets the MIT (Merchant Initiated Transaction) flag.
      Parameters:
      value - manually sets the MIT (Merchant Initiated Transaction) flag.

    • isMit

      public boolean isMit()
      Gets manually sets the MIT (Merchant Initiated Transaction) flag.
      Returns:
      manually sets the MIT (Merchant Initiated Transaction) flag.

    • setSubscription

      public void setSubscription(boolean value)
      Sets that this transaction should be treated as a subscription recurring transaction.
      Parameters:
      value - that this transaction should be treated as a subscription recurring transaction.

    • isSubscription

      public boolean isSubscription()
      Gets that this transaction should be treated as a subscription recurring transaction.
      Returns:
      that this transaction should be treated as a subscription recurring transaction.

    • setPurchaseOrderNumber

      public void setPurchaseOrderNumber(String value)
      Sets the purchase order number, if known.
      Parameters:
      value - the purchase order number, if known.

    • getPurchaseOrderNumber

      public String getPurchaseOrderNumber()
      Gets the purchase order number, if known.
      Returns:
      the purchase order number, if known.

    • setSupplierReferenceNumber

      public void setSupplierReferenceNumber(String value)
      Sets the supplier reference number, if known.
      Parameters:
      value - the supplier reference number, if known.

    • getSupplierReferenceNumber

      public String getSupplierReferenceNumber()
      Gets the supplier reference number, if known.
      Returns:
      the supplier reference number, if known.

    • setLineItems

      public void setLineItems(Collection<TransactionDisplayItem> value)
      Sets an item to display.
      Parameters:
      value - an item to display. Can be overwritten or appended, based on the request type.

    • getLineItems

      public Collection<TransactionDisplayItem> getLineItems()
      Gets an item to display.
      Returns:
      an item to display. Can be overwritten or appended, based on the request type.

    • 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. Use only if you want to set your own exchange rate for a crypto transaction.

    • 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. Use only if you want to set your own exchange rate for a crypto transaction.

    • setCustomer

      public void setCustomer(Customer value)
      Sets customer information.
      Parameters:
      value - customer information.

    • getCustomer

      public Customer getCustomer()
      Gets customer information.
      Returns:
      customer information.

    • setRoundingMode

      public void setRoundingMode(RoundingMode value)
      Sets how partial pennies should be rounded for calculated values like surcharges.
      Parameters:
      value - how partial pennies should be rounded for calculated values like surcharges. Rounding up is the default behavior.

    • getRoundingMode

      public RoundingMode getRoundingMode()
      Gets how partial pennies should be rounded for calculated values like surcharges.
      Returns:
      how partial pennies should be rounded for calculated values like surcharges. Rounding up is the default behavior.

    • setHealthcareMetadata

      public void setHealthcareMetadata(HealthcareMetadata value)
      Sets details for HSA/FSA transactions.
      Parameters:
      value - details for HSA/FSA transactions.

    • getHealthcareMetadata

      public HealthcareMetadata getHealthcareMetadata()
      Gets details for HSA/FSA transactions.
      Returns:
      details for HSA/FSA transactions.

    • setCryptocurrency

      public void setCryptocurrency(String value)
      Sets that the transaction should be a cryptocurrency transaction.
      Parameters:
      value - that the transaction should be a cryptocurrency transaction. Value should be a crypto currency code (ETH, BTC) or ANY to prompt the user to choose from supported cryptocurrencies.

    • getCryptocurrency

      public String getCryptocurrency()
      Gets that the transaction should be a cryptocurrency transaction.
      Returns:
      that the transaction should be a cryptocurrency transaction. Value should be a crypto currency code (ETH, BTC) or ANY to prompt the user to choose from supported cryptocurrencies.

    • setCryptoNetwork

      public void setCryptoNetwork(String value)
      Sets an optional parameter that can be used to force a crypto transaction onto a level one or level two network.
      Parameters:
      value - an optional parameter that can be used to force a crypto transaction onto a level one or level two network. Valid values are L1 and L2. Defaults to L1.

    • getCryptoNetwork

      public String getCryptoNetwork()
      Gets an optional parameter that can be used to force a crypto transaction onto a level one or level two network.
      Returns:
      an optional parameter that can be used to force a crypto transaction onto a level one or level two network. Valid values are L1 and L2. Defaults to L1.

    • setCryptoReceiveAddress

      public void setCryptoReceiveAddress(String value)
      Sets can be used to specify a specific receive address for a crypto transaction.
      Parameters:
      value - can be used to specify a specific receive address for a crypto transaction. Disabled by default. This should only be used by sophisticated users with access to properly configured hot wallets.

    • getCryptoReceiveAddress

      public String getCryptoReceiveAddress()
      Gets can be used to specify a specific receive address for a crypto transaction.
      Returns:
      can be used to specify a specific receive address for a crypto transaction. Disabled by default. This should only be used by sophisticated users with access to properly configured hot wallets.

    • setPaymentRequestLabel

      public void setPaymentRequestLabel(String value)
      Sets can optionally add a label to the payment request if the target cryptocurrency supports labels.
      Parameters:
      value - can optionally add a label to the payment request if the target cryptocurrency supports labels. Defaults to the merchant's DBA Name.

    • getPaymentRequestLabel

      public String getPaymentRequestLabel()
      Gets can optionally add a label to the payment request if the target cryptocurrency supports labels.
      Returns:
      can optionally add a label to the payment request if the target cryptocurrency supports labels. Defaults to the merchant's DBA Name.

    • setPaymentRequestMessage

      public void setPaymentRequestMessage(String value)
      Sets can optionally add a message to the payment request if the target cryptocurrency supports labels.
      Parameters:
      value - can optionally add a message to the payment request if the target cryptocurrency supports labels. Defaults to empty.

    • getPaymentRequestMessage

      public String getPaymentRequestMessage()
      Gets can optionally add a message to the payment request if the target cryptocurrency supports labels.
      Returns:
      can optionally add a message to the payment request if the target cryptocurrency supports labels. Defaults to empty.

    • setSimulateChipRejection

      public void setSimulateChipRejection(boolean value)
      Sets instructs the terminal to simulate a post auth chip rejection that would trigger an automatic reversal.
      Parameters:
      value - instructs the terminal to simulate a post auth chip rejection that would trigger an automatic reversal.

    • isSimulateChipRejection

      public boolean isSimulateChipRejection()
      Gets instructs the terminal to simulate a post auth chip rejection that would trigger an automatic reversal.
      Returns:
      instructs the terminal to simulate a post auth chip rejection that would trigger an automatic reversal.

    • setSimulateOutOfOrderReversal

      public void setSimulateOutOfOrderReversal(boolean value)
      Sets instructs the terminal to simulate an out of order automatic reversal.
      Parameters:
      value - instructs the terminal to simulate an out of order automatic reversal.

    • isSimulateOutOfOrderReversal

      public boolean isSimulateOutOfOrderReversal()
      Gets instructs the terminal to simulate an out of order automatic reversal.
      Returns:
      instructs the terminal to simulate an out of order automatic reversal.

    • setAsyncReversals

      public void setAsyncReversals(boolean value)
      Sets causes auto-reversals on the terminal to be executed asyncronously.
      Parameters:
      value - causes auto-reversals on the terminal to be executed asyncronously. Use with caution and in conjunction with the transaction status API.

    • isAsyncReversals

      public boolean isAsyncReversals()
      Gets causes auto-reversals on the terminal to be executed asyncronously.
      Returns:
      causes auto-reversals on the terminal to be executed asyncronously. Use with caution and in conjunction with the transaction status API.

    • setPassthroughSurcharge

      public void setPassthroughSurcharge(String value)
      Sets a passthrough surcharge amount.
      Parameters:
      value - a passthrough surcharge amount. This surcharge amount will be passed directly to the gateway and is not directly calculated.

    • getPassthroughSurcharge

      public String getPassthroughSurcharge()
      Gets a passthrough surcharge amount.
      Returns:
      a passthrough surcharge amount. This surcharge amount will be passed directly to the gateway and is not directly calculated.

    • setHealthcare

      public void setHealthcare(boolean value)
      Sets marks a transaction as HSA/FSA.
      Parameters:
      value - marks a transaction as HSA/FSA.

    • isHealthcare

      public boolean isHealthcare()
      Gets marks a transaction as HSA/FSA.
      Returns:
      marks a transaction as HSA/FSA.

    • setHealthcareTotal

      public void setHealthcareTotal(String value)
      Sets the total amount to process as healthcare.
      Parameters:
      value - the total amount to process as healthcare.

    • getHealthcareTotal

      public String getHealthcareTotal()
      Gets the total amount to process as healthcare.
      Returns:
      the total amount to process as healthcare.

    • setEbtTotal

      public void setEbtTotal(String value)
      Sets the total amount to process as ebt.
      Parameters:
      value - the total amount to process as ebt.

    • getEbtTotal

      public String getEbtTotal()
      Gets the total amount to process as ebt.
      Returns:
      the total amount to process as ebt.

    • setCardMetadataLookup

      public void setCardMetadataLookup(boolean value)
      Sets that this transaction will include a card metadata lookup.
      Parameters:
      value - that this transaction will include a card metadata lookup.

    • isCardMetadataLookup

      public boolean isCardMetadataLookup()
      Gets that this transaction will include a card metadata lookup.
      Returns:
      that this transaction will include a card metadata lookup.

    • setTotalDiscountAmount

      public void setTotalDiscountAmount(String value)
      Sets the total discount amount for the transaction, and will overide additive logic for line item discounts.
      Parameters:
      value - the total discount amount for the transaction, and will overide additive logic for line item discounts.

    • getTotalDiscountAmount

      public String getTotalDiscountAmount()
      Gets the total discount amount for the transaction, and will overide additive logic for line item discounts.
      Returns:
      the total discount amount for the transaction, and will overide additive logic for line item discounts.

    • setShippingAmount

      public void setShippingAmount(String value)
      Sets the shipping cost associated with the transaction.
      Parameters:
      value - the shipping cost associated with the transaction.

    • getShippingAmount

      public String getShippingAmount()
      Gets the shipping cost associated with the transaction.
      Returns:
      the shipping cost associated with the transaction.

    • setDutyAmount

      public void setDutyAmount(String value)
      Sets the duty amount associated with the transaction.
      Parameters:
      value - the duty amount associated with the transaction.

    • getDutyAmount

      public String getDutyAmount()
      Gets the duty amount associated with the transaction.
      Returns:
      the duty amount associated with the transaction.

    • setProcessorId

      public void setProcessorId(String value)
      Sets the processor ID associated with the transaction.
      Parameters:
      value - the processor ID associated with the transaction.

    • getProcessorId

      public String getProcessorId()
      Gets the processor ID associated with the transaction.
      Returns:
      the processor ID associated with the transaction.

    • setExternalCustomerId

      public void setExternalCustomerId(String value)
      Sets the external customer ID associated with the transaction.
      Parameters:
      value - the external customer ID associated with the transaction.

    • getExternalCustomerId

      public String getExternalCustomerId()
      Gets the external customer ID associated with the transaction.
      Returns:
      the external customer ID associated with the transaction.

    • setDestinationCountryCode

      public void setDestinationCountryCode(String value)
      Sets three character, numeric, ship-to country code.
      Parameters:
      value - three character, numeric, ship-to country code. Defaults to '840' (USA) if not specified.

    • getDestinationCountryCode

      public String getDestinationCountryCode()
      Gets three character, numeric, ship-to country code.
      Returns:
      three character, numeric, ship-to country code. Defaults to '840' (USA) if not specified.

    • setShipFromPostalCode

      public void setShipFromPostalCode(String value)
      Sets nine character postal code for shipping origin addresses.
      Parameters:
      value - nine character postal code for shipping origin addresses. For US addresses, this is a 5+4 ZIP or five digit ZIP.

    • getShipFromPostalCode

      public String getShipFromPostalCode()
      Gets nine character postal code for shipping origin addresses.
      Returns:
      nine character postal code for shipping origin addresses. For US addresses, this is a 5+4 ZIP or five digit ZIP.

    • setShipToPostalCode

      public void setShipToPostalCode(String value)
      Sets nine character postal code for shipping destination addresses.
      Parameters:
      value - nine character postal code for shipping destination addresses. For US addresses, this is a 5+4 ZIP or five digit ZIP.

    • getShipToPostalCode

      public String getShipToPostalCode()
      Gets nine character postal code for shipping destination addresses.
      Returns:
      nine character postal code for shipping destination addresses. For US addresses, this is a 5+4 ZIP or five digit ZIP.

    • setOrderDate

      public void setOrderDate(Date value)
      Sets the purchase order date.
      Parameters:
      value - the purchase order date.

    • getOrderDate

      public Date getOrderDate()
      Gets the purchase order date.
      Returns:
      the purchase order date.

    • setShipmentCount

      public void setShipmentCount(int value)
      Sets the number of shipments the original authorization will be broken into.
      Parameters:
      value - the number of shipments the original authorization will be broken into.

    • getShipmentCount

      public int getShipmentCount()
      Gets the number of shipments the original authorization will be broken into.
      Returns:
      the number of shipments the original authorization will be broken into.

    • setShipmentNumber

      public void setShipmentNumber(int value)
      Sets which shipment this particular capture is for.
      Parameters:
      value - which shipment this particular capture is for.

    • getShipmentNumber

      public int getShipmentNumber()
      Gets which shipment this particular capture is for.
      Returns:
      which shipment this particular capture is for.

    • setExternalPartnerMetadata

      public void setExternalPartnerMetadata(String value)
      Sets an optional field that can be used to pass through data to external partners.
      Parameters:
      value - an optional field that can be used to pass through data to external partners.

    • getExternalPartnerMetadata

      public String getExternalPartnerMetadata()
      Gets an optional field that can be used to pass through data to external partners.
      Returns:
      an optional field that can be used to pass through data to external partners.

    • addLineItem

      public void addLineItem(TransactionDisplayItem value)
      Adds a an item to display.
      Parameters:
      value - an item to display. Can be overwritten or appended, based on the request type.