Model

Class CardProcessingConfigCommon

java.lang.Object

Model.CardProcessingConfigCommon

public class CardProcessingConfigCommon
extends Object

CardProcessingConfigCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CardProcessingConfigCommon.DefaultAuthTypeCodeEnum Authorization Finality indicator.

Constructor Summary

Constructors

Constructor and Description
CardProcessingConfigCommon()

Method Summary

Modifier and Type	Method and Description
CardProcessingConfigCommon	allowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreaterThanAuthorizations)
CardProcessingConfigCommon	amexVendorCode(String amexVendorCode)
CardProcessingConfigCommon	businessCenterCreditCardRefundLimitPercent(String businessCenterCreditCardRefundLimitPercent)
CardProcessingConfigCommon	creditCardRefundLimitPercent(String creditCardRefundLimitPercent)
CardProcessingConfigCommon	defaultAuthTypeCode(CardProcessingConfigCommon.DefaultAuthTypeCodeEnum defaultAuthTypeCode)
CardProcessingConfigCommon	domesticMerchantId(Boolean domesticMerchantId)
CardProcessingConfigCommon	enableDuplicateMerchantReferenceNumberBlocking(Boolean enableDuplicateMerchantReferenceNumberBlocking)
CardProcessingConfigCommon	enableInterchangeOptimization(Boolean enableInterchangeOptimization)
CardProcessingConfigCommon	enablePartialAuth(Boolean enablePartialAuth)
CardProcessingConfigCommon	enableSplitShipment(Boolean enableSplitShipment)
boolean	equals(Object o)
CardProcessingConfigCommon	foodAndConsumerServiceId(String foodAndConsumerServiceId)
Boolean	getAllowCapturesGreaterThanAuthorizations() Enables this merchant account to capture amounts greater than the authorization amount.
String	getAmexVendorCode() Vendor code assigned by American Express.
String	getBusinessCenterCreditCardRefundLimitPercent() Limits refunds to the percentage set in this field.
String	getCreditCardRefundLimitPercent() Blocks over-refunds when the aggregated refund amount is higher than the percentage set for this field.
CardProcessingConfigCommon.DefaultAuthTypeCodeEnum	getDefaultAuthTypeCode() Authorization Finality indicator.
Boolean	getDomesticMerchantId() This is a local merchant ID used by merchants in addition to the conventional merchant ID.
Boolean	getEnableDuplicateMerchantReferenceNumberBlocking() Helps prevent duplicate transactions.
Boolean	getEnableInterchangeOptimization() Reduces your interchange fees by using automatic authorization refresh and automatic partial authorization reversal.
Boolean	getEnablePartialAuth() Allow merchants to accept partial authorization approvals.
Boolean	getEnableSplitShipment() Enables you to split an order into multiple shipments with multiple captures.
String	getFoodAndConsumerServiceId() Food and Consumer Service ID.
String	getMasterCardAssignedId() MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa.
String	getMerchantCategoryCode() Indicates type of business product or service of the merchant.
CardProcessingConfigCommonMerchantDescriptorInformation	getMerchantDescriptorInformation() Get merchantDescriptorInformation
Boolean	getPreferCobadgedSecondaryBrand() It denotes merchant's preference on secondary brand for routing in case of co-branded cards.
String	getProcessLevel3Data() Indicates whether merchant processes Level 3 transactions.
Map<String,CardProcessingConfigCommonProcessors>	getProcessors() e.g.
String	getSicCode() The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities.
String	getSubMerchantBusinessName() Sub-merchant's business name.
String	getSubMerchantId() The ID assigned to the sub-merchant.
String	getVisaDelegatedAuthenticationId() Identifier provided to merchants who opt for Visa's delegated authorization program.
int	hashCode()
CardProcessingConfigCommon	masterCardAssignedId(String masterCardAssignedId)
CardProcessingConfigCommon	merchantCategoryCode(String merchantCategoryCode)
CardProcessingConfigCommon	merchantDescriptorInformation(CardProcessingConfigCommonMerchantDescriptorInformation merchantDescriptorInformation)
CardProcessingConfigCommon	preferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand)
CardProcessingConfigCommon	processLevel3Data(String processLevel3Data)
CardProcessingConfigCommon	processors(Map<String,CardProcessingConfigCommonProcessors> processors)
CardProcessingConfigCommon	putProcessorsItem(String key, CardProcessingConfigCommonProcessors processorsItem)
void	setAllowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreaterThanAuthorizations)
void	setAmexVendorCode(String amexVendorCode)
void	setBusinessCenterCreditCardRefundLimitPercent(String businessCenterCreditCardRefundLimitPercent)
void	setCreditCardRefundLimitPercent(String creditCardRefundLimitPercent)
void	setDefaultAuthTypeCode(CardProcessingConfigCommon.DefaultAuthTypeCodeEnum defaultAuthTypeCode)
void	setDomesticMerchantId(Boolean domesticMerchantId)
void	setEnableDuplicateMerchantReferenceNumberBlocking(Boolean enableDuplicateMerchantReferenceNumberBlocking)
void	setEnableInterchangeOptimization(Boolean enableInterchangeOptimization)
void	setEnablePartialAuth(Boolean enablePartialAuth)
void	setEnableSplitShipment(Boolean enableSplitShipment)
void	setFoodAndConsumerServiceId(String foodAndConsumerServiceId)
void	setMasterCardAssignedId(String masterCardAssignedId)
void	setMerchantCategoryCode(String merchantCategoryCode)
void	setMerchantDescriptorInformation(CardProcessingConfigCommonMerchantDescriptorInformation merchantDescriptorInformation)
void	setPreferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand)
void	setProcessLevel3Data(String processLevel3Data)
void	setProcessors(Map<String,CardProcessingConfigCommonProcessors> processors)
void	setSicCode(String sicCode)
void	setSubMerchantBusinessName(String subMerchantBusinessName)
void	setSubMerchantId(String subMerchantId)
void	setVisaDelegatedAuthenticationId(String visaDelegatedAuthenticationId)
CardProcessingConfigCommon	sicCode(String sicCode)
CardProcessingConfigCommon	subMerchantBusinessName(String subMerchantBusinessName)
CardProcessingConfigCommon	subMerchantId(String subMerchantId)
String	toString()
CardProcessingConfigCommon	visaDelegatedAuthenticationId(String visaDelegatedAuthenticationId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CardProcessingConfigCommon

public CardProcessingConfigCommon()

Method Detail

processors

public CardProcessingConfigCommon processors(Map<String,CardProcessingConfigCommonProcessors> processors)

putProcessorsItem

public CardProcessingConfigCommon putProcessorsItem(String key,
                                                    CardProcessingConfigCommonProcessors processorsItem)

getProcessors

public Map<String,CardProcessingConfigCommonProcessors> getProcessors()

e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpngsapv3 * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor>

Returns:

processors

setProcessors

public void setProcessors(Map<String,CardProcessingConfigCommonProcessors> processors)

amexVendorCode

public CardProcessingConfigCommon amexVendorCode(String amexVendorCode)

getAmexVendorCode

public String getAmexVendorCode()

Vendor code assigned by American Express. Applicable for TSYS (tsys) processor.

Returns:

amexVendorCode

setAmexVendorCode

public void setAmexVendorCode(String amexVendorCode)

defaultAuthTypeCode

public CardProcessingConfigCommon defaultAuthTypeCode(CardProcessingConfigCommon.DefaultAuthTypeCodeEnum defaultAuthTypeCode)

getDefaultAuthTypeCode

public CardProcessingConfigCommon.DefaultAuthTypeCodeEnum getDefaultAuthTypeCode()

Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version. Applicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>FINAL</td></tr> <tr><td>Barclays HISO</td><td>cnp, cp, hybrid</td><td>Yes</td><td>FINAL</td></tr> </table>

Returns:

defaultAuthTypeCode

setDefaultAuthTypeCode

public void setDefaultAuthTypeCode(CardProcessingConfigCommon.DefaultAuthTypeCodeEnum defaultAuthTypeCode)

masterCardAssignedId

public CardProcessingConfigCommon masterCardAssignedId(String masterCardAssignedId)

getMasterCardAssignedId

public String getMasterCardAssignedId()

MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors.

Returns:

masterCardAssignedId

setMasterCardAssignedId

public void setMasterCardAssignedId(String masterCardAssignedId)

enablePartialAuth

public CardProcessingConfigCommon enablePartialAuth(Boolean enablePartialAuth)

getEnablePartialAuth

public Boolean getEnablePartialAuth()

Allow merchants to accept partial authorization approvals. Applicable for Elavon Americas (elavonamericas), VPC, GPX (gpx), FDI Global (fdiglobal), FDC Nashville (smartfdc), GPN (gpn), TSYS (tsys), American Express Direct (amexdirect), Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>No</td></tr> </table>

Returns:

enablePartialAuth

setEnablePartialAuth

public void setEnablePartialAuth(Boolean enablePartialAuth)

merchantCategoryCode

public CardProcessingConfigCommon merchantCategoryCode(String merchantCategoryCode)

getMerchantCategoryCode

public String getMerchantCategoryCode()

Indicates type of business product or service of the merchant. Applicable for Chase Paymentech Salem (chasepaymentechsalem), FDI Global (fdiglobal), RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect), CMCIC (cmcic), GPX (gpx), VPC, TSYS (tsys), EFTPOS, CUP, Paymentech Tampa (paymentechtampa), CB2A, Barclays (barclays2), Prisma (prisma) and GPN (gpn) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>Barclays</td><td>cnp</td><td>No</td><td>4</td><td>4</td><td>^[0-9]+$</td></tr> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>4</td><td>4</td><td>^[0-9]+$</td></tr> </table>

Returns:

merchantCategoryCode

setMerchantCategoryCode

public void setMerchantCategoryCode(String merchantCategoryCode)

sicCode

public CardProcessingConfigCommon sicCode(String sicCode)

getSicCode

public String getSicCode()

The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors.

Returns:

sicCode

setSicCode

public void setSicCode(String sicCode)

foodAndConsumerServiceId

public CardProcessingConfigCommon foodAndConsumerServiceId(String foodAndConsumerServiceId)

getFoodAndConsumerServiceId

public String getFoodAndConsumerServiceId()

Food and Consumer Service ID. Identifies the merchant as being certified and approved to accept Food Stamps. Applicable for GPX (gpx) processor.

Returns:

foodAndConsumerServiceId

setFoodAndConsumerServiceId

public void setFoodAndConsumerServiceId(String foodAndConsumerServiceId)

enableSplitShipment

public CardProcessingConfigCommon enableSplitShipment(Boolean enableSplitShipment)

getEnableSplitShipment

public Boolean getEnableSplitShipment()

Enables you to split an order into multiple shipments with multiple captures. This feature is provided by CyberSource and supports three different scenarios: * multiple authorizations * multiple captures * multiple authorizations with multiple captures Applicable for VPC processors.

Returns:

enableSplitShipment

setEnableSplitShipment

public void setEnableSplitShipment(Boolean enableSplitShipment)

enableInterchangeOptimization

public CardProcessingConfigCommon enableInterchangeOptimization(Boolean enableInterchangeOptimization)

getEnableInterchangeOptimization

public Boolean getEnableInterchangeOptimization()

Reduces your interchange fees by using automatic authorization refresh and automatic partial authorization reversal. Applicable for VPC processors.

Returns:

enableInterchangeOptimization

setEnableInterchangeOptimization

public void setEnableInterchangeOptimization(Boolean enableInterchangeOptimization)

visaDelegatedAuthenticationId

public CardProcessingConfigCommon visaDelegatedAuthenticationId(String visaDelegatedAuthenticationId)

getVisaDelegatedAuthenticationId

public String getVisaDelegatedAuthenticationId()

Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors.

Returns:

visaDelegatedAuthenticationId

setVisaDelegatedAuthenticationId

public void setVisaDelegatedAuthenticationId(String visaDelegatedAuthenticationId)

creditCardRefundLimitPercent

public CardProcessingConfigCommon creditCardRefundLimitPercent(String creditCardRefundLimitPercent)

getCreditCardRefundLimitPercent

public String getCreditCardRefundLimitPercent()

Blocks over-refunds when the aggregated refund amount is higher than the percentage set for this field. Applicable for GPX (gpx), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors.

Returns:

creditCardRefundLimitPercent

setCreditCardRefundLimitPercent

public void setCreditCardRefundLimitPercent(String creditCardRefundLimitPercent)

businessCenterCreditCardRefundLimitPercent

public CardProcessingConfigCommon businessCenterCreditCardRefundLimitPercent(String businessCenterCreditCardRefundLimitPercent)

getBusinessCenterCreditCardRefundLimitPercent

public String getBusinessCenterCreditCardRefundLimitPercent()

Limits refunds to the percentage set in this field. Applicable for GPX (gpx) and VPC processors.

Returns:

businessCenterCreditCardRefundLimitPercent

setBusinessCenterCreditCardRefundLimitPercent

public void setBusinessCenterCreditCardRefundLimitPercent(String businessCenterCreditCardRefundLimitPercent)

allowCapturesGreaterThanAuthorizations

public CardProcessingConfigCommon allowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreaterThanAuthorizations)

getAllowCapturesGreaterThanAuthorizations

public Boolean getAllowCapturesGreaterThanAuthorizations()

Enables this merchant account to capture amounts greater than the authorization amount. Applicable for GPX (gpx), VPC, Paymentech Tampa (paymentechtampa) and Chase Paymentech Salem (chasepaymentechsalem) processors.

Returns:

allowCapturesGreaterThanAuthorizations

setAllowCapturesGreaterThanAuthorizations

public void setAllowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreaterThanAuthorizations)

enableDuplicateMerchantReferenceNumberBlocking

public CardProcessingConfigCommon enableDuplicateMerchantReferenceNumberBlocking(Boolean enableDuplicateMerchantReferenceNumberBlocking)

getEnableDuplicateMerchantReferenceNumberBlocking

public Boolean getEnableDuplicateMerchantReferenceNumberBlocking()

Helps prevent duplicate transactions. Applicable for VPC, GPX (gpx) and Chase Paymentech Salem (chasepaymentechsalem) processors.

Returns:

enableDuplicateMerchantReferenceNumberBlocking

setEnableDuplicateMerchantReferenceNumberBlocking

public void setEnableDuplicateMerchantReferenceNumberBlocking(Boolean enableDuplicateMerchantReferenceNumberBlocking)

domesticMerchantId

public CardProcessingConfigCommon domesticMerchantId(Boolean domesticMerchantId)

getDomesticMerchantId

public Boolean getDomesticMerchantId()

This is a local merchant ID used by merchants in addition to the conventional merchant ID. This value is sent to the issuer. Applicable for VPC and Prisma (prisma) processors.

Returns:

domesticMerchantId

setDomesticMerchantId

public void setDomesticMerchantId(Boolean domesticMerchantId)

processLevel3Data

public CardProcessingConfigCommon processLevel3Data(String processLevel3Data)

getProcessLevel3Data

public String getProcessLevel3Data()

Indicates whether merchant processes Level 3 transactions. Applicable for TSYS (tsys), Barclays (barclays2), Paymentech Tampa (paymentechtampa), FDI Global (fdiglobal), Elavon Americas (elavonamericas) and Chase Paymentech Salem (chasepaymentechsalem) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th></tr></thead> <tr><td>Barclays</td><td>cnp</td><td>No</td></tr> </table>

Returns:

processLevel3Data

setProcessLevel3Data

public void setProcessLevel3Data(String processLevel3Data)

subMerchantId

public CardProcessingConfigCommon subMerchantId(String subMerchantId)

getSubMerchantId

public String getSubMerchantId()

The ID assigned to the sub-merchant. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>20</td><td>^[0-9a-zA-Z&#92;-&#92;_&#92;,\\s.]+$</td></tr> </table>

Returns:

subMerchantId

setSubMerchantId

public void setSubMerchantId(String subMerchantId)

subMerchantBusinessName

public CardProcessingConfigCommon subMerchantBusinessName(String subMerchantBusinessName)

getSubMerchantBusinessName

public String getSubMerchantBusinessName()

Sub-merchant's business name. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>37</td><td>^[0-9a-zA-Z&#92;-&#92;_&#92;,\\s.]+$</td></tr> </table>

Returns:

subMerchantBusinessName

setSubMerchantBusinessName

public void setSubMerchantBusinessName(String subMerchantBusinessName)

preferCobadgedSecondaryBrand

public CardProcessingConfigCommon preferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand)

getPreferCobadgedSecondaryBrand

public Boolean getPreferCobadgedSecondaryBrand()

It denotes merchant's preference on secondary brand for routing in case of co-branded cards. Applicable for EFTPOS processors.

Returns:

preferCobadgedSecondaryBrand

setPreferCobadgedSecondaryBrand

public void setPreferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand)

merchantDescriptorInformation

public CardProcessingConfigCommon merchantDescriptorInformation(CardProcessingConfigCommonMerchantDescriptorInformation merchantDescriptorInformation)

getMerchantDescriptorInformation

public CardProcessingConfigCommonMerchantDescriptorInformation getMerchantDescriptorInformation()

Get merchantDescriptorInformation

Returns:

merchantDescriptorInformation

setMerchantDescriptorInformation

public void setMerchantDescriptorInformation(CardProcessingConfigCommonMerchantDescriptorInformation merchantDescriptorInformation)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object