merchantInformation

The following fields provide merchant information.

merchantInformation. cancelUrl

URL the customer is redirected to after cancelling a payment.

Make a GET request to this URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
merchantInformation.cancelUrl

SCMP API Field:
ap_initiate_cancel_url

Simple Order API Field:
apInitiateService_cancelURL

merchantInformation. cardAcceptorReferenceNumber

Reference number that facilitates card acceptor/corporation communication and record keeping.

This field is available only on the
Visa Platform Connect
processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

merchantInformation.cardAcceptorReferenceNumber

SCMP API Field:

card_acceptor_ref_number

Simple Order API Field:

invoiceHeader_cardAcceptorRefNumber

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: cardAcceptorRefNumber

merchantInformation. categoryCode

Four-digit number that the payment card industry uses to classify merchants into market segments.

A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards.

When you do not include this field in a request, the value in your account is used.

Chase Paymentech Solutions: This field is optional for Mastercard or Visa card transactions that use the Payouts services.
Note:
For a different combination of services, processors, or conditions, this field might be a required field.
Visa Platform Connect: This field is optional for aggregator transactions using Mastercard or Visa cards with the Payouts services.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR4

Position: 150-153

Field: Merchant Category Code

Specifications

Data Type:
Integer

Data Length:
4

Mapping Information

REST API Field:

merchantInformation.categoryCode

SCMP API Field:

merchant_category_code

Simple Order API Field:

merchantCategoryCode

merchantInformation. categoryCodeDomestic

Merchant category code for domestic transactions.

This field is available only on the Chase Paymentech Solutions, OmniPay Direct, and Visa Platform Connectprocessors.

The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees.

Visa Platform Connect: This field is available only for domestic transactions with Visa or Mastercard in Spain. Domestic means that you and the customer are in the same country.

When you include this field in a Visa request, you must also include the
merchantInformation.categoryCode
field.

When you include this field in a Mastercard request, including the
merchantInformation.categoryCode
field is optional.
Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions. It is optional for Mastercard and Visa transactions.
OmniPay Direct: Do not include the
merchantInformation.categoryCode
field. The value for this field overrides the value in your account.

This field is available only for:

Domestic transactions with Mastercard in Spain. Domestic means that you and the customer are in the same country.

Merchants enrolled in the OmniPay Direct interchange program.

First Data Merchant Solutions (Europe) on OmniPay Direct.

Specifications

Data Type:
Integer

Length:
4

Mapping Information

REST API Field:

merchantInformation.categoryCodeDomestic

SCMP API Field:

merchant_category_code_domestic

Simple Order API Field:

merchantCategoryCodeDomestic

merchantInformation. failureUrl

URL the customer is redirected to after a payment fails.

Make a GET request to this URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
merchantInformation.failureUrl

SCMP API Field:
ap_initiate_failure_url

Simple Order API Field:
apInitiateService_failureURL

merchantInformation. merchantDescriptor.address1

Street address for your business location.

This field is available on the Barclays and Visa Platform Connect processors.

Specify the value in US English characters. The address might appear on the cardholder’s statement.

IMPORTANT

This field might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

When you include this value in your request, Cybersource recommends that you also include these fields in the request:

merchantInformation.merchantDescriptor.country

(merchant descriptor country)

merchantInformation.merchantDescriptor.administrativeArea

(merchant descriptor state)

merchantInformation.merchantDescriptor.postalCode

(merchant descriptor postal code)

Visa Platform Connect: With Mastercard payment cards, the value for this field corresponds to this data in the TC 33 capture file:

Record: CP12 TCR2

Position: 35–82

Field: Acceptor Street Address

Specifications

Data Type:
String

Data Length

Barclays: 55

Visa Platform Connect: 29

IMPORTANT

If the value exceeds 29 characters, excess data is truncated before it is sent to Visa.

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.address1

SCMP API Field:

merchant_descriptor_street

Simple Order API Field:

invoiceHeader_merchantDescriptorStreet

merchantInformation. merchantDescriptor.administrativeArea

State code or region code for your business location.

Use the standard state, province, and territory codes for the US and Canada.

See State, Province, and Territory Codes for the United States and Canada.

This field is available only for businesses located in the US or Canada.

This value must consist of English characters.

This value might be displayed on the cardholder’s statement.

IMPORTANT

This value might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

When you do not include this value in your PIN debit request, the merchant state or province from your account is used.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.administrativeArea

SCMP API Field:

merchant_descriptor_state

Simple Order API Field:

invoiceHeader_merchantDescriptorState

merchantInformation. merchantDescriptor.alternateName

Alternate contact information for your business, such as an email address or URL.

This value might appear on the cardholder's statement.

For authorizations, this value is not sent to the processor. Instead, this value is stored and sent to the processor for captures and follow-on credits.

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.alternateName

SCMP API Field:

merchant_descriptor_alternate

Simple Order API Field:

invoiceHeader_merchantDescriptorAlternate

merchantInformation. merchantDescriptor.contact

Contact information for your business.

This value must be the name of the city in which your store or outlet is located.

When you include more than one consecutive space, extra spaces are removed.

This value might be displayed on the cardholder’s statement.

IMPORTANT

This value might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

Payouts: For Chase Paymentech Solutions, you must use one of the following formats:

PCCCCCCCCCCCC

NNN-NNN-NNNN

NNN-NNN-NAAA

NNN-NNN-AAAA

NNN-AAAAAAA

Each character in the format represents the following formatting:

A: Alphanumeric (alphabetical or numeric)

C: Character (alphabetical or blank)

N: Numeric

P: Alphabetical
Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR4; Position: 5–30; Field: Acceptor Phone Number

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.contact

SCMP API Field:

merchant_descriptor_contact

Simple Order API Field:

invoiceHeader_merchantDescriptorContact

merchantInformation. merchantDescriptor. country

Country code for your business location.

Use the two-character ISO country code.

See ISO Standard Country Codes

When you do not include this value in your request, Cybersource uses the merchant country from your account.

This value must consist of English characters.

This value might be displayed on the cardholder’s statement.

IMPORTANT

Your acquiring bank might ignore this value. Contact your acquiring bank for more information about overriding your default merchant descriptor.

If your business is located in the US or Canada, and you include this field in a request, you must also include the

merchantInformation.merchantDescriptor.administrativeArea

field.

This field is required for a Payouts original credit transaction (OCT) service request that specifies a deferred OCT processing date and time. See the

processingInformation.payoutOptions.deferredDateTime

field.

To support Visa Direct transactions in OCTs destined for issuers in Australia or Canada, you must include additional merchant address data in the authorization request:

Field 43—Card Acceptor Name/Location

Field 59—National Point-of-Service Geographical Data

Field 104, Usage 2—Transaction-Specific Data in TLV format; Dataset ID 56—Additional Acceptance Information; Tag 81—Acceptor Legal Business Name

To process Faster Refund OCTs in Asia Pacific and Europe, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Barclays: For marketplace transactions, include this field and the
aggregatorInformation.subMerchant.country
field in the transaction request. The marketplace is the merchant, and the retailer is the sub‑merchant. When the field values do not match, the transaction is identified as a foreign retail transaction to the acquirer and the merchant can verify them in the Business Center on the transactions details page.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.country

SCMP API Fields:

merchant_descriptor_country

pa_merchant_country_code

Simple Order API Fields:

invoiceHeader_merchantDescriptorCountry

payerAuthEnrollService_merchantCountrycode

merchantInformation. merchantDescriptor.countryOfOrigin

Country of origin for your business.

Use the two-character ISO country code.

See ISO Standard Country Codes

IMPORTANT

This value must consist of English characters.

This field is available only for Mastercard on the FDC Nashville Global and Visa Platform Connect processors.

If you are a government-controlled merchant, ensure your Cybersource account is enabled as a government-controlled merchant with the attribute

CFG : _governmentControlled

. You must include this field in authorization requests or ensure that your Cybersource account includes the correct two-character ISO country code.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.countryOfOrigin

SCMP API Field:

merchant_descriptor_countryoforigin

Simple Order API Field:

invoiceHeader_merchantDescriptorCountryOfOrigin

merchantInformation. merchantDescriptor.county

County for your business location.

This field is available only on the Barclays processor.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.county

SCMP API Field: No corresponding field.

Simple Order API Field:

invoiceHeader_merchantDescriptorCounty

merchantInformation. merchantDescriptor.customerServicePhoneNumber

Customer service phone number for merchant.

Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR2; Position: 92–107; Field: Acceptor Street Address

Specifications

Data Type:
String

Data Length:
27

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.customerServicePhoneNumber

SCMP API Field:

merchant_descriptor_customer_service_phone_number

Simple Order API Field:

invoiceHeader_merchantDescriptorCustomerServicePhoneNumber

merchantInformation. merchantDescriptor.locality

City for your business location.

This value might be displayed on the cardholder’s statement, and it must consist of US English characters.

IMPORTANT

This value might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

If you do not include this value in your PIN debit request, Cybersource uses the merchant city from your account.

For an original credit transaction (OCT), the only supported value is

Visa Direct

This field is available on the Barclays, FDC Compass, and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length

Barclays: 35

FDC Compass: 13

: 13

Visa Platform Connect: 13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.locality

SCMP API Field:

merchant_descriptor_city

Simple Order API Field:

invoiceHeader_merchantDescriptorCity

merchantInformation. merchantDescriptor.name

Merchant business name.

This field should be the
Doing Business As
name or the 1 to 4 digit abbreviation of the merchant name, and be the most recognizable name by the cardholder.

Specify the value in US English characters. The merchant business name is displayed on the cardholder’s statement. If the field contains more than one consecutive space, the extra spaces are removed.

If you use this field with Payer Authentication, the name that is specified in this field overrides the value that is specified by the merchant bank and that appears to the customer in the issuing bank's authentication form.

IMPORTANT

This value might be ignored by your acquiring bank. For more information about overriding your default merchant descriptor, contact your acquiring bank.

This field is available only on the Barclays, Chase Paymentech Solutions, FDC Compass, FDC Nashville Global, and Visa Platform Connect processors.

These processors have specific requirements:

Chase Paymentech Solutions: When using this field for Payouts, use one of these formats:

<12-character merchant name>*<9-character product description>

<7-character merchant name>*<14-character product description>

<3-character merchant name>*<18-character product description>
FDC Compass and Visa Platform Connect: When using this field for Payouts, set it as follows:

For a credit card bill payment, set the value for this field to the name of the originator providing the credit card bill payment service.

For a funds disbursement, set the value for this field to the name of the originator sending the funds disbursement.

For a prepaid load, set the value for this field to the name of the partner providing the reload service.
FDC Nashville Global: If you do not include this field in a PIN Debit request, Cybersource uses the merchant name in your account.

Specifications

Data Type:
String

Data Length

Barclays: 21

Chase Paymentech Solutions: 25

FDC Compass: 25

FDC Nashville Global: 25

Visa Platform Connect: 25

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.name

SCMP API Fields:

merchant_descriptor

pa_merchant_name

Simple Order API Fields:

invoiceHeader_merchantDescriptor

The

invoiceHeader_merchantDescriptor

field is available only for authorizations on the Barclays processor.

payerAuthEnrollService_merchantName

merchantInformation. merchantDescriptor. phone

Merchant phone number.

This number is primarily used to provide a means of contact when customer make card-not-present transactions, for example online purchases.

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.phone

Simple Order API Field:

No Corresponding Field.

merchantInformation. merchantDescriptor. postalCode

Postal code for your business location.

IMPORTANT

Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your Cybersource account or you can include this field in your request.

This value might be displayed on the cardholder’s statement.

IMPORTANT

This value may be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

If your business is located in the US, you can use a five-digit or nine-digit postal code. A nine-digit postal code must follow this format: [5 digits][dash][4 digits]

Example:
12345-6789

If your business is located in Canada, use a six-character postal code. A six-character postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric]

Example:
A1B 2C3

When you do not include this value in a PIN debit request, the merchant postal code from your account is used.

This field is required for a Payouts original credit transaction (OCT) service request that specifies a deferred OCT processing date and time. See the

REST

processingInformation. payoutOptions. deferredDateTime

API field.

To support Visa Direct transactions in Original Credit Transactions destined to issuers in Australia or Canada, you must include additional merchant address data in the authorization request:

Field 43—Card Acceptor Name/Location

Field 59—National Point-of-Service Geographical Data

Field 104, Usage 2—Transaction-Specific Data in TLV format, Dataset ID 56—Additional Acceptance Information, Tag 81—Acceptor Legal Business Name

To process Faster Refund Original Credit Transactions (OCTs) in AP and the EU, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.postalCode

SCMP API Field:

merchant_descriptor_postal_code

Simple Order API Field:

invoiceHeader_merchantDescriptorPostalCode

merchantInformation. merchantDescriptor.url

Address of your company’s website, for example,

http://www.example.com.

This value overrides the value specified by your merchant bank.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.url

SCMP API Field:

pa_merchant_url

Simple Order API Field:

payerAuthEnrollService_merchantURL

merchantInformation. merchantDomainName

URL or reverse domain name for your business.

This field is available only for Mastercard digital secure remote payment (DSRP) transactions on the FDC Compass and Visa Platform Connect processors.

Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR3; Position: 5–168; Field: Acceptor Street Address

Specifications

Data Type:
String

Data Length:
127

Special Symbols Allowed:

Forward slash (/)

Colon(:)

Period (.)

Mapping Information

REST API Field:

merchantInformation.merchantDomainName

SCMP API Field:

merchant_domain_name

Simple Order API Field:

merchantDomainName

merchantInformation. partnerId

Partner ID used for either co-branding agreement or promotional discounts.

Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR4; Position: 56–63; Field: Acceptor Partner ID Code

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

merchantInformation.partnerId

SCMP API Field:

merchant_partneridcode

Simple Order API Field:

invoiceHeader_merchantDescriptorPartnerIdCode

merchantInformation. returnUrl

URL of the web page to which the customer is directed when the transaction is completed.

This URL overrides the return URL that was specified during merchant boarding.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

merchantInformation.returnUrl

SCMP API Field:

ap_initiate_return_url

Simple Order API Field:

apInitiateService_returnURL

merchantInformation. salesOrganizationId

Company ID assigned to an independent sales organization.

This field is available only for the Visa Platform Connect, Rede, and Software Express processors.

This field is available only for aggregator transactions. Get the value for this field from the payment card company.

Visa Platform Connect:
This field is required in an authorization request message for Discover transactions.

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Local date and time at your physical location.

Include both the date and time in this field or leave it blank.

Format:
yyyyMMDDhhmmss

MM = month

yyyy = year

DD = day

hh = hour

mm = minutes

ss = seconds

Card-Present Transactions on the
Visa Platform Connect
Processor: In Argentina, you must either include this field in the request, or your account must include a time zone:

When you do not include this field, the value for this field is generated based on the time zone recorded in your account.

When you do not include this field, and no time zone is recorded in your account, the value for this field is generated based on GMT when the request is received.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 16-21

Field: Local Date

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

merchantInformation.transactionLocalDateTime

SCMP API Field:

transaction_local_date_time

Simple Order API Fields:

ccIncrementalAuthService_transactionLocalDateTime

transactionLocalDateTime

merchantInformation. transactionLocalDateTime

The local time of when a transaction is processed.

The value must follow the ISO 8601 UTC format.

Format:

YYYYMMddTHHmmssZ

Example:

20151103T123456Z

Specifications

Data Type:
String

Data Length:
16

Mapping

REST Field Name:

merchantInformation.transactionLocalDateTime

Simple Order Field Name:

RequestMessage_transactionLocalDateTime

merchantInformation. vatRegistrationNumber

Value-added tax identification number.

This field applies only when you include one or more VAT seller registration numbers in the request. The VAT seller registration number might be required for some Canadian transactions.

This field is available on the Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, GPN, OmniPay Direct, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

Data Length

Barclays: 13

Chase Paymentech Solutions: 13 (Payouts transactions)

Elavon Americas: 20

FDC Compass: 13 (Payouts transactions)

GPN: 20

OmniPay Direct: 21

RBS WorldPay Atlanta: 20

TSYS Acquiring Solutions: 20

Visa Platform Connect: 13 (Payouts transactions), 20 (other transactions)

Worldpay VAP: 20

Mapping Information

REST API Field:

merchantInformation.vatRegistrationNumber

SCMP API Fields:

merchant_vat_registration_number

seller_registration

Simple Order API Fields:

invoiceHeader_merchantVATRegistrationNumber

item_#_sellerRegistration

taxService_sellerRegistration