public class AuthorizationResponse extends Object implements IAbstractAcknowledgement, IApprovalResponse, ICoreResponse, IPaymentAmounts, IPaymentMethodResponse, ISignatureResponse
| Constructor and Description |
|---|
AuthorizationResponse() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
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 |
getCurrencyCode()
Gets the currency code used for the transaction.
|
Customer |
getCustomer()
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 |
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 |
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 |
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 |
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 |
setCurrencyCode(String value)
Sets the currency code used for the transaction.
|
void |
setCustomer(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 |
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 |
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.
|
public void setSuccess(boolean value)
value - whether or not the request succeeded.public boolean isSuccess()
isSuccess in interface IAbstractAcknowledgementpublic void setError(String value)
value - the error, if an error occurred.public String getError()
getError in interface IAbstractAcknowledgementpublic void setResponseDescription(String value)
value - a narrative description of the transaction result.public String getResponseDescription()
getResponseDescription in interface IAbstractAcknowledgementpublic void setApproved(boolean value)
value - that the transaction was approved.public boolean isApproved()
isApproved in interface IApprovalResponsepublic void setAuthCode(String value)
value - the auth code from the payment network.public String getAuthCode()
getAuthCode in interface IApprovalResponsepublic void setTransactionId(String value)
value - the ID assigned to the transaction.public String getTransactionId()
getTransactionId in interface ICoreResponsepublic void setBatchId(String value)
value - the ID assigned to the batch.public String getBatchId()
getBatchId in interface ICoreResponsepublic void setTransactionRef(String value)
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.public String getTransactionRef()
getTransactionRef in interface ICoreResponsepublic void setTransactionType(String value)
value - the type of transaction.public String getTransactionType()
getTransactionType in interface ICoreResponsepublic void setTimestamp(String value)
value - the timestamp of the transaction.public String getTimestamp()
getTimestamp in interface ICoreResponsepublic void setTickBlock(String value)
value - the hash of the last tick block.public String getTickBlock()
getTickBlock in interface ICoreResponsepublic void setTest(boolean value)
value - that the transaction was processed on the test gateway.public boolean isTest()
isTest in interface ICoreResponsepublic void setDestinationAccount(String value)
value - the settlement account for merchants with split settlements.public String getDestinationAccount()
getDestinationAccount in interface ICoreResponsepublic void setSig(String value)
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.public String getSig()
getSig in interface ICoreResponsepublic void setPartialAuth(boolean value)
value - whether or not the transaction was approved for a partial amount.public boolean isPartialAuth()
isPartialAuth in interface IPaymentAmountspublic void setAltCurrency(boolean value)
value - whether or not an alternate currency was used.public boolean isAltCurrency()
isAltCurrency in interface IPaymentAmountspublic void setFsaAuth(boolean value)
value - whether or not a request was settled on an FSA card.public boolean isFsaAuth()
isFsaAuth in interface IPaymentAmountspublic void setCurrencyCode(String value)
value - the currency code used for the transaction.public String getCurrencyCode()
getCurrencyCode in interface IPaymentAmountspublic void setRequestedAmount(String value)
value - the requested amount.public String getRequestedAmount()
getRequestedAmount in interface IPaymentAmountspublic void setAuthorizedAmount(String value)
value - the authorized amount. May not match the requested amount in the event
of a partial auth.public String getAuthorizedAmount()
getAuthorizedAmount in interface IPaymentAmountspublic void setRemainingBalance(String value)
value - the remaining balance on the payment method.public String getRemainingBalance()
getRemainingBalance in interface IPaymentAmountspublic void setTipAmount(String value)
value - the tip amount.public String getTipAmount()
getTipAmount in interface IPaymentAmountspublic void setTaxAmount(String value)
value - the tax amount.public String getTaxAmount()
getTaxAmount in interface IPaymentAmountspublic void setRequestedCashBackAmount(String value)
value - the cash back amount the customer requested during the transaction.public String getRequestedCashBackAmount()
getRequestedCashBackAmount in interface IPaymentAmountspublic void setAuthorizedCashBackAmount(String value)
value - the amount of cash back authorized by the gateway. This amount will be
the entire amount requested, or zero.public String getAuthorizedCashBackAmount()
getAuthorizedCashBackAmount in interface IPaymentAmountspublic void setToken(String value)
value - the payment token, if the payment was enrolled in the vault.public String getToken()
getToken in interface IPaymentMethodResponsepublic void setEntryMethod(String value)
value - the entry method for the transaction (CHIP, MSR, KEYED, etc).public String getEntryMethod()
getEntryMethod in interface IPaymentMethodResponsepublic void setPaymentType(String value)
value - the card brand (VISA, MC, AMEX, etc).public String getPaymentType()
getPaymentType in interface IPaymentMethodResponsepublic void setMaskedPan(String value)
value - the masked primary account number.public String getMaskedPan()
getMaskedPan in interface IPaymentMethodResponsepublic void setPublicKey(String value)
value - the BlockChyp public key if the user presented a BlockChyp payment
card.public String getPublicKey()
getPublicKey in interface IPaymentMethodResponsepublic void setScopeAlert(boolean value)
value - that the transaction did something that would put the system in PCI
scope.public boolean isScopeAlert()
isScopeAlert in interface IPaymentMethodResponsepublic void setCardHolder(String value)
value - the cardholder name.public String getCardHolder()
getCardHolder in interface IPaymentMethodResponsepublic void setAvsResponse(AvsResponse value)
value - address verification results if address information was submitted.public AvsResponse getAvsResponse()
getAvsResponse in interface IPaymentMethodResponsepublic void setReceiptSuggestions(ReceiptSuggestions value)
value - suggested receipt fields.public ReceiptSuggestions getReceiptSuggestions()
getReceiptSuggestions in interface IPaymentMethodResponsepublic void setCustomer(Customer value)
value - customer data, if any.public Customer getCustomer()
getCustomer in interface IPaymentMethodResponsepublic void setSigFile(String value)
value - the hex encoded signature data.public String getSigFile()
getSigFile in interface ISignatureResponsepublic void setWhiteListedCard(WhiteListedCard value)
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.public WhiteListedCard getWhiteListedCard()
public void setStoreAndForward(boolean value)
value - that the transaction was flagged for store and forward due to network
problems.public boolean isStoreAndForward()
Copyright © 2020 BlockChyp, Inc.. All rights reserved.