AuthorizationResponse (com.blockchyp:blockchyp-java 2.13.3 API)

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

All Implemented Interfaces:: IAbstractAcknowledgement, IApprovalResponse, ICoreResponse, ICryptocurrencyResponse, IPaymentAmounts, IPaymentMethodResponse, ISignatureResponse

public class AuthorizationResponse
extends Object
implements IAbstractAcknowledgement, IApprovalResponse, ICoreResponse, IPaymentAmounts, ICryptocurrencyResponse, IPaymentMethodResponse, ISignatureResponse

The response to an authorization request.

Constructor Summary

Constructors
Constructor and Description

AuthorizationResponse()

Constructors
Constructor and Description
`AuthorizationResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomer(Customer value)` Adds a customer data, if any.
`String`	`getAuthCode()` Gets the auth code from the payment network.
`String`	`getAuthorizedAmount()` Gets the authorized amount.
`String`	`getAuthorizedCashBackAmount()` Gets the amount of cash back authorized by the gateway.
`String`	`getAuthResponseCode()` Gets the code returned by the terminal or the card issuer to indicate the disposition of the message.
`AvsResponse`	`getAvsResponse()` Gets address verification results if address information was submitted.
`String`	`getBatchId()` Gets the ID assigned to the batch.
`String`	`getCardHolder()` Gets the cardholder name.
`String`	`getCryptoAuthorizedAmount()` Gets the amount submitted to the blockchain.
`String`	`getCryptoBlock()` Gets hash or other identifier that identifies the block on the cryptocurrency network, if available or relevant.
`String`	`getCryptocurrency()` Gets the three letter cryptocurrency code used for the transactions.
`String`	`getCryptoNetwork()` Gets whether or not the transaction was processed on the level one or level two network.
`String`	`getCryptoNetworkFee()` Gets the network level fee assessed for the transaction denominated in cryptocurrency.
`String`	`getCryptoPaymentRequest()` Gets the payment request URI used for the transaction, if available.
`String`	`getCryptoReceiveAddress()` Gets the address on the crypto network the transaction was sent to.
`String`	`getCryptoStatus()` Gets used for additional status information related to crypto transactions.
`String`	`getCryptoTransactionId()` Gets hash or other transaction identifier that identifies the transaction on the cryptocurrency network, if available or relevant.
`String`	`getCurrencyCode()` Gets the currency code used for the transaction.
`Customer`	`getCustomer()` Gets customer data, if any.
`Collection<Customer>`	`getCustomers()` Gets customer data, if any.
`String`	`getDestinationAccount()` Gets the settlement account for merchants with split settlements.
`String`	`getEntryMethod()` Gets the entry method for the transaction (CHIP, MSR, KEYED, etc).
`String`	`getError()` Gets the error, if an error occurred.
`String`	`getExpMonth()` Gets the card expiration month in MM format.
`String`	`getExpYear()` Gets the card expiration year in YY format.
`String`	`getMaskedPan()` Gets the masked primary account number.
`String`	`getPaymentType()` Gets the card brand (VISA, MC, AMEX, etc).
`String`	`getPublicKey()` Gets the BlockChyp public key if the user presented a BlockChyp payment card.
`ReceiptSuggestions`	`getReceiptSuggestions()` Gets suggested receipt fields.
`String`	`getRemainingBalance()` Gets the remaining balance on the payment method.
`String`	`getRequestedAmount()` Gets the requested amount.
`String`	`getRequestedCashBackAmount()` Gets the cash back amount the customer requested during the transaction.
`String`	`getResponseDescription()` Gets a narrative description of the transaction result.
`String`	`getSig()` Gets the ECC signature of the response.
`String`	`getSigFile()` Gets the hex encoded signature data.
`String`	`getStatus()` Gets the current status of a transaction
`String`	`getTaxAmount()` Gets the tax amount.
`String`	`getTickBlock()` Gets the hash of the last tick block.
`String`	`getTimestamp()` Gets the timestamp of the transaction.
`String`	`getTipAmount()` Gets the tip amount.
`String`	`getToken()` Gets the payment token, if the payment was enrolled in the vault.
`String`	`getTransactionId()` Gets the ID assigned to the transaction.
`String`	`getTransactionRef()` Gets the transaction reference string assigned to the transaction request.
`String`	`getTransactionType()` Gets the type of transaction.
`WhiteListedCard`	`getWhiteListedCard()` Gets card BIN ranges can be whitelisted so that they are read instead of being processed directly.
`boolean`	`isAltCurrency()` Gets whether or not an alternate currency was used.
`boolean`	`isApproved()` Gets that the transaction was approved.
`boolean`	`isConfirmed()` Gets that the transaction has met the standard criteria for confirmation on the network.
`boolean`	`isFsaAuth()` Gets whether or not a request was settled on an FSA card.
`boolean`	`isPartialAuth()` Gets whether or not the transaction was approved for a partial amount.
`boolean`	`isScopeAlert()` Gets that the transaction did something that would put the system in PCI scope.
`boolean`	`isStoreAndForward()` Gets that the transaction was flagged for store and forward due to network problems.
`boolean`	`isSuccess()` Gets whether or not the request succeeded.
`boolean`	`isTest()` Gets that the transaction was processed on the test gateway.
`void`	`setAltCurrency(boolean value)` Sets whether or not an alternate currency was used.
`void`	`setApproved(boolean value)` Sets that the transaction was approved.
`void`	`setAuthCode(String value)` Sets the auth code from the payment network.
`void`	`setAuthorizedAmount(String value)` Sets the authorized amount.
`void`	`setAuthorizedCashBackAmount(String value)` Sets the amount of cash back authorized by the gateway.
`void`	`setAuthResponseCode(String value)` Sets the code returned by the terminal or the card issuer to indicate the disposition of the message.
`void`	`setAvsResponse(AvsResponse value)` Sets address verification results if address information was submitted.
`void`	`setBatchId(String value)` Sets the ID assigned to the batch.
`void`	`setCardHolder(String value)` Sets the cardholder name.
`void`	`setConfirmed(boolean value)` Sets that the transaction has met the standard criteria for confirmation on the network.
`void`	`setCryptoAuthorizedAmount(String value)` Sets the amount submitted to the blockchain.
`void`	`setCryptoBlock(String value)` Sets hash or other identifier that identifies the block on the cryptocurrency network, if available or relevant.
`void`	`setCryptocurrency(String value)` Sets the three letter cryptocurrency code used for the transactions.
`void`	`setCryptoNetwork(String value)` Sets whether or not the transaction was processed on the level one or level two network.
`void`	`setCryptoNetworkFee(String value)` Sets the network level fee assessed for the transaction denominated in cryptocurrency.
`void`	`setCryptoPaymentRequest(String value)` Sets the payment request URI used for the transaction, if available.
`void`	`setCryptoReceiveAddress(String value)` Sets the address on the crypto network the transaction was sent to.
`void`	`setCryptoStatus(String value)` Sets used for additional status information related to crypto transactions.
`void`	`setCryptoTransactionId(String value)` Sets hash or other transaction identifier that identifies the transaction on the cryptocurrency network, if available or relevant.
`void`	`setCurrencyCode(String value)` Sets the currency code used for the transaction.
`void`	`setCustomer(Customer value)` Sets customer data, if any.
`void`	`setCustomers(Collection<Customer> value)` Sets customer data, if any.
`void`	`setDestinationAccount(String value)` Sets the settlement account for merchants with split settlements.
`void`	`setEntryMethod(String value)` Sets the entry method for the transaction (CHIP, MSR, KEYED, etc).
`void`	`setError(String value)` Sets the error, if an error occurred.
`void`	`setExpMonth(String value)` Sets the card expiration month in MM format.
`void`	`setExpYear(String value)` Sets the card expiration year in YY format.
`void`	`setFsaAuth(boolean value)` Sets whether or not a request was settled on an FSA card.
`void`	`setMaskedPan(String value)` Sets the masked primary account number.
`void`	`setPartialAuth(boolean value)` Sets whether or not the transaction was approved for a partial amount.
`void`	`setPaymentType(String value)` Sets the card brand (VISA, MC, AMEX, etc).
`void`	`setPublicKey(String value)` Sets the BlockChyp public key if the user presented a BlockChyp payment card.
`void`	`setReceiptSuggestions(ReceiptSuggestions value)` Sets suggested receipt fields.
`void`	`setRemainingBalance(String value)` Sets the remaining balance on the payment method.
`void`	`setRequestedAmount(String value)` Sets the requested amount.
`void`	`setRequestedCashBackAmount(String value)` Sets the cash back amount the customer requested during the transaction.
`void`	`setResponseDescription(String value)` Sets a narrative description of the transaction result.
`void`	`setScopeAlert(boolean value)` Sets that the transaction did something that would put the system in PCI scope.
`void`	`setSig(String value)` Sets the ECC signature of the response.
`void`	`setSigFile(String value)` Sets the hex encoded signature data.
`void`	`setStatus(String value)` Sets the current status of a transaction
`void`	`setStoreAndForward(boolean value)` Sets that the transaction was flagged for store and forward due to network problems.
`void`	`setSuccess(boolean value)` Sets whether or not the request succeeded.
`void`	`setTaxAmount(String value)` Sets the tax amount.
`void`	`setTest(boolean value)` Sets that the transaction was processed on the test gateway.
`void`	`setTickBlock(String value)` Sets the hash of the last tick block.
`void`	`setTimestamp(String value)` Sets the timestamp of the transaction.
`void`	`setTipAmount(String value)` Sets the tip amount.
`void`	`setToken(String value)` Sets the payment token, if the payment was enrolled in the vault.
`void`	`setTransactionId(String value)` Sets the ID assigned to the transaction.
`void`	`setTransactionRef(String value)` Sets the transaction reference string assigned to the transaction request.
`void`	`setTransactionType(String value)` Sets the type of transaction.
`void`	`setWhiteListedCard(WhiteListedCard value)` Sets card BIN ranges can be whitelisted so that they are read instead of being processed directly.

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

- Constructor Detail
  - AuthorizationResponse
```
public AuthorizationResponse()
```
- Method Detail
  - setSuccess
```
public void setSuccess(boolean value)
```
    Sets whether or not the request succeeded.
    
    Parameters:
    
    value - whether or not the request succeeded.
  - isSuccess
```
public boolean isSuccess()
```
    Gets whether or not the request succeeded.
    
    Specified by:
    
    isSuccess in interface IAbstractAcknowledgement
    
    Returns:
    
    whether or not the request succeeded.
  - setError
```
public void setError(String value)
```
    Sets the error, if an error occurred.
    
    Parameters:
    
    value - the error, if an error occurred.
  - getError
```
public String getError()
```
    Gets the error, if an error occurred.
    
    Specified by:
    
    getError in interface IAbstractAcknowledgement
    
    Returns:
    
    the error, if an error occurred.
  - setResponseDescription
```
public void setResponseDescription(String value)
```
    Sets a narrative description of the transaction result.
    
    Parameters:
    
    value - a narrative description of the transaction result.
  - getResponseDescription
```
public String getResponseDescription()
```
    Gets a narrative description of the transaction result.
    
    Specified by:
    
    getResponseDescription in interface IAbstractAcknowledgement
    
    Returns:
    
    a narrative description of the transaction result.
  - setApproved
```
public void setApproved(boolean value)
```
    Sets that the transaction was approved.
    
    Parameters:
    
    value - that the transaction was approved.
  - isApproved
```
public boolean isApproved()
```
    Gets that the transaction was approved.
    
    Specified by:
    
    isApproved in interface IApprovalResponse
    
    Returns:
    
    that the transaction was approved.
  - setAuthCode
```
public void setAuthCode(String value)
```
    Sets the auth code from the payment network.
    
    Parameters:
    
    value - the auth code from the payment network.
  - getAuthCode
```
public String getAuthCode()
```
    Gets the auth code from the payment network.
    
    Specified by:
    
    getAuthCode in interface IApprovalResponse
    
    Returns:
    
    the auth code from the payment network.
  - setAuthResponseCode
```
public void setAuthResponseCode(String value)
```
    Sets the code returned by the terminal or the card issuer to indicate the disposition of the message.
    
    Parameters:
    
    value - the code returned by the terminal or the card issuer to indicate the disposition of the message.
  - getAuthResponseCode
```
public String getAuthResponseCode()
```
    Gets the code returned by the terminal or the card issuer to indicate the disposition of the message.
    
    Specified by:
    
    getAuthResponseCode in interface IApprovalResponse
    
    Returns:
    
    the code returned by the terminal or the card issuer to indicate the disposition of the message.
  - setTransactionId
```
public void setTransactionId(String value)
```
    Sets the ID assigned to the transaction.
    
    Parameters:
    
    value - the ID assigned to the transaction.
  - getTransactionId
```
public String getTransactionId()
```
    Gets the ID assigned to the transaction.
    
    Specified by:
    
    getTransactionId in interface ICoreResponse
    
    Returns:
    
    the ID assigned to the transaction.
  - setBatchId
```
public void setBatchId(String value)
```
    Sets the ID assigned to the batch.
    
    Parameters:
    
    value - the ID assigned to the batch.
  - getBatchId
```
public String getBatchId()
```
    Gets the ID assigned to the batch.
    
    Specified by:
    
    getBatchId in interface ICoreResponse
    
    Returns:
    
    the ID assigned to the batch.
  - 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 ICoreResponse
    
    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.
  - setTransactionType
```
public void setTransactionType(String value)
```
    Sets the type of transaction.
    
    Parameters:
    
    value - the type of transaction.
  - getTransactionType
```
public String getTransactionType()
```
    Gets the type of transaction.
    
    Specified by:
    
    getTransactionType in interface ICoreResponse
    
    Returns:
    
    the type of transaction.
  - setTimestamp
```
public void setTimestamp(String value)
```
    Sets the timestamp of the transaction.
    
    Parameters:
    
    value - the timestamp of the transaction.
  - getTimestamp
```
public String getTimestamp()
```
    Gets the timestamp of the transaction.
    
    Specified by:
    
    getTimestamp in interface ICoreResponse
    
    Returns:
    
    the timestamp of the transaction.
  - setTickBlock
```
public void setTickBlock(String value)
```
    Sets the hash of the last tick block.
    
    Parameters:
    
    value - the hash of the last tick block.
  - getTickBlock
```
public String getTickBlock()
```
    Gets the hash of the last tick block.
    
    Specified by:
    
    getTickBlock in interface ICoreResponse
    
    Returns:
    
    the hash of the last tick block.
  - setTest
```
public void setTest(boolean value)
```
    Sets that the transaction was processed on the test gateway.
    
    Parameters:
    
    value - that the transaction was processed on the test gateway.
  - isTest
```
public boolean isTest()
```
    Gets that the transaction was processed on the test gateway.
    
    Specified by:
    
    isTest in interface ICoreResponse
    
    Returns:
    
    that the transaction was processed on the test gateway.
  - 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 ICoreResponse
    
    Returns:
    
    the settlement account for merchants with split settlements.
  - setSig
```
public void setSig(String value)
```
    Sets the ECC signature of the response.
    
    Parameters:
    
    value - the ECC signature of the response. Can be used to ensure that it was signed by the terminal and detect man-in-the middle attacks.
  - getSig
```
public String getSig()
```
    Gets the ECC signature of the response.
    
    Specified by:
    
    getSig in interface ICoreResponse
    
    Returns:
    
    the ECC signature of the response. Can be used to ensure that it was signed by the terminal and detect man-in-the middle attacks.
  - setPartialAuth
```
public void setPartialAuth(boolean value)
```
    Sets whether or not the transaction was approved for a partial amount.
    
    Parameters:
    
    value - whether or not the transaction was approved for a partial amount.
  - isPartialAuth
```
public boolean isPartialAuth()
```
    Gets whether or not the transaction was approved for a partial amount.
    
    Specified by:
    
    isPartialAuth in interface IPaymentAmounts
    
    Returns:
    
    whether or not the transaction was approved for a partial amount.
  - setAltCurrency
```
public void setAltCurrency(boolean value)
```
    Sets whether or not an alternate currency was used.
    
    Parameters:
    
    value - whether or not an alternate currency was used.
  - isAltCurrency
```
public boolean isAltCurrency()
```
    Gets whether or not an alternate currency was used.
    
    Specified by:
    
    isAltCurrency in interface IPaymentAmounts
    
    Returns:
    
    whether or not an alternate currency was used.
  - setFsaAuth
```
public void setFsaAuth(boolean value)
```
    Sets whether or not a request was settled on an FSA card.
    
    Parameters:
    
    value - whether or not a request was settled on an FSA card.
  - isFsaAuth
```
public boolean isFsaAuth()
```
    Gets whether or not a request was settled on an FSA card.
    
    Specified by:
    
    isFsaAuth in interface IPaymentAmounts
    
    Returns:
    
    whether or not a request was settled on an FSA card.
  - setCurrencyCode
```
public void setCurrencyCode(String value)
```
    Sets the currency code used for the transaction.
    
    Parameters:
    
    value - the currency code used for the transaction.
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Gets the currency code used for the transaction.
    
    Specified by:
    
    getCurrencyCode in interface IPaymentAmounts
    
    Returns:
    
    the currency code used for the transaction.
  - setRequestedAmount
```
public void setRequestedAmount(String value)
```
    Sets the requested amount.
    
    Parameters:
    
    value - the requested amount.
  - getRequestedAmount
```
public String getRequestedAmount()
```
    Gets the requested amount.
    
    Specified by:
    
    getRequestedAmount in interface IPaymentAmounts
    
    Returns:
    
    the requested amount.
  - setAuthorizedAmount
```
public void setAuthorizedAmount(String value)
```
    Sets the authorized amount.
    
    Parameters:
    
    value - the authorized amount. May not match the requested amount in the event of a partial auth.
  - getAuthorizedAmount
```
public String getAuthorizedAmount()
```
    Gets the authorized amount.
    
    Specified by:
    
    getAuthorizedAmount in interface IPaymentAmounts
    
    Returns:
    
    the authorized amount. May not match the requested amount in the event of a partial auth.
  - setRemainingBalance
```
public void setRemainingBalance(String value)
```
    Sets the remaining balance on the payment method.
    
    Parameters:
    
    value - the remaining balance on the payment method.
  - getRemainingBalance
```
public String getRemainingBalance()
```
    Gets the remaining balance on the payment method.
    
    Specified by:
    
    getRemainingBalance in interface IPaymentAmounts
    
    Returns:
    
    the remaining balance on the payment method.
  - 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 IPaymentAmounts
    
    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 IPaymentAmounts
    
    Returns:
    
    the tax amount.
  - setRequestedCashBackAmount
```
public void setRequestedCashBackAmount(String value)
```
    Sets the cash back amount the customer requested during the transaction.
    
    Parameters:
    
    value - the cash back amount the customer requested during the transaction.
  - getRequestedCashBackAmount
```
public String getRequestedCashBackAmount()
```
    Gets the cash back amount the customer requested during the transaction.
    
    Specified by:
    
    getRequestedCashBackAmount in interface IPaymentAmounts
    
    Returns:
    
    the cash back amount the customer requested during the transaction.
  - setAuthorizedCashBackAmount
```
public void setAuthorizedCashBackAmount(String value)
```
    Sets the amount of cash back authorized by the gateway.
    
    Parameters:
    
    value - the amount of cash back authorized by the gateway. This amount will be the entire amount requested, or zero.
  - getAuthorizedCashBackAmount
```
public String getAuthorizedCashBackAmount()
```
    Gets the amount of cash back authorized by the gateway.
    
    Specified by:
    
    getAuthorizedCashBackAmount in interface IPaymentAmounts
    
    Returns:
    
    the amount of cash back authorized by the gateway. This amount will be the entire amount requested, or zero.
  - setConfirmed
```
public void setConfirmed(boolean value)
```
    Sets that the transaction has met the standard criteria for confirmation on the network.
    
    Parameters:
    
    value - that the transaction has met the standard criteria for confirmation on the network. (For example, 6 confirmations for level one bitcoin.)
  - isConfirmed
```
public boolean isConfirmed()
```
    Gets that the transaction has met the standard criteria for confirmation on the network.
    
    Specified by:
    
    isConfirmed in interface ICryptocurrencyResponse
    
    Returns:
    
    that the transaction has met the standard criteria for confirmation on the network. (For example, 6 confirmations for level one bitcoin.)
  - setCryptoAuthorizedAmount
```
public void setCryptoAuthorizedAmount(String value)
```
    Sets the amount submitted to the blockchain.
    
    Parameters:
    
    value - the amount submitted to the blockchain.
  - getCryptoAuthorizedAmount
```
public String getCryptoAuthorizedAmount()
```
    Gets the amount submitted to the blockchain.
    
    Specified by:
    
    getCryptoAuthorizedAmount in interface ICryptocurrencyResponse
    
    Returns:
    
    the amount submitted to the blockchain.
  - setCryptoNetworkFee
```
public void setCryptoNetworkFee(String value)
```
    Sets the network level fee assessed for the transaction denominated in cryptocurrency.
    
    Parameters:
    
    value - the network level fee assessed for the transaction denominated in cryptocurrency. This fee goes to channel operators and crypto miners, not BlockChyp.
  - getCryptoNetworkFee
```
public String getCryptoNetworkFee()
```
    Gets the network level fee assessed for the transaction denominated in cryptocurrency.
    
    Specified by:
    
    getCryptoNetworkFee in interface ICryptocurrencyResponse
    
    Returns:
    
    the network level fee assessed for the transaction denominated in cryptocurrency. This fee goes to channel operators and crypto miners, not BlockChyp.
  - setCryptocurrency
```
public void setCryptocurrency(String value)
```
    Sets the three letter cryptocurrency code used for the transactions.
    
    Parameters:
    
    value - the three letter cryptocurrency code used for the transactions.
  - getCryptocurrency
```
public String getCryptocurrency()
```
    Gets the three letter cryptocurrency code used for the transactions.
    
    Specified by:
    
    getCryptocurrency in interface ICryptocurrencyResponse
    
    Returns:
    
    the three letter cryptocurrency code used for the transactions.
  - setCryptoNetwork
```
public void setCryptoNetwork(String value)
```
    Sets whether or not the transaction was processed on the level one or level two network.
    
    Parameters:
    
    value - whether or not the transaction was processed on the level one or level two network.
  - getCryptoNetwork
```
public String getCryptoNetwork()
```
    Gets whether or not the transaction was processed on the level one or level two network.
    
    Specified by:
    
    getCryptoNetwork in interface ICryptocurrencyResponse
    
    Returns:
    
    whether or not the transaction was processed on the level one or level two network.
  - setCryptoReceiveAddress
```
public void setCryptoReceiveAddress(String value)
```
    Sets the address on the crypto network the transaction was sent to.
    
    Parameters:
    
    value - the address on the crypto network the transaction was sent to.
  - getCryptoReceiveAddress
```
public String getCryptoReceiveAddress()
```
    Gets the address on the crypto network the transaction was sent to.
    
    Specified by:
    
    getCryptoReceiveAddress in interface ICryptocurrencyResponse
    
    Returns:
    
    the address on the crypto network the transaction was sent to.
  - setCryptoBlock
```
public void setCryptoBlock(String value)
```
    Sets hash or other identifier that identifies the block on the cryptocurrency network, if available or relevant.
    
    Parameters:
    
    value - hash or other identifier that identifies the block on the cryptocurrency network, if available or relevant.
  - getCryptoBlock
```
public String getCryptoBlock()
```
    Gets hash or other identifier that identifies the block on the cryptocurrency network, if available or relevant.
    
    Specified by:
    
    getCryptoBlock in interface ICryptocurrencyResponse
    
    Returns:
    
    hash or other identifier that identifies the block on the cryptocurrency network, if available or relevant.
  - setCryptoTransactionId
```
public void setCryptoTransactionId(String value)
```
    Sets hash or other transaction identifier that identifies the transaction on the cryptocurrency network, if available or relevant.
    
    Parameters:
    
    value - hash or other transaction identifier that identifies the transaction on the cryptocurrency network, if available or relevant.
  - getCryptoTransactionId
```
public String getCryptoTransactionId()
```
    Gets hash or other transaction identifier that identifies the transaction on the cryptocurrency network, if available or relevant.
    
    Specified by:
    
    getCryptoTransactionId in interface ICryptocurrencyResponse
    
    Returns:
    
    hash or other transaction identifier that identifies the transaction on the cryptocurrency network, if available or relevant.
  - setCryptoPaymentRequest
```
public void setCryptoPaymentRequest(String value)
```
    Sets the payment request URI used for the transaction, if available.
    
    Parameters:
    
    value - the payment request URI used for the transaction, if available.
  - getCryptoPaymentRequest
```
public String getCryptoPaymentRequest()
```
    Gets the payment request URI used for the transaction, if available.
    
    Specified by:
    
    getCryptoPaymentRequest in interface ICryptocurrencyResponse
    
    Returns:
    
    the payment request URI used for the transaction, if available.
  - setCryptoStatus
```
public void setCryptoStatus(String value)
```
    Sets used for additional status information related to crypto transactions.
    
    Parameters:
    
    value - used for additional status information related to crypto transactions.
  - getCryptoStatus
```
public String getCryptoStatus()
```
    Gets used for additional status information related to crypto transactions.
    
    Specified by:
    
    getCryptoStatus in interface ICryptocurrencyResponse
    
    Returns:
    
    used for additional status information related to crypto transactions.
  - setToken
```
public void setToken(String value)
```
    Sets the payment token, if the payment was enrolled in the vault.
    
    Parameters:
    
    value - the payment token, if the payment was enrolled in the vault.
  - getToken
```
public String getToken()
```
    Gets the payment token, if the payment was enrolled in the vault.
    
    Specified by:
    
    getToken in interface IPaymentMethodResponse
    
    Returns:
    
    the payment token, if the payment was enrolled in the vault.
  - setEntryMethod
```
public void setEntryMethod(String value)
```
    Sets the entry method for the transaction (CHIP, MSR, KEYED, etc).
    
    Parameters:
    
    value - the entry method for the transaction (CHIP, MSR, KEYED, etc).
  - getEntryMethod
```
public String getEntryMethod()
```
    Gets the entry method for the transaction (CHIP, MSR, KEYED, etc).
    
    Specified by:
    
    getEntryMethod in interface IPaymentMethodResponse
    
    Returns:
    
    the entry method for the transaction (CHIP, MSR, KEYED, etc).
  - setPaymentType
```
public void setPaymentType(String value)
```
    Sets the card brand (VISA, MC, AMEX, etc).
    
    Parameters:
    
    value - the card brand (VISA, MC, AMEX, etc).
  - getPaymentType
```
public String getPaymentType()
```
    Gets the card brand (VISA, MC, AMEX, etc).
    
    Specified by:
    
    getPaymentType in interface IPaymentMethodResponse
    
    Returns:
    
    the card brand (VISA, MC, AMEX, etc).
  - setMaskedPan
```
public void setMaskedPan(String value)
```
    Sets the masked primary account number.
    
    Parameters:
    
    value - the masked primary account number.
  - getMaskedPan
```
public String getMaskedPan()
```
    Gets the masked primary account number.
    
    Specified by:
    
    getMaskedPan in interface IPaymentMethodResponse
    
    Returns:
    
    the masked primary account number.
  - setPublicKey
```
public void setPublicKey(String value)
```
    Sets the BlockChyp public key if the user presented a BlockChyp payment card.
    
    Parameters:
    
    value - the BlockChyp public key if the user presented a BlockChyp payment card.
  - getPublicKey
```
public String getPublicKey()
```
    Gets the BlockChyp public key if the user presented a BlockChyp payment card.
    
    Specified by:
    
    getPublicKey in interface IPaymentMethodResponse
    
    Returns:
    
    the BlockChyp public key if the user presented a BlockChyp payment card.
  - setScopeAlert
```
public void setScopeAlert(boolean value)
```
    Sets that the transaction did something that would put the system in PCI scope.
    
    Parameters:
    
    value - that the transaction did something that would put the system in PCI scope.
  - isScopeAlert
```
public boolean isScopeAlert()
```
    Gets that the transaction did something that would put the system in PCI scope.
    
    Specified by:
    
    isScopeAlert in interface IPaymentMethodResponse
    
    Returns:
    
    that the transaction did something that would put the system in PCI scope.
  - setCardHolder
```
public void setCardHolder(String value)
```
    Sets the cardholder name.
    
    Parameters:
    
    value - the cardholder name.
  - getCardHolder
```
public String getCardHolder()
```
    Gets the cardholder name.
    
    Specified by:
    
    getCardHolder in interface IPaymentMethodResponse
    
    Returns:
    
    the cardholder name.
  - setExpMonth
```
public void setExpMonth(String value)
```
    Sets the card expiration month in MM format.
    
    Parameters:
    
    value - the card expiration month in MM format.
  - getExpMonth
```
public String getExpMonth()
```
    Gets the card expiration month in MM format.
    
    Specified by:
    
    getExpMonth in interface IPaymentMethodResponse
    
    Returns:
    
    the card expiration month in MM format.
  - setExpYear
```
public void setExpYear(String value)
```
    Sets the card expiration year in YY format.
    
    Parameters:
    
    value - the card expiration year in YY format.
  - getExpYear
```
public String getExpYear()
```
    Gets the card expiration year in YY format.
    
    Specified by:
    
    getExpYear in interface IPaymentMethodResponse
    
    Returns:
    
    the card expiration year in YY format.
  - setAvsResponse
```
public void setAvsResponse(AvsResponse value)
```
    Sets address verification results if address information was submitted.
    
    Parameters:
    
    value - address verification results if address information was submitted.
  - getAvsResponse
```
public AvsResponse getAvsResponse()
```
    Gets address verification results if address information was submitted.
    
    Specified by:
    
    getAvsResponse in interface IPaymentMethodResponse
    
    Returns:
    
    address verification results if address information was submitted.
  - setReceiptSuggestions
```
public void setReceiptSuggestions(ReceiptSuggestions value)
```
    Sets suggested receipt fields.
    
    Parameters:
    
    value - suggested receipt fields.
  - getReceiptSuggestions
```
public ReceiptSuggestions getReceiptSuggestions()
```
    Gets suggested receipt fields.
    
    Specified by:
    
    getReceiptSuggestions in interface IPaymentMethodResponse
    
    Returns:
    
    suggested receipt fields.
  - setCustomer
```
public void setCustomer(Customer value)
```
    Sets customer data, if any.
    
    Parameters:
    
    value - customer data, if any. Preserved for reverse compatibility.
  - getCustomer
```
public Customer getCustomer()
```
    Gets customer data, if any.
    
    Specified by:
    
    getCustomer in interface IPaymentMethodResponse
    
    Returns:
    
    customer data, if any. Preserved for reverse compatibility.
  - setCustomers
```
public void setCustomers(Collection<Customer> value)
```
    Sets customer data, if any.
    
    Parameters:
    
    value - customer data, if any.
  - getCustomers
```
public Collection<Customer> getCustomers()
```
    Gets customer data, if any.
    
    Specified by:
    
    getCustomers in interface IPaymentMethodResponse
    
    Returns:
    
    customer data, if any.
  - setSigFile
```
public void setSigFile(String value)
```
    Sets the hex encoded signature data.
    
    Parameters:
    
    value - the hex encoded signature data.
  - getSigFile
```
public String getSigFile()
```
    Gets the hex encoded signature data.
    
    Specified by:
    
    getSigFile in interface ISignatureResponse
    
    Returns:
    
    the hex encoded signature data.
  - setWhiteListedCard
```
public void setWhiteListedCard(WhiteListedCard value)
```
    Sets card BIN ranges can be whitelisted so that they are read instead of being processed directly.
    
    Parameters:
    
    value - card BIN ranges can be whitelisted so that they are read instead of being processed directly. This is useful for integration with legacy gift card systems.
  - getWhiteListedCard
```
public WhiteListedCard getWhiteListedCard()
```
    Gets card BIN ranges can be whitelisted so that they are read instead of being processed directly.
    
    Returns:
    
    card BIN ranges can be whitelisted so that they are read instead of being processed directly. This is useful for integration with legacy gift card systems.
  - setStoreAndForward
```
public void setStoreAndForward(boolean value)
```
    Sets that the transaction was flagged for store and forward due to network problems.
    
    Parameters:
    
    value - that the transaction was flagged for store and forward due to network problems.
  - isStoreAndForward
```
public boolean isStoreAndForward()
```
    Gets that the transaction was flagged for store and forward due to network problems.
    
    Returns:
    
    that the transaction was flagged for store and forward due to network problems.
  - setStatus
```
public void setStatus(String value)
```
    Sets the current status of a transaction
    
    Parameters:
    
    value - the current status of a transaction
  - getStatus
```
public String getStatus()
```
    Gets the current status of a transaction
    
    Returns:
    
    the current status of a transaction
  - addCustomer
```
public void addCustomer(Customer value)
```
    Adds a customer data, if any.
    
    Parameters:
    
    value - customer data, if any.

Class AuthorizationResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthorizationResponse

Method Detail

setSuccess

isSuccess

setError

getError

setResponseDescription

getResponseDescription

setApproved

isApproved

setAuthCode

getAuthCode

setAuthResponseCode

getAuthResponseCode

setTransactionId

getTransactionId

setBatchId

getBatchId

setTransactionRef

getTransactionRef

setTransactionType

getTransactionType

setTimestamp

getTimestamp

setTickBlock

getTickBlock

setTest

isTest

setDestinationAccount

getDestinationAccount

setSig

getSig

setPartialAuth

isPartialAuth

setAltCurrency

isAltCurrency

setFsaAuth

isFsaAuth

setCurrencyCode

getCurrencyCode

setRequestedAmount

getRequestedAmount

setAuthorizedAmount

getAuthorizedAmount

setRemainingBalance

getRemainingBalance

setTipAmount

getTipAmount

setTaxAmount

getTaxAmount

setRequestedCashBackAmount

getRequestedCashBackAmount

setAuthorizedCashBackAmount

getAuthorizedCashBackAmount

setConfirmed

isConfirmed

setCryptoAuthorizedAmount

getCryptoAuthorizedAmount

setCryptoNetworkFee

getCryptoNetworkFee

setCryptocurrency

getCryptocurrency

setCryptoNetwork

getCryptoNetwork

setCryptoReceiveAddress

getCryptoReceiveAddress

setCryptoBlock

getCryptoBlock

setCryptoTransactionId

getCryptoTransactionId

setCryptoPaymentRequest

getCryptoPaymentRequest

setCryptoStatus

getCryptoStatus

setToken