aggregatorInformation

The following fields are related to aggregators.

aggregatorInformation. aggregatorId

Value that identifies you as a payment aggregator.
Get this value from the processor.
FDC Compass
This value must consist of uppercase letters.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not available for standard credit card transactions.
This field is optional in a request for an AFT with aggregator support an OCT with aggregator support.
Visa Platform Connect
This field is required for
Payouts
 transactions making OCT requests from merchants that are payment facilitators using
Visa Platform Connect
.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR6
  • Position: 95-105
  • Field: Market Identifier / Payment Facilitator ID
Visa Platform Connect
This field is required in an authorization request message for Visa, Mastercard, and Discover transactions.

Specifications

  • Data Type:
     String
  • Data Length:
    • Chase Paymentech Solutions
      :
      204
    • Cielo
      :
      11
    • FDC Nashville Global
      :
      15
    • Getnet
      :
      11
    • Rede
      :
      11
    • Visa Platform Connect
      :
      American Express: 20, Mastercard and Visa: 11
    • All other processors:
      20

Mapping Information

  • REST API Field:
    aggregatorInformation.aggregatorId
  • SCMP API Field:
    aggregator_id
  • Simple Order API Fields:
    • ccAuthService_aggregatorID
    • ccCaptureService_aggregatorID
    • ccCreditService_aggregatorID
    • octService_aggregatorID
       (for
      Chase Paymentech Solutions
      )

aggregatorInformation. city

The city name of the payment facilitator.
This field is applicable to the Visa card type.

Specifications

  • Data Type:
     String
  • Data Length:
     50

Mapping Information

  • REST API Field:
    aggregatorInformation.city
  • SCMP API Field:
    aggregator_city
  • Simple Order API Fields:
    • ccAuthService_aggregatorCity
    • octService_aggregatorCity

aggregatorInformation. country

The country of the payment facilitator.
This field is applicable to the Visa card type.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    aggregatorInformation.country
  • SCMP API Field:
    aggregator_country
  • Simple Order API Fields:
    • ccAuthService_aggregatorCountry
    • octService_aggregatorCountry

aggregatorInformation. name

Payment aggregator business name.
Chase Paymentech Solutions
This field is available only for Payouts transactions only. It is not available for standard credit card transactions. It is optional for Mastercard and Visa transactions.
FDC Compass
This value must consist of uppercase letters.
Getnet
This value must consist of uppercase letters. Special characters are not allowed.
Visa Platform Connect
The value for this field does not map to the TC 33 capture file.
Payouts
 OCT
:
Required in OCT requests from merchants that are payment facilitators using the
Visa Platform Connect
 processor.

Specifications

  • Data Type:
     String
  • Data Length
    • American Express Direct
      : Maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 37 characters.
    • Chase Paymentech Solutions
      : 22 for Mastercard, 25 for Visa
    • FDC Compass
      : Maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 37 characters.
    • FDC Nashville Global
      : 12
    • Getnet
      : 7
    • : 25
    • Software Express
      : 37
    • Visa Platform Connect
      : 25

Mapping Information

  • REST API Field:
    aggregatorInformation.name
  • SCMP API Field:
    aggregator_name
  • Simple Order API Fields:
    • ccAuthService_aggregatorName
    • ccCaptureService_aggregatorName
    • ccCreditService_aggregatorName
    • octService_aggregatorName

aggregatorInformation. postalCode

The postal code of the payment facilitator.
This field is applicable to the Visa card type.

Specifications

  • Data Type:
     String
  • Data Length:
     10

Mapping Information

  • REST API Field:
    aggregatorInformation.postalCode
  • SCMP API Field:
    aggregator_postalCode
  • Simple Order API Fields:
    • ccAuthService_aggregatorPostalcode
    • octService_aggregatorPostalcode

aggregatorInformation. serviceProvidername

Name of the transfer service provider.
This field is available only on the
Visa Platform Connect
 processor.
With Mastercard payment cards, the value for this field corresponds to this data in the TC 33 capture file:
  • Records: CP12 TCR2, TCR3, TCR4
  • Field: Gateway Data
This field is required for
Payouts
 original credit transaction (OCT) service requests from these types of merchants:
  • Merchants who are payment facilitators.
  • Merchants who want OCT processing to be deferred to a specified date and time.
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:
     25

Mapping Information

  • REST API Field:
    aggregatorInformation.serviceProvidername
  • SCMP API Field:
    service_provider_name
  • Simple Order API Field:
    octService_serviceProviderName

aggregatorInformation. state

The state or providence of the payment facilitator.
This field is applicable to the Visa card type.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    aggregatorInformation.state
  • SCMP API Field:
    aggregator_state
  • Simple Order API Fields:
    • ccAuthService_aggregatorState
    • octService_aggregatorState

aggregatorInformation. streetAddress

The street address of the payment facilitator.
This field is applicable to the Visa card type.

Specifications

  • Data Type:
     String
  • Data Length:
     99

Mapping Information

  • REST API Field:
    aggregatorInformation.streetAddress
  • SCMP API Field:
    aggregator_streetAddress
  • Simple Order API Fields:
    • ccAuthService_aggregatorStreetAddress
    • octService_aggregatorStreetAddress

aggregatorInformation. subMerchant.address1

The first line of the street address of the submerchant associated with the aggregator.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of uppercase letters.
Getnet
Allowable characters are letters, numbers, and spaces. Special characters are not allowed.
Visa Platform Connect
The value for this field does not map to the TC 33 capture file.

Specifications

  • Data Type:
     String
  • Data Length:
    • American Express Direct
      :
       29
    • Chase Paymentech Solutions
      :
       38
    • Cielo
      :
       22
    • FDC Compass
      :
       38
    • FDC Nashville Global
      :
       25
    • Getnet
      :
       40—When length is greater than 40, characters to the right of the 40th character are discarded.
    • :
       29
    • Rede
      :
       48
    • Software Express
      :
       38
    • Visa Platform Connect
      :
       29

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.address1
  • SCMP API Field:
    submerchant_street
  • Simple Order API Field:
    invoiceHeader_submerchantStreet

aggregatorInformation. subMerchant.administrativeArea

Sub-merchant’s state or province.
Use a state, province, or territory code.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of uppercase characters.
Getnet
All characters must be uppercase letters. Special characters are not allowed.
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR4
  • Position: 164-166
  • Field: Region Code

Specifications

  • Data Type:
     String
  • Data Length:
    • Getnet
      :
      2—When length is greater than 2, characters to the right of the 2nd character are discarded.
    • All other processors:
       3

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.administrativeArea
  • SCMP API Field:
    submerchant_state
  • Simple Order API Field:
    invoiceHeader_submerchantState

aggregatorInformation. subMerchant.cardAcceptorId

Unique identifier assigned by the payment card company to the sub-merchant.
FDC Nashville Global
This field is available only for aggregator authorizations with American Express.

Specifications

  • Data Type:
     String
  • Data Length:
     15

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.cardAcceptorId
  • SCMP API Field:
    submerchant_merchant_id
  • Simple Order API Field:
    invoiceHeader_submerchantMerchantID

aggregatorInformation. subMerchant.country

Sub-merchant’s country.
Use the two-character ISO country code.
Barclays
For marketplace transactions, include this field and the
merchantInformation.merchantDescriptor.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.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of only uppercase letters.
Visa Platform Connect
The value for this field does not map to the TC 33 capture file.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.country
  • SCMP API Field:
    submerchant_country
  • Simple Order API Field:
    invoiceHeader_submerchantCountry

aggregatorInformation. subMerchant.email

Sub-merchant's email address.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
Visa Platform Connect
With American Express, the value of this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCRB
  • Position: 25-64
  • Field: American Express Seller Email Address

Specifications

  • Data Type:
     String
  • Data Length:
    • FDC Nashville Global
      :
       19
    • All other processors:
       40

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.email
  • SCMP API Field:
    submerchant_email
  • Simple Order API Field:
    invoiceHeader_submerchantEmail

aggregatorInformation. subMerchant.id

ID that you assigned to the sub-merchant.
FDC Compass
This value must consist of uppercase letters.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
Visa Platform Connect
This field is required for the
Payouts
 OCT service requests from merchants that are payment facilitators using
Visa Platform Connect
.
With American Express, the value of this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCRB
  • Position: 65-84
  • Field: American Express Seller ID
With Mastercard and Visa, the value of this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR6
  • Position: 117-131
  • Field: Sub-Merchant ID
Visa Platform Connect
This field is required in an authorization request message for Discover transactions.

Specifications

  • Data Type:
     String
  • Data Length:
    • Cielo
      : 15
    • FDC Nashville Global
      : 14
    • Getnet
      : 15
    • Rede
      : 15
    • Visa Platform Connect
      : American Express: 20, Mastercard and Visa: 15
    • All other processors: 20

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.id
  • SCMP API Field:
    submerchant_id
  • Simple Order API Field:
    invoiceHeader_submerchantID

aggregatorInformation. subMerchant.locality

Sub-merchant’s city.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of uppercase characters.
Getnet
Allowable characters are letters, numbers, and spaces. Special characters are not allowed.
Visa Platform Connect
The value for this field does not map to the TC 33 capture file.

Specifications

  • Data Type
    : String
  • Data Length:
    • Chase Paymentech Solutions
      :
       21 for Mastercard, 13 for Visa
    • Cielo
      :
       13
    • FDC Compass
      :
       21
    • FDC Nashville Global
      :
       11
    • Getnet
      :
       13—When length is greater than 13, characters to the right of the 13th character are discarded.
    • Rede
      :
       13
    • Software Express
      :
       21
    • All other processors:
       14

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.locality
  • SCMP API Field:
    submerchant_city
  • Simple Order API Field:
    invoiceHeader_submerchantCity

aggregatorInformation. subMerchant.name

Sub-merchant’s business name.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of uppercase characters.
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCRB
  • Position: 109-146
  • Field: American Express Seller Name

Specifications

  • Data Type:
     String
  • Data Length:
    • American Express Direct
      : Maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 37 characters.
    • Chase Paymentech Solutions
      : Mastercard: 22, Visa: 25.
    • FDC Compass
      : American Express: 19. Mastercard: maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 37 characters.
    • FDC Nashville Global
      : American Express: 12. Mastercard: maximum length of the sub-merchant name depends on the length of the aggregator name: if aggregator name length is 1 through 3, maximum sub-merchant name length is 21; if aggregator name length is 4 through 7, maximum sub-merchant name length is 17; if aggregator name length is 8 through 12, maximum sub-merchant name length is 12.
    • Visa Platform Connect
      : American Express: maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. Not used with other card types.

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.name
  • SCMP API Field:
    submerchant_name
  • Simple Order API Field:
    invoiceHeader_submerchantName

aggregatorInformation. subMerchant.phoneNumber

Sub-merchant’s telephone number.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of numbers or a combinations of numbers and uppercase letters.
Formats:
  • NNN-NNN-NNNN
  • NNN-AAAAAAA
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCRB
  • Position: 5-24
  • Field: American Express Seller Telephone Number

Specifications

  • Data Type:
     String
  • Data Length:
    • Cielo
      :
       13
    • FDC Compass
      :
       13
    • FDC Nashville Global
      :
       10
    • Software Express
      :
       20
    • All other processors
      : 20

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.phoneNumber
  • SCMP API Field:
    submerchant_telephone_number
  • Simple Order API Field:
    invoiceHeader_submerchantTelephoneNumber

aggregatorInformation. subMerchant.postalCode

Partial postal code for the sub-merchant’s address.
Chase Paymentech Solutions
This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass
This value must consist of uppercase letters.
Getnet
All characters must be numbers. Special characters are not allowed.
Visa Platform Connect
The value for this field does not map to the TC 33 capture file.

Specifications

  • Data Type:
     String
  • Data Length:
    • American Express Direct
      :
       10
    • Chase Paymentech Solutions
      :
       15
    • FDC Compass
      :
       15
    • Software Express
      :
       15
    • Visa Platform Connect
      :
       10
    • All other processors:
       9

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.postalCode
  • SCMP API Field:
    submerchant_postal_code
  • Simple Order API Field:
    invoiceHeader_submerchantPostalCode

aggregatorInformation. subMerchant.region

Sub-merchant’s region.
FDC Nashville Global
This field is available only for aggregator authorizations.
Example
:
NE
 indicates that the sub-merchant is in the northeast region.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    aggregatorInformation.subMerchant.region
  • SCMP API Field:
    submerchant_region
  • Simple Order API Field:
    invoiceHeader_submerchantRegion