Package com.blockchyp.client.dto
Class MerchantProfileResponse
java.lang.Object
com.blockchyp.client.dto.MerchantProfileResponse
- All Implemented Interfaces:
IAbstractAcknowledgement
Models a response for a single merchant profile.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBankAccount(BankAccount value) Adds a bank accounts for split bank account merchants.voidaddCashbackPreset(String value) Adds a four default values for cashback prompts.voidaddTipDefault(String value) Adds a three default values for tips.Gets bank accounts for split bank account merchants.Gets the batch close time in the merchant's time zone.Gets the address to be used for billing correspondence.Gets four default values for cashback prompts.Gets the merchant's company name.Gets the contact name for the merchant.Gets the contact number for the merchant.intGets time a transaction result is displayed on a terminal before the terminal is automatically cleared in seconds.Gets the dba name of the merchant.getError()Gets the error, if an error occurred.Gets the name the merchant prefers on payment link invoices.Gets the location name.Gets the merchant id.Gets the partner assigne reference for this merchant.Gets the blockchyp public key for this merchant.Gets a narrative description of the transaction result.Gets the address to be used for shipping.Gets the underwriting/processing status for the the merchant.Gets floor limit for store and forward transactions.Gets the store number.intGets the post transaction survey timeout in seconds.Gets the terminal firmware update time.Gets the merchant's local time zone.Gets three default values for tips.booleanisAmex()Gets that American Express is supported.booleanGets flag indicating whether or not the batch automatically closes.booleanGets flag indicating whether or not cash back is enabled.booleanGets enables cash discount or surcharging.booleanGets that contactless EMV cards are supported.booleanGets that transactions should auto-reverse when signatures are refused.booleanGets that digital signature capture is enabled.booleanGets flag indicating whether or not batch closure emails should be automatically sent.booleanGets that Discover cards are supported.booleanGets that EBT cards are enabled.booleanGets that refunds without transaction references are permitted.booleanGets that this merchant is boarded on BlockChyp in gateway only mode.booleanGets that gift cards are disabled.booleanisJcb()Gets that JCB (Japan Card Bureau) cards are supported.booleanGets that manual card entry is enabled.booleanGets requires a street number to be entered for manually entered transactions.booleanGets requires a zip code to be entered for manually entered transactions.booleanGets that MasterCard is supported.booleanGets flag indicating whether or not partial authorizations are supported for this merchant.booleanGets that pin bypass is enabled.booleanGets flag indicating whether or not pin entry is enabled.booleanGets that tips should be automatically prompted for after charge and preauth transactions.booleanGets flag indicating whether or not this merchant support split settlement.booleanGets flag indicating whether or not store and forward is enabled.booleanGets whether or not the request succeeded.booleanGets disables terms and conditions pages in the merchant UI.booleanisTest()Gets that the response came from the test gateway.booleanGets that tips are enabled for a merchant account.booleanGets that China Union Pay cards are supported.booleanisVisa()Gets that Visa cards are supported.voidsetAmex(boolean value) Sets that American Express is supported.voidsetAutoBatchClose(boolean value) Sets flag indicating whether or not the batch automatically closes.voidsetBankAccounts(Collection<BankAccount> value) Sets bank accounts for split bank account merchants.voidsetBatchCloseTime(String value) Sets the batch close time in the merchant's time zone.voidsetBillingAddress(Address value) Sets the address to be used for billing correspondence.voidsetCashBackEnabled(boolean value) Sets flag indicating whether or not cash back is enabled.voidsetCashbackPresets(Collection<String> value) Sets four default values for cashback prompts.voidsetCashDiscountEnabled(boolean value) Sets enables cash discount or surcharging.voidsetCompanyName(String value) Sets the merchant's company name.voidsetContactlessEmv(boolean value) Sets that contactless EMV cards are supported.voidsetContactName(String value) Sets the contact name for the merchant.voidsetContactNumber(String value) Sets the contact number for the merchant.voidsetCooldownTimeout(int value) Sets time a transaction result is displayed on a terminal before the terminal is automatically cleared in seconds.voidsetDbaName(String value) Sets the dba name of the merchant.voidsetDigitalSignatureReversal(boolean value) Sets that transactions should auto-reverse when signatures are refused.voidsetDigitalSignaturesEnabled(boolean value) Sets that digital signature capture is enabled.voidsetDisableBatchEmails(boolean value) Sets flag indicating whether or not batch closure emails should be automatically sent.voidsetDiscover(boolean value) Sets that Discover cards are supported.voidsetEbtEnabled(boolean value) Sets that EBT cards are enabled.voidSets the error, if an error occurred.voidsetFreeRangeRefundsEnabled(boolean value) Sets that refunds without transaction references are permitted.voidsetGatewayOnly(boolean value) Sets that this merchant is boarded on BlockChyp in gateway only mode.voidsetGiftCardsDisabled(boolean value) Sets that gift cards are disabled.voidsetInvoiceName(String value) Sets the name the merchant prefers on payment link invoices.voidsetJcb(boolean value) Sets that JCB (Japan Card Bureau) cards are supported.voidsetLocationName(String value) Sets the location name.voidsetManualEntryEnabled(boolean value) Sets that manual card entry is enabled.voidsetManualEntryPromptStreetNumber(boolean value) Sets requires a street number to be entered for manually entered transactions.voidsetManualEntryPromptZip(boolean value) Sets requires a zip code to be entered for manually entered transactions.voidsetMasterCard(boolean value) Sets that MasterCard is supported.voidsetMerchantId(String value) Sets the merchant id.voidsetPartialAuthEnabled(boolean value) Sets flag indicating whether or not partial authorizations are supported for this merchant.voidsetPartnerRef(String value) Sets the partner assigne reference for this merchant.voidsetPinBypassEnabled(boolean value) Sets that pin bypass is enabled.voidsetPinEnabled(boolean value) Sets flag indicating whether or not pin entry is enabled.voidsetPromptForTip(boolean value) Sets that tips should be automatically prompted for after charge and preauth transactions.voidsetPublicKey(String value) Sets the blockchyp public key for this merchant.voidsetResponseDescription(String value) Sets a narrative description of the transaction result.voidsetShippingAddress(Address value) Sets the address to be used for shipping.voidsetSplitBankAccountsEnabled(boolean value) Sets flag indicating whether or not this merchant support split settlement.voidSets the underwriting/processing status for the the merchant.voidsetStoreAndForwardEnabled(boolean value) Sets flag indicating whether or not store and forward is enabled.voidSets floor limit for store and forward transactions.voidsetStoreNumber(String value) Sets the store number.voidsetSuccess(boolean value) Sets whether or not the request succeeded.voidsetSurveyTimeout(int value) Sets the post transaction survey timeout in seconds.voidsetTcDisabled(boolean value) Sets disables terms and conditions pages in the merchant UI.voidsetTerminalUpdateTime(String value) Sets the terminal firmware update time.voidsetTest(boolean value) Sets that the response came from the test gateway.voidsetTimeZone(String value) Sets the merchant's local time zone.voidsetTipDefaults(Collection<String> value) Sets three default values for tips.voidsetTipEnabled(boolean value) Sets that tips are enabled for a merchant account.voidsetUnionPay(boolean value) Sets that China Union Pay cards are supported.voidsetVisa(boolean value) Sets that Visa cards are supported.
-
Constructor Details
-
MerchantProfileResponse
public MerchantProfileResponse()
-
-
Method Details
-
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:
isSuccessin interfaceIAbstractAcknowledgement- Returns:
- whether or not the request succeeded.
-
setError
Sets the error, if an error occurred.- Parameters:
value- the error, if an error occurred.
-
getError
Gets the error, if an error occurred.- Specified by:
getErrorin interfaceIAbstractAcknowledgement- Returns:
- the error, if an error occurred.
-
setResponseDescription
Sets a narrative description of the transaction result.- Parameters:
value- a narrative description of the transaction result.
-
getResponseDescription
Gets a narrative description of the transaction result.- Specified by:
getResponseDescriptionin interfaceIAbstractAcknowledgement- Returns:
- a narrative description of the transaction result.
-
setTest
public void setTest(boolean value) Sets that the response came from the test gateway.- Parameters:
value- that the response came from the test gateway.
-
isTest
public boolean isTest()Gets that the response came from the test gateway.- Returns:
- that the response came from the test gateway.
-
setMerchantId
Sets the merchant id.- Parameters:
value- the merchant id.
-
getMerchantId
Gets the merchant id.- Returns:
- the merchant id.
-
setCompanyName
Sets the merchant's company name.- Parameters:
value- the merchant's company name.
-
getCompanyName
Gets the merchant's company name.- Returns:
- the merchant's company name.
-
setDbaName
Sets the dba name of the merchant.- Parameters:
value- the dba name of the merchant.
-
getDbaName
Gets the dba name of the merchant.- Returns:
- the dba name of the merchant.
-
setInvoiceName
Sets the name the merchant prefers on payment link invoices.- Parameters:
value- the name the merchant prefers on payment link invoices.
-
getInvoiceName
Gets the name the merchant prefers on payment link invoices.- Returns:
- the name the merchant prefers on payment link invoices.
-
setContactName
Sets the contact name for the merchant.- Parameters:
value- the contact name for the merchant.
-
getContactName
Gets the contact name for the merchant.- Returns:
- the contact name for the merchant.
-
setContactNumber
Sets the contact number for the merchant.- Parameters:
value- the contact number for the merchant.
-
getContactNumber
Gets the contact number for the merchant.- Returns:
- the contact number for the merchant.
-
setLocationName
Sets the location name.- Parameters:
value- the location name.
-
getLocationName
Gets the location name.- Returns:
- the location name.
-
setStoreNumber
Sets the store number.- Parameters:
value- the store number.
-
getStoreNumber
Gets the store number.- Returns:
- the store number.
-
setPartnerRef
Sets the partner assigne reference for this merchant.- Parameters:
value- the partner assigne reference for this merchant.
-
getPartnerRef
Gets the partner assigne reference for this merchant.- Returns:
- the partner assigne reference for this merchant.
-
setTimeZone
Sets the merchant's local time zone.- Parameters:
value- the merchant's local time zone.
-
getTimeZone
Gets the merchant's local time zone.- Returns:
- the merchant's local time zone.
-
setBatchCloseTime
Sets the batch close time in the merchant's time zone.- Parameters:
value- the batch close time in the merchant's time zone.
-
getBatchCloseTime
Gets the batch close time in the merchant's time zone.- Returns:
- the batch close time in the merchant's time zone.
-
setTerminalUpdateTime
Sets the terminal firmware update time.- Parameters:
value- the terminal firmware update time.
-
getTerminalUpdateTime
Gets the terminal firmware update time.- Returns:
- the terminal firmware update time.
-
setAutoBatchClose
public void setAutoBatchClose(boolean value) Sets flag indicating whether or not the batch automatically closes.- Parameters:
value- flag indicating whether or not the batch automatically closes.
-
isAutoBatchClose
public boolean isAutoBatchClose()Gets flag indicating whether or not the batch automatically closes.- Returns:
- flag indicating whether or not the batch automatically closes.
-
setDisableBatchEmails
public void setDisableBatchEmails(boolean value) Sets flag indicating whether or not batch closure emails should be automatically sent.- Parameters:
value- flag indicating whether or not batch closure emails should be automatically sent.
-
isDisableBatchEmails
public boolean isDisableBatchEmails()Gets flag indicating whether or not batch closure emails should be automatically sent.- Returns:
- flag indicating whether or not batch closure emails should be automatically sent.
-
setPinEnabled
public void setPinEnabled(boolean value) Sets flag indicating whether or not pin entry is enabled.- Parameters:
value- flag indicating whether or not pin entry is enabled.
-
isPinEnabled
public boolean isPinEnabled()Gets flag indicating whether or not pin entry is enabled.- Returns:
- flag indicating whether or not pin entry is enabled.
-
setCashBackEnabled
public void setCashBackEnabled(boolean value) Sets flag indicating whether or not cash back is enabled.- Parameters:
value- flag indicating whether or not cash back is enabled.
-
isCashBackEnabled
public boolean isCashBackEnabled()Gets flag indicating whether or not cash back is enabled.- Returns:
- flag indicating whether or not cash back is enabled.
-
setStoreAndForwardEnabled
public void setStoreAndForwardEnabled(boolean value) Sets flag indicating whether or not store and forward is enabled.- Parameters:
value- flag indicating whether or not store and forward is enabled.
-
isStoreAndForwardEnabled
public boolean isStoreAndForwardEnabled()Gets flag indicating whether or not store and forward is enabled.- Returns:
- flag indicating whether or not store and forward is enabled.
-
setPartialAuthEnabled
public void setPartialAuthEnabled(boolean value) Sets flag indicating whether or not partial authorizations are supported for this merchant.- Parameters:
value- flag indicating whether or not partial authorizations are supported for this merchant.
-
isPartialAuthEnabled
public boolean isPartialAuthEnabled()Gets flag indicating whether or not partial authorizations are supported for this merchant.- Returns:
- flag indicating whether or not partial authorizations are supported for this merchant.
-
setSplitBankAccountsEnabled
public void setSplitBankAccountsEnabled(boolean value) Sets flag indicating whether or not this merchant support split settlement.- Parameters:
value- flag indicating whether or not this merchant support split settlement.
-
isSplitBankAccountsEnabled
public boolean isSplitBankAccountsEnabled()Gets flag indicating whether or not this merchant support split settlement.- Returns:
- flag indicating whether or not this merchant support split settlement.
-
setStoreAndForwardFloorLimit
Sets floor limit for store and forward transactions.- Parameters:
value- floor limit for store and forward transactions.
-
getStoreAndForwardFloorLimit
Gets floor limit for store and forward transactions.- Returns:
- floor limit for store and forward transactions.
-
setPublicKey
Sets the blockchyp public key for this merchant.- Parameters:
value- the blockchyp public key for this merchant.
-
getPublicKey
Gets the blockchyp public key for this merchant.- Returns:
- the blockchyp public key for this merchant.
-
setStatus
Sets the underwriting/processing status for the the merchant.- Parameters:
value- the underwriting/processing status for the the merchant.
-
getStatus
Gets the underwriting/processing status for the the merchant.- Returns:
- the underwriting/processing status for the the merchant.
-
setCashDiscountEnabled
public void setCashDiscountEnabled(boolean value) Sets enables cash discount or surcharging.- Parameters:
value- enables cash discount or surcharging.
-
isCashDiscountEnabled
public boolean isCashDiscountEnabled()Gets enables cash discount or surcharging.- Returns:
- enables cash discount or surcharging.
-
setSurveyTimeout
public void setSurveyTimeout(int value) Sets the post transaction survey timeout in seconds.- Parameters:
value- the post transaction survey timeout in seconds.
-
getSurveyTimeout
public int getSurveyTimeout()Gets the post transaction survey timeout in seconds.- Returns:
- the post transaction survey timeout in seconds.
-
setCooldownTimeout
public void setCooldownTimeout(int value) Sets time a transaction result is displayed on a terminal before the terminal is automatically cleared in seconds.- Parameters:
value- time a transaction result is displayed on a terminal before the terminal is automatically cleared in seconds.
-
getCooldownTimeout
public int getCooldownTimeout()Gets time a transaction result is displayed on a terminal before the terminal is automatically cleared in seconds.- Returns:
- time a transaction result is displayed on a terminal before the terminal is automatically cleared in seconds.
-
setTipEnabled
public void setTipEnabled(boolean value) Sets that tips are enabled for a merchant account.- Parameters:
value- that tips are enabled for a merchant account.
-
isTipEnabled
public boolean isTipEnabled()Gets that tips are enabled for a merchant account.- Returns:
- that tips are enabled for a merchant account.
-
setPromptForTip
public void setPromptForTip(boolean value) Sets that tips should be automatically prompted for after charge and preauth transactions.- Parameters:
value- that tips should be automatically prompted for after charge and preauth transactions.
-
isPromptForTip
public boolean isPromptForTip()Gets that tips should be automatically prompted for after charge and preauth transactions.- Returns:
- that tips should be automatically prompted for after charge and preauth transactions.
-
setTipDefaults
Sets three default values for tips.- Parameters:
value- three default values for tips. Can be provided as a percentage if a percent sign is provided. Otherwise the values are assumed to be basis points.
-
getTipDefaults
Gets three default values for tips.- Returns:
- three default values for tips. Can be provided as a percentage if a percent sign is provided. Otherwise the values are assumed to be basis points.
-
setCashbackPresets
Sets four default values for cashback prompts.- Parameters:
value- four default values for cashback prompts.
-
getCashbackPresets
Gets four default values for cashback prompts.- Returns:
- four default values for cashback prompts.
-
setEbtEnabled
public void setEbtEnabled(boolean value) Sets that EBT cards are enabled.- Parameters:
value- that EBT cards are enabled.
-
isEbtEnabled
public boolean isEbtEnabled()Gets that EBT cards are enabled.- Returns:
- that EBT cards are enabled.
-
setFreeRangeRefundsEnabled
public void setFreeRangeRefundsEnabled(boolean value) Sets that refunds without transaction references are permitted.- Parameters:
value- that refunds without transaction references are permitted.
-
isFreeRangeRefundsEnabled
public boolean isFreeRangeRefundsEnabled()Gets that refunds without transaction references are permitted.- Returns:
- that refunds without transaction references are permitted.
-
setPinBypassEnabled
public void setPinBypassEnabled(boolean value) Sets that pin bypass is enabled.- Parameters:
value- that pin bypass is enabled.
-
isPinBypassEnabled
public boolean isPinBypassEnabled()Gets that pin bypass is enabled.- Returns:
- that pin bypass is enabled.
-
setGiftCardsDisabled
public void setGiftCardsDisabled(boolean value) Sets that gift cards are disabled.- Parameters:
value- that gift cards are disabled.
-
isGiftCardsDisabled
public boolean isGiftCardsDisabled()Gets that gift cards are disabled.- Returns:
- that gift cards are disabled.
-
setTcDisabled
public void setTcDisabled(boolean value) Sets disables terms and conditions pages in the merchant UI.- Parameters:
value- disables terms and conditions pages in the merchant UI.
-
isTcDisabled
public boolean isTcDisabled()Gets disables terms and conditions pages in the merchant UI.- Returns:
- disables terms and conditions pages in the merchant UI.
-
setDigitalSignaturesEnabled
public void setDigitalSignaturesEnabled(boolean value) Sets that digital signature capture is enabled.- Parameters:
value- that digital signature capture is enabled.
-
isDigitalSignaturesEnabled
public boolean isDigitalSignaturesEnabled()Gets that digital signature capture is enabled.- Returns:
- that digital signature capture is enabled.
-
setDigitalSignatureReversal
public void setDigitalSignatureReversal(boolean value) Sets that transactions should auto-reverse when signatures are refused.- Parameters:
value- that transactions should auto-reverse when signatures are refused.
-
isDigitalSignatureReversal
public boolean isDigitalSignatureReversal()Gets that transactions should auto-reverse when signatures are refused.- Returns:
- that transactions should auto-reverse when signatures are refused.
-
setBillingAddress
Sets the address to be used for billing correspondence.- Parameters:
value- the address to be used for billing correspondence.
-
getBillingAddress
Gets the address to be used for billing correspondence.- Returns:
- the address to be used for billing correspondence.
-
setShippingAddress
Sets the address to be used for shipping.- Parameters:
value- the address to be used for shipping.
-
getShippingAddress
Gets the address to be used for shipping.- Returns:
- the address to be used for shipping.
-
setVisa
public void setVisa(boolean value) Sets that Visa cards are supported.- Parameters:
value- that Visa cards are supported.
-
isVisa
public boolean isVisa()Gets that Visa cards are supported.- Returns:
- that Visa cards are supported.
-
setMasterCard
public void setMasterCard(boolean value) Sets that MasterCard is supported.- Parameters:
value- that MasterCard is supported.
-
isMasterCard
public boolean isMasterCard()Gets that MasterCard is supported.- Returns:
- that MasterCard is supported.
-
setAmex
public void setAmex(boolean value) Sets that American Express is supported.- Parameters:
value- that American Express is supported.
-
isAmex
public boolean isAmex()Gets that American Express is supported.- Returns:
- that American Express is supported.
-
setDiscover
public void setDiscover(boolean value) Sets that Discover cards are supported.- Parameters:
value- that Discover cards are supported.
-
isDiscover
public boolean isDiscover()Gets that Discover cards are supported.- Returns:
- that Discover cards are supported.
-
setJcb
public void setJcb(boolean value) Sets that JCB (Japan Card Bureau) cards are supported.- Parameters:
value- that JCB (Japan Card Bureau) cards are supported.
-
isJcb
public boolean isJcb()Gets that JCB (Japan Card Bureau) cards are supported.- Returns:
- that JCB (Japan Card Bureau) cards are supported.
-
setUnionPay
public void setUnionPay(boolean value) Sets that China Union Pay cards are supported.- Parameters:
value- that China Union Pay cards are supported.
-
isUnionPay
public boolean isUnionPay()Gets that China Union Pay cards are supported.- Returns:
- that China Union Pay cards are supported.
-
setContactlessEmv
public void setContactlessEmv(boolean value) Sets that contactless EMV cards are supported.- Parameters:
value- that contactless EMV cards are supported.
-
isContactlessEmv
public boolean isContactlessEmv()Gets that contactless EMV cards are supported.- Returns:
- that contactless EMV cards are supported.
-
setManualEntryEnabled
public void setManualEntryEnabled(boolean value) Sets that manual card entry is enabled.- Parameters:
value- that manual card entry is enabled.
-
isManualEntryEnabled
public boolean isManualEntryEnabled()Gets that manual card entry is enabled.- Returns:
- that manual card entry is enabled.
-
setManualEntryPromptZip
public void setManualEntryPromptZip(boolean value) Sets requires a zip code to be entered for manually entered transactions.- Parameters:
value- requires a zip code to be entered for manually entered transactions.
-
isManualEntryPromptZip
public boolean isManualEntryPromptZip()Gets requires a zip code to be entered for manually entered transactions.- Returns:
- requires a zip code to be entered for manually entered transactions.
-
setManualEntryPromptStreetNumber
public void setManualEntryPromptStreetNumber(boolean value) Sets requires a street number to be entered for manually entered transactions.- Parameters:
value- requires a street number to be entered for manually entered transactions.
-
isManualEntryPromptStreetNumber
public boolean isManualEntryPromptStreetNumber()Gets requires a street number to be entered for manually entered transactions.- Returns:
- requires a street number to be entered for manually entered transactions.
-
setGatewayOnly
public void setGatewayOnly(boolean value) Sets that this merchant is boarded on BlockChyp in gateway only mode.- Parameters:
value- that this merchant is boarded on BlockChyp in gateway only mode.
-
isGatewayOnly
public boolean isGatewayOnly()Gets that this merchant is boarded on BlockChyp in gateway only mode.- Returns:
- that this merchant is boarded on BlockChyp in gateway only mode.
-
setBankAccounts
Sets bank accounts for split bank account merchants.- Parameters:
value- bank accounts for split bank account merchants.
-
getBankAccounts
Gets bank accounts for split bank account merchants.- Returns:
- bank accounts for split bank account merchants.
-
addTipDefault
Adds a three default values for tips.- Parameters:
value- three default values for tips. Can be provided as a percentage if a percent sign is provided. Otherwise the values are assumed to be basis points.
-
addCashbackPreset
Adds a four default values for cashback prompts.- Parameters:
value- four default values for cashback prompts.
-
addBankAccount
Adds a bank accounts for split bank account merchants.- Parameters:
value- bank accounts for split bank account merchants.
-