field_specs

Home > Merchant Management Service Field Specifications

Merchant Management Service Field Specifications

N = Numeric

AN = Alphanumeric

OBJECT = XML object containing multiple fields

Table 5Service Request Object
Field Name	Field Description	Field Length/ Data Type	Required/Optional
organizationId	OrganizationId / ResellerId as assigned by CyberSource for the portfolio	AN	Required
boardingRequestId	Unique request Id	8-36AN	Required -- unique identifier for the service request.
boardMerchant (List)	See definition below	Enterprise MerchantType OBJECT (extends MerchantType OBJECT)	Required -- at least one board merchant or update merchant request is required.
updateMerchant (List)	See definition below	Enterprise MerchantType OBJECT (extends MerchantType OBJECT)	Optional -- at least one board merchant or update merchant is required.

Table 6MerchantType Object
Field Name	Field Description	Field Length/ Data Type	Required/Optional
merchantIdentifier	Merchant Identifier	Merchant IdentifierType OBJECT	Required
merchantStatus Information		MerchantStatus InfoType OBJECT	Not Required for Board Merchant Request. Required for Update Merchant Request if the update is to change status to Live.
merchantStatus	Merchant Status information: nINACTIVE nLIVE nTEST	String	Not Required for Board Merchant Request. Optional for Update Merchant request.
merchantInformation	Merchant Information	merchantInfo Type OBJECT	Required for Board Merchant request.
businessContact	Merchant Business Contact	contactType OBJECT	Required- All merchant notification emails are sent to the merchant business contact email address. Optional for Update Merchant request.
technicalContact	Merchant Technical Contact	contactType OBJECT	Optional - Business Contact will be used, if not provided.
emergencyContact	Merchant Emergency Contact	contactType OBJECT	Optional - Business Contact will be used, if not provided.
skipProcessor	Must be 'true' if processorInformation is not provided.	true/false	Required if processor Information is not provided.
processorInformation	Processor Information required for boarding Merchant	abstract ProcessorInfo Type OBJECT	Required if skipProcessor is 'false' or if skipProcessor is not present
List <products>	Product Profile - Virtual Terminal	productType Object	Optional - Currently we support Product Profile for Virtual Terminal and Secure Acceptance.
merchantType	INTERNAL	OBJECT	Not required for portfolios.

Table 7MerchantIdentifierType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
merchantId	Merchant Identifier	6-30AN	Required
organizationId	Organization ID. This field is assigned to the Portfolio by CyberSource.		Optional. This information is sent in the Service request.

Table 8MerchantStatusInfoType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
merchantStatus	Status of the merchant to be updated: nINACTIVE nLIVE nTEST	String	Optional - This Object will be required if the request is to update the merchant status. Merchant Status to be updated - TEST to LIVE; or LIVE to INACTIVE; or INACTIVE to LIVE.
passphrase	Merchant passphrase.	7-32AN	Optional - This information will be required if the request is to update merchant status to LIVE.

Table 9MerchantInfoType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
name	Merchant Name	25AN	Required. In addition to alphanumeric characters, the following special characters are allowed: space _ + . - * " / ' & , ( ) ! $ ; : ? @ #
address	Merchant Address Information	addressType OBJECT	Required
emailAddress	Merchant Email Address	30AN	Optional
phone	Merchant Phone	14AN	Required -Phone is allowed for 13 digits, can also accept plus (+) for international along with 13 digits.
Time Zone	Merchant Time Zone	Enumeration	Optional
websiteUrl	Merchant Web Site URL	100AN	Optional
ssn	The owner's social security number.	9-11N	Not required for portfolios. Hyphen (-) allowed.
taxId	Merchant Tax ID Number	9-11N	Not required for portfolios. Hyphen (-) allowed.
standardIndustry Code	Standard Industry Code (SIC) associated with the merchant's business.	3-4N	Not required for portfolios.
productsSold	The type of products the merchant's business sells.	1-256AN	Not required for portfolios.
businessType	Merchant business type: nSOLE_PROPRIETORSHIP nPARTNERSHIP nCORPORATION nNON_PROFIT nTRUST	String	Not required for portfolios.
marketType	The primary market the business sells through: nECOMMERCE nMOTO nRETAIL	String	Not required for portfolios.
ageOfBusiness	Age Of business	ageType OBJECT	Not required for portfolios.
businessOwnership	Ownership of business	businessOwnership OBJECT	Not required for portfolios.

Table 10ContactType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
firstName	Contact First Name	50AN	Optional (Business Contact is used)
lastName	Contact Last Name	50AN	Optional (Business Contact is used)
emailAddress	Contact Email	50AN	Optional (Business Contact is used)
Phone	Contact Phone	14AN	Optional (Business Contact is used). Phone is allowed for 13 digits, can also accept plus (+) for international along with 13 digits.

Table 11abstractProcessorInfoType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
processorName	Name of the Processor that is being used by the Portfolio / Organization. This is provided by CyberSource.	AN	Required

Table 12processorInfoType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
processorAttributes	Processor Attributes	processorAttributeType Object	Required
paymentAcceptance	Payment Acceptance - MIDS and TIDS	paymentAcceptance Type Object	Required

Table 13processorAttributeType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
acquirerCountryCode	Code that identifies the country of the acquiring institution for the merchant. This field is used in all messages related to a customer transaction. The value used in the original transaction must be used in any subsequent messages, including responses.	3N	Required
acquirerFileDestinationBin	BIN (Bank Identification Number) to which the capture file is sent.	6N	Required
acquirerIca	MasterCard assigned BIN for the acquirer.	6N	Optional
acquiringInstitutionId	BIN of the merchant's acquiring financial institution.	11N (Visa assigned BIN values are 6N in length. The maximum length supported by the spec is 11)	Required
acquiringDiscover InstitutionId	Acquiring Discover Institution ID	11N (Visa assigned BIN values are 6N in length. The maximum length supported by the spec is 11)	Optional - Required for a few processors when Discover Card is selected.
categoryCode	Four-digit code that indicates merchant's type of product or service.	4N	Required
standardIndustryCode	Four-digit code that indicates merchant's type of product or service.	4N	Optional
directConnectProgram	Direct Connect Program	AN	Optional (default->02_DC)
batchGroup	Defines the transaction cutoff time and batch file delivery time for processing batch payment files for payment gateways.	AN	Optional- The batch group value will be provided by CyberSource.
airlineDataEnabled	When enabled, allows merchant to accept airline data in transactions.	Enabled/Disabled/Ignored	Optional
quasiCashEnabled	When enabled, allows merchant to process quasi-cash transactions.	true/false	Optional
partialAuthEnabled	When enabled, allows merchant to send partial authorization transactions.	true/false	Optional
interchangeOptimization Enabled	When enabled, ensures the best rate possible for the merchant's transactions.	true/false	Optional
verificationValue	Ten-digit number that identifies merchant participating in Select Merchant Fee (SMF) programs. This number is unique to each merchant.	10N	Optional
splitShipmentEnabled	When enabled, allows merchant to split an order into multiple shipments with multiple captures.	true/false	Optional
transactionRefNumber Enabled	Transaction Reference Number required for transactions	true/false	Optional
masterCardAssignedID	MasterCard Assigned ID	6N	Required if MasterCard is one of the payment methods.

Table 14paymentAcceptanceType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
processorMerchantId	Processor MID Information	processor MerchantIdType Object	Required
processorTerminalId	Payment Acceptance - MIDS and TIDS	processor TerminalIdType Object	Required

Table 15processorMerchantIdType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
paymentType	Payment card types supported by CyberSource Through VisaNet Processors - VISA, MasterCard, JCB, Discover, American Express, Diners Club.	N	Required
currencyCode	Currency code combination with paymentType	N	Required
processorValue	Processor Merchant IDs	15 AN	Required

Table 16processorTerminalIdType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
paymentType	Payment card types supported by CyberSource Through VisaNet Processors -VISA, MasterCard, JCB, Discover, American Express, and Diners Club.	N	Required
currencyCode	Currency code combination with paymentType	N	Required
processorValue	Processor Terminal IDs	8 AN	Required

Table 17productType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
type	Product Type	N	Required - Currently, it is Virtual_Terminal.
profileId	Profile ID that was registered with UMP application.	AN	Required
profileName	Profile Name	5-100 AN	Required
profileDescription	Profile Description	5-250 AN	Required

Table 18addressType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
addressLine1	First line of merchant street address.	60AN	Required
addressLine2	Second line of merchant street address.	60AN	Optional
City	Merchant City	25AN	Required
State/Province	Merchant State or Province	AN	Conditional (required for USA and CA)
postalOrZipCode	Merchant Postal or Zip code	14AN	Conditional (required for USA and CA)
Country	Merchant Country	N	Required

Table 19ageType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
years	Number of years that the business has been in operation.	N (Whole numbers, no decimals, between 0 and 255)	Not required for portfolios.
months	Number of months that the business has been in operation.	N (Whole numbers, no decimals, between 1 and 12)	Not required for portfolios.

Table 20BusinessOwnershipType Object
Field Name	Field Description	Field Length/Data Type	Required/Optional
ownerName	Business owner name	40AN	Not required for portfolios.
ownerJobTitle	Business owner job title	40AN	Not required for portfolios.

Merchant Management Service Developer Guide, October 2019