productInformation

The following fields provide product information.

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. active

Determines whether American Express is actively configured as a card type for Account Updater.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "amex": { "active": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.active
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.configurations.amex.active
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. mode

Determines the type of mode configured on Account Updater for American Express cards.

Possible Values

  • tokenApi
  • dailyHarvest

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "amex": { "mode": "dailyHarvest" } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.mode
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.configurations.amex.mode
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. seNumber

The American Express card service establishment (SE) number configured for Account Updater.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "amex": { "seNumber": "1234567890" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.seNumber
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.configurations.amex.seNumber
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. subscriberId

The subscriber identifier configured for Account Updater with American Express cards.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "amex": { "subscriberId": "0123456789" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.subscriberId
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.configurations.amex.subscriberId
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. daysWindow

Interval of days at which Account Updater updates payment information. The default value is
31
.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "daysWindow": "31" } } } } } } }

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    3650

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.daysWindow
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.configurations.daysWindow
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. masterCard. active

Determines whether Mastercard is actively configured as a card type for Account Updater.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "masterCard": { "active": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.masterCard.active
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation. configurations.masterCard.active
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. masterCard. interbankCardAssociationNumber

The number that is assigned by Mastercard to a financial institution, third-party processor, or other member to identify the member in a transaction.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "masterCard": { "interbankCardAssociationNumber": "12345" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.masterCard.interbankCardAssociationNumber
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation. configurations.masterCard.interbankCardAssociationNumber
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. masterCard. merchantId

Mastercard merchant identifier (MID) number that is configured in Account Updater.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "masterCard": { "merchantId": "testmerch123" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.masterCard.merchantId
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation. configurations.masterCard.merchantId
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. preferredDay

Merchant's preferred day that Account Updater updates payment information.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "preferredDay": "1" } } } } } } }

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    28

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.preferredDay
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.configurations.preferredDay
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. templateId

Template identifier that is configured for Account Updater.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "templateId": "template123" } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.templateId
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation.templateId
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. visa. active

Determines whether Visa is actively configured as a card type for Account Updater.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "visa": { "active": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.visa.active
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation. configurations.visa.active
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. visa. merchantId

The Visa merchant identifier (MID) number that is configured for Account Updater.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "visa": { "merchantId": "testrest" } } } } } } } }
The value of this field must conform to this regular expression:
^[0-9]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.visa.merchantId
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation. configurations.visa.merchantId
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. visa. segmentId

The segment identifier that is assigned by Visa for each group of merchants participating in Account Updater.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "configurationInformation": { "configurations": { "visa": { "segmentId": "123456789" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.visa.segmentId
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.configurationInformation. configurations.visa.segmentId
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. subscriptionInformation. enabled

Determines whether subscription information is enabled for Account Updater.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "accountUpdater": { "subscriptionInformation": { "enabled": "true" } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. subscriptionInformation.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.subscriptionInformation.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. accountUpdater. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Account Updater using self service.

Possible Values

  • NOT_SELF_SERVICEABLE
    (default)

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "tokenManagement": { "subscriptionInformation": { "selfServiceability": "NOT_SELF_SERVICEABLE" } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.accountUpdater. subscriptionInformation.selfServiceability
Product Enablement and Configuration Service API Field:
commerceSolutions.accountUpdater.subscriptionInformation.selfServiceability
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. acquirer. acquirerId

The token service provider ID that is used for the token requestor ID (TRID) enrollment for Visa.
You must set this field value to
40010052242
. This is a static value that is used for all clients that are enrolling for a token requestor on Visa Token Service (VTS). This field value must not be replaced by another value.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "acquirer": { "acquirerId": "40010052242" } } } } } } } } } } }

Specifications

  • Data Type:
    String
  • Maximum Data Length:
    15

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.acquirer.acquirerId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. acquirer. acquirerMerchantId

The merchant account organization ID that is used for the token requestor ID (TRID) enrollment for Visa.
Set this field to the merchant account organization ID that is being boarded.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "acquirer": { "acquirerMerchantId": "acqmerch123" } } } } } } } } } } }

Specifications

  • Data Type:
    String
  • Maximum Data Length:
    25

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerMerchantId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.acquirer.acquirerMerchantId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. address. country

The merchant country code that is used for the token requestor ID (TRID) enrollment for Visa.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "address": { "country": "US" } } } } } } } } } } }
The value of this field must conform to this regular expression:
^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.country
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.address.country
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. address. locality

The merchant locality name that is used for the token requestor ID (TRID) enrollment for Visa.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "address": { "locality": "CA" } } } } } } } } } } }
The value of this field must conform to this regular expression:
^[0-9a-zA-Z _\-¡-]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    50

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.locality
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.address.locality
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. websiteUrl

The merchant website URL that is used for the token requestor ID (TRID) enrollment for Visa.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "websiteUrl": "http://www.example.com" } } } } } } } } } }

Specifications

  • Data Type:
    String
  • Maximum Data Length:
    100

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.websiteUrl
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.address.websiteUrl
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. doingBusinessAs

The merchant business name that is used for the token requestor ID (TRID) enrollment for Mastercard.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "doingBusinessAs": "Business Name" } } } } } } } } } }

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    60

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment. businessInformation.doingBusinessAs
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.doingBusinessAs
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. name

The merchant business name that is used for token requestor ID (TRID) enrollment for Visa.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "businessInformation": { "name": "Business Name" } } } } } } } } } }

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    60

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.name
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.name
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. enableTransactionalTokens

Indicates if the use of American Express network tokens in transactions is enabled or disabled. When this field is set to
true
, Visa network tokens can be used in transactions.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "americanExpressTokenService": { "enableTransactionalTokens": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.americanExpressTokenService. enableTransactionalTokens
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.enableTransactionalTokens
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. seNumber

This field is used to assign the American Express service establishment (SE) number that is used for network tokenization into the
Token Management Service
vault.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "americanExpressTokenService": { "seNumber": "0123456789" } } } } } } } } } }
The value of this field must conform to this regular expression:
^[0-9]{11}\z$"

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. americanExpressTokenService.seNumber
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.seNumber
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. enableService

Indicates if provisioning of new network tokens for American Express is enabled or disabled. When this field is set to
true
, the provisioning of new network tokens for American Express is enabled.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "americanExpressTokenService": { "enableService": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.americanExpressTokenService. enableService
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.enableService
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. tokenRequestorId

This field is used to assign an existing token requestor ID (TRID) to a
Token Management Service
vault for American Express.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "americanExpressTokenService": { "tokenRequestorId": "12345678901" } } } } } } } } } }
The value of this field must conform to this regular expression:
^[0-9]{11}\\z$"

Specifications

  • Data Type:
    String
  • Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. americanExpressTokenService.tokenRequestorId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.tokenRequestorId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. paymentCredentials. enabled

Indicates if the unmasked network token and cryptogram retrieval service is enabled or disabled. When this field is set to
true
, the unmasked network token and cryptogram retrieval service is enabled.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "paymentCredentials": { "enabled": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.paymentCredentials.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.paymentCredentials.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. mastercardDigitalEnablementService. enableTransactionalTokens

Indicates if the use of Mastercard network tokens in transactions is enabled or disabled. When this field is set to
true
, Visa network tokens can be used in transactions.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "mastercardDigitalEnablementService": { "enableTransactionalTokens": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enableTransactionalTokens
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enableTransactionalTokens
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. mastercardDigitalEnablementService. enableService

Indicates if provisioning of new network tokens for Mastercard is enabled or disabled. When this field is set to
true
, the provisioning of new network tokens for Mastercard is enabled.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "mastercardDigitalEnablementService": { "enableService": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enableService
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enableService
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. networkTokenServices. mastercardDigitalEnablementService. enrollment

Indicates if token requestor ID (TRID) enrollment for Mastercard is enabled or disabled. When this field is set to
true
, TRID enrollment is enabled for Mastercard.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "networkTokenServices": { "mastercardDigitalEnablementService": { "enrollment": "true" } } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enrollment
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enrollment
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. mastercardDigitalEnablementService. tokenRequestorId

This field is used to assign an existing token requestor ID (TRID) to a
Token Management Service
vault for Mastercard.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "mastercardDigitalEnablementService": { "tokenRequestorId": "12345678901" } } } } } } } } } }
The value of this field must conform to this regular expression:
^[0-9]{11}\\z$"

Specifications

  • Data Type:
    String
  • Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.tokenRequestorId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.tokenRequestorId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. notifications. enabled

Indicates if life-cycle management updates are enabled or disabled for the
Token Management Service
vault that is being configured.
When this field is set to
true
, life-cycle management updates are enabled for the
Token Management Service
vault that is being configured.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "notifications": { "enabled": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.notifications.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.notifications.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. synchronousProvisioning. enabled

Indicates if the synchronous provisioning service is enabled or disabled. When this field is set to
true
, network token provisioning responses will be returned in real time.
IMPORTANT
The synchronous provisioning feature is intended only for standalone
Token Management Service
(
TMS
) merchants and partners, such as
Token Management Service
aggregators. When you enable this feature for direct merchants, it could result in latency in the authorization response.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "synchronousProvisioning": { "enabled": "false" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts. commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.synchronousProvisioning.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.synchronousProvisioning.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. enableTransactionalTokens

Indicates if the use of Visa network tokens in transactions is enabled or disabled. When this field is set to
true
, Visa network tokens can be used in transactions.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "visaTokenService": { "enableTransactionalTokens": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService. enableTransactionalTokens
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enableTransactionalTokens
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. enableService

Indicates if provisioning of new network tokens for Visa is enabled or disabled. When this field is set to
true
, the provisioning of new network tokens for Visa is enabled.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "visaTokenService": { "enableService": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.enableService
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enableService
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. networkTokenServices. visaTokenService. enrollment

Indicates if token requestor ID (TRID) enrollment for Visa is enabled or disabled. When this field is set to
true
, TRID enrollment is enabled for Visa.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenEnrollment": { "networkTokenServices": { "visaTokenService": { "enrollment": "true" } } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.enrollment
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enrollment
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. relationshipId

This field is used to assign an existing token requestor relationship ID to a
Token Management Service
vault for Visa.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "visaTokenService": { "relationshipId": "123456" } } } } } } } } } }

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    100

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.relationshipId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.relationshipId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. parentProfileId

The parent profile identifier that is configured for the
Token Management Service
.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "parentProfileId": "" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.parentProfileId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations.parentProfileId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. templateId

The template identifier that is configured for the
Token Management Service
.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "templateId": "template1234" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.templateId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations.templateId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. defaultTokenType

Indicates the default token type for the
Token Management Service
vault.

Possible Values

  • CUSTOMER
  • INSTRUMENT_IDENTIFIER
  • PAYMENT_INSTRUMENT

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "vault": { "defaultTokenType": "CUSTOMER" } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.defaultTokenType
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.defaultTokenType
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. tokenRequestorId

This field is used to assign an existing token requestor ID (TRID) to a
Token Management Service
vault for Visa.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "networkTokenServices": { "visaTokenService": { "tokenRequestorId": "12345678901" } } } } } } } } } }
The value of this field must conform to this regular expression:
^[0-9]{11}\\z$"

Specifications

  • Data Type:
    String
  • Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.tokenRequestorId
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.tokenRequestorId
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. location

Indicates where the
Token Management Service
(
TMS
) vault and the stored tokens are located.

Possible Values

  • IDC
    : Set to this value for
    TMS
    vaults located in the India data center.
  • GDC
    : Set to this value for
    TMS
    vaults located in the global data center.

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "vault": { "location": "IDC" } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.location
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations.vault.location
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. sensitivePrivileges. cardNumberMaskingFormat

Indicates which digits of the card number are be unmasked in the
Token Management Service
vault.

Possible Values

  • FIRST_6_LAST_4
  • LAST_4
  • MASKED

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "vault": { "sensitivePrivileges": { "cardNumberMaskingFormat": "MASKED" } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.sensitivePrivileges.cardNumberMaskingFormat
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.sensitivePrivileges.cardNumberMaskingFormat
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. customer

Indicates the token format for the customer tokens that are stored in the
Token Management Service
vault.

Possible Values

  • 16_DIGIT
  • 19_DIGIT
  • 22_DIGIT
  • 32_HEX

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "vault": { "tokenFormats": { "customer": "16_DIGIT" } } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.customer
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.customer
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. instrumentIdentifierBankAccount

Indicates the token format for the instrument identifier tokens for bank accounts that are stored in the
Token Management Service
vault.
IMPORTANT
Account Updater does not support 22-digit instrument identifier tokens.

Possible Values

  • 16_DIGIT
  • 19_DIGIT
  • 22_DIGIT
  • 32_HEX

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "vault": { "tokenFormats": { "instrumentIdentifierBankAccount": "16_DIGIT" } } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierBankAccount
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.instrumentIdentifierBankAccount
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. instrumentIdentifierCard

Indicates the token format for the instrument identifier tokens for credit cards that are stored in the
Token Management Service
vault.
IMPORTANT
Account Updater does not support 22-digit instrument identifier tokens.

Possible Values

  • 16_DIGIT
  • 16_DIGIT_LAST_4
  • 19_DIGIT
  • 19_DIGIT_LAST_4
  • 22_DIGIT
  • 32_HEX

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "configurationInformation": { "configurations": { "vault": { "tokenFormats": { "instrumentIdentifierCard": "16_DIGIT" } } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierCard
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.instrumentIdentifierCard
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. subscriptionInformation. enabled

Determines whether subscription information is enabled for
Token Management Service
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "subscriptionInformation": { "enabled": "true" } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. subscriptionInformation.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.subscriptionInformation.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. tokenManagement. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable the
Token Management Service
using self service.

Possible Values

  • NOT_SELF_SERVICEABLE
    (default)

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "tokenManagement": { "subscriptionInformation": { "selfServiceability": "NOT_SELF_SERVICEABLE" } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.tokenManagement. subscriptionInformation.selfServiceability
Product Enablement and Configuration Service API Field:
commerceSolutions.tokenManagement.subscriptionInformation.selfServiceability
productInformation

productInformation. selectedProducts. commerceSolutions. valueAddedServices. reporting. subscriptionInformation. enabled

Determines whether subscription information is enabled for Reporting.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "reporting": { "subscriptionInformation": { "enabled": "true" } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.valueAddedServices. reporting.subscriptionInformation.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.valueAddedServices.reporting.subscriptionInformation.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. valueAddedServices. reporting. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Reporting using self service.

Possible Values

  • NOT_SELF_SERVICEABLE
    (default)

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "reporting": { "subscriptionInformation": { "selfServiceability": "NOT_SELF_SERVICEABLE" } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.valueAddedServices. reporting.subscriptionInformation.selfServiceability
Product Enablement and Configuration Service API Field:
commerceSolutions.valueAddedServices.reporting. subscriptionInformation.selfServiceability
productInformation

productInformation. selectedProducts. commerceSolutions. valueAddedServices. transactionSearch. subscriptionInformation. enabled

Determines whether subscription information is enabled for Transaction Search.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "transactionSearch": { "subscriptionInformation": { "enabled": "true" } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.valueAddedServices. transactionSearch.subscriptionInformation.enabled
Product Enablement and Configuration Service API Field:
commerceSolutions.valueAddedServices.transactionSearch. subscriptionInformation.enabled
productInformation

productInformation. selectedProducts. commerceSolutions. valueAddedServices. transactionSearch. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Transaction Search using self service.

Possible Values

  • NOT_SELF_SERVICEABLE
    (default)

Syntax

{ "productInformation": { "selectedProducts": { "commerceSolutions": { "valueAddedServices": { "transactionSearch": { "subscriptionInformation": { "selfServiceability": "NOT_SELF_SERVICEABLE" } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.commerceSolutions.valueAddedServices. transactionSearch.subscriptionInformation.selfServiceability
Product Enablement and Configuration Service API Field:
commerceSolutions.valueAddedServices.transactionSearch. subscriptionInformation.selfServiceability
productInformation

productInformation. selectedProducts. payments. cardPresentConnect. configurationInformation. configurations. partnerSolutionIdentifier

The solution identifier that is used to associate a partner organization with the onboarded merchant.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardPresentConnect": { "configurationInformation": { "configurations": { "partnerSolutionIdentifier": "partner01" } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect. configurationInformation.configurations.partnerSolutionIdentifier
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.partnerSolutionIdentifier
productInformation

productInformation. selectedProducts. payments. cardPresentConnect. configurationInformation. templateId

The template identifier that is configured in Card Present Connect.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardPresentConnect": { "configurationInformation": { "templateId": "template123" } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect. configurationInformation.templateId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.templateId
productInformation

productInformation. selectedProducts. payments. cardPresentConnect. subscriptionInformation. enabled

This field indicates if subscription information is enabled or disabled for Card Present Connect.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardPresentConnect": { "subscriptionInformation": { "enabled": "true" } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect. subscriptionInformation.enable
d
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.subscriptionInformation.enabled
productInformation

productInformation. selectedProducts. payments. cardPresentConnect. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Card Present Connect using self service.

Possible Values

  • NOT_SELF_SERVICEABLE
    (default)

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardPresentConnect": { "subscriptionInformation": { "selfServiceability": "NOT_SELF_SERVICEABLE" } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect. subscriptionInformation.selfServiceability
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.subscriptionInformation.selfServiceability
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. allowCapturesGreaterThanAuthorizations

If set to
true
, this field indicates that the merchant account is enabled to capture amounts that are greater than the authorization amount.
This field is available for these processors:
Chase Paymentech Solutions
,
Chase Paymentech Tandem
,
GPX
and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "allowCapturesGreaterThanAuthorizations": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API
:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.allowCapturesGreaterThanAuthorizations
Product Enablement and Configuration Service API
:
payments.cardProcessing. configurationInformation.configurations.common.allowCapturesGreaterThanAuthorization
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. amexVendorCode

The vendor code that is assigned by American Express.
This field is available for these processors:
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "amexVendorCode": "vendor123" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.amexVendorCode
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.amexVendorCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. creditCardRefundLimitPercent

Percentage refund limit. Over-refunds are blocked when the aggregated refund amount is higher than the percentage that is set for this field.
This field is available for these processors:
Chase Paymentech Solutions
,
GPX
, and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "creditCardRefundLimitPercent": "75" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.creditCardRefundLimitPercent
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. creditCardRefundLimitPercent
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. defaultAuthTypeCode

Authorization finality indicator. Request value can be in lowercase or capitalized letters.
This field is available for these processors:
Barclays
,
Barclays Merchant Services
,
Chase Paymentech Solutions
,
Chase Paymentech Tandem
,
Elavon Americas
,
FDMS Nashville
,
FDC Nashville Global
,
GPN
,
GPX
,
SIX
,
Streamline
,
Visa Platform Connect
, and
TSYS Acquiring Solutions
.

Possible Values

  • FINAL
  • PRE
  • UNDEFINED

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "defaultAuthTypeCode": "UNDEFINED" } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.defaultAuthTypeCode
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.defaultAuthTypeCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. domesticMerchantId

The local merchant identifier that is used by merchants in addition to the conventional merchant identifier. This value is sent to the issuer.
This field is available for these processors:
Prisma
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "domesticMerchantId": "merchtest1" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.domesticMerchantId
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.domesticMerchantId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. businessCenterCreditCardRefundLimitPercent

Percentage refund limit. This field limits refunds to the percentage that is set in this field value.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "creditCardRefundLimitPercent": "100" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.businessCenterCreditCardRefundLimitPercent
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.businessCenterCreditCardRefundLimitPercent
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enableDuplicateMerchantReferenceNumberBlocking

Indicates if duplicate merchant reference numbers are blocked for transactions.
This field is available for these processors:
Chase Paymentech Solutions
,
GPX
, and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "enableDuplicateMerchantReferenceNumberBlocking": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enableDuplicateMerchantReferenceNumberBlocking
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.enableDuplicateMerchantReferenceNumberBlocking
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enableInterchangeOptimization

When this field is set to
true
, your interchange fees are reduced by using automatic authorization refresh and automatic partial authorization reversal.
This field is available for these processors:
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "enableInterchangeOptimization": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enableInterchangeOptimization
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.enableInterchangeOptimization
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enablePartialAuth

When this field is set to
true
, it enables merchants to accept partial authorization approvals.
This field is available for these processors:
American Express Direct
,
Chase Paymentech Solutions
,
Chase Paymentech Tandem
,
Elavon Americas
,
GPN
,
GPX
,
FDC Nashville Global
,
FDMS Nashville
,
Visa Platform Connect
, and
TSYS Acquiring Solutions
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "enablePartialAuth": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enablePartialAuth
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.enablePartialAuth
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enableSplitShipment

When this field is set to
true
, it enables merchants 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
This field is available for these processors:
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "enableSplitShipment": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enableSplitShipment
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.common.enableSplitShipment
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. foodAndConsumerServiceId

Food and consumer service identifier. This field identifies that the merchant is certified and approved to accept food stamps.
This field is available for this processor:
GPX
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "foodAndConsumerServiceId": "1234" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.foodAndConsumerServiceId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations.common.foodAndConsumerServiceId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. masterCardAssignedId

The identifier that is assigned by Mastercard. This field is the equivalent of merchant verification value (MVV) that is assigned by Visa.
This field is available for these processors:
FDC Nashville Global
,
GPX
, and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "masterCardAssignedId": "000" } } } } } } } }

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.masterCardAssignedId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations.common.masterCardAssignedId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantCategoryCode

A 4-digit code used to classify the business by the type of goods and services it provides.
This number is assigned by the merchant acquiring bank.
This field is available for these processors:
American Express Direct
(required),
Barclays
, Barclays Merchant Services,
Chase Paymentech Solutions
,
Chase Paymentech Tandem
,
China UnionPay
,
Credit Mutuel-CIC
,
Elavon Americas
,
FDC Nashville Global
,
GPN
,
GPX
,
Prisma
,
RuPay
,
TSYS Acquiring Solutions
, and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantCategoryCode": "1234" } } } } } } } }
The value for this field must conform to this regular expression:
^[0-9]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    4
  • Maximum Data Length:
    4

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantCategoryCode
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations.common.merchantCategoryCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. city

City for the merchant business location. This value might be displayed on the cardholder’s statement.
This field is available for these processors:
American Express Direct
,
Elavon Americas
,
RuPay
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "city": "Boston" } } } } } } } } }
American Express Direct
and
RuPay
:
The syntax must conform to this regular expression:
^[0-9a-zA-Z\s]+$
TSYS Acquiring Solutions
:
The syntax must conform to this regular expression:
%5E%5B0-9a-zA-Z%5D%2B%24

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    • Elavon Americas
      :
      0
    • All other processors:
      1
  • Maximum Data Length:
    • American Express Direct
      :
      21
    • All other processors:
      13

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.city
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.city
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. country

Country of origin for the merchant's business.
Use the ISO Alpha-2 country code described in the ISO 3166 standard.
Use the ISO Alpha-3 country code described in the ISO 3166 standard.
For more information, see: iso-3166-country-codes.html
This field is available for these processors:
American Express Direct
(required),
Elavon Americas
,
SIX
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "country": "CAN" } } } } } } } } }
The syntax must conform to this regular expression:
American Express Direct
^[A-Z]+$
All other processors
%5E%5B0-9a-zA-Z%5D%2B%24

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    • Elavon Americas
      :
      2
    • All other processors:
      3
  • Maximum Data Length:
    • Elavon Americas
      :
      2
    • All other processors:
      3

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.country
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.country
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. name

Merchant business name.
This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. When used with Payer Authentication, this field is the company’s name as it appears to the customer in the issuing bank’s authentication form. This value overrides the value specified by the merchant bank.
This field is available for these processors:
American Express Direct
(required),
Elavon Americas
,
RuPay
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "name": "Merchant Name" } } } } } } } } }
The syntax must conform to this regular expression:
^[0-9a-zA-Z\s]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    38

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.name
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.name
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. phone

Merchant phone number.
This field is available for these processors:
American Express Direct
(required),
Elavon Americas
,
RuPay
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "phone": "5554327113" } } } } } } } } }
The syntax must conform to this regular expression:
^[0-9a-zA-Z\s]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    20

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.phone
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.phone
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. state

State code or region code of the merchant business location.
Use the standard state, province, and territory codes for the US and Canada. This field is supported 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.
This field is available for these processors:
American Express Direct
(required),
Elavon Americas
,
RuPay
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "state": "TX" } } } } } } } } }
The syntax must conform to this regular expression:
^[A-Z]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    3

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.state
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.state
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. street

Street address of the merchant business location.
This value must consist of English characters. This value might be displayed on the cardholder’s statement.
This field is available for these processors:
American Express Direct
(required),
Elavon Americas
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "street": "123 Main St" } } } } } } } } }
The syntax must conform to this regular expression:
^[0-9a-zA-Z\s]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    38

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.street
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.street
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. url

URL of the merchant website.
This field is available for these processors:
American Express Direct
and
RuPay
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "url": "http://www.merchwebsite.com" } } } } } } } } }
American Express Direct
:
The syntax must conform to this regular expression:
^(((ht|f)tp(s?):\/\/[^\.])|www\.)[-a-zA-Z0-9+&@#/%=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$
RuPay
:
The syntax must conform to this regular expression:
%5E%28%28%28ht%7Cf%29tp%28s%3F%29%3A%5C%2F%5C%2F%5B%5E%5C.%5D%29%7Cwww%5C.%29%5B-a-zA-Z0-9%2B%26amp%3B%40%23%2F%25%3D%7E_%7C%21%3A%2C.%3B%5D*%5B-a-zA-Z0-9%2B%26amp%3B%40%23%2F%25%3D%7E_%7C%5D%24

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    • American Express Direct
      :
      1
    • RuPay
      :
      0
  • Maximum Data Length:
    • American Express Direct
      :
      40
    • RuPay
      :
      128

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.url
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.url
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. zip

Postal code of the merchant business location.
This value might be displayed on the cardholder’s statement.
If your business is located in the US, you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits]
Example:
12345-6789
If your business is domiciled in Canada, use a 6-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric]
Example:
A1B 2C3
This field is available for these processors:
American Express Direct
(required),
Elavon Americas
,
RuPay
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "merchantDescriptorInformation": { "zip": "12345-6789" } } } } } } } } }
The syntax must conform to this regular expression:
^[0-9a-zA-Z\s]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    15

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.zip
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.zip
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. preferCobadgedSecondaryBrand

Indicates the merchant's preference on secondary card brand for routing in the case of co-branded cards.
This field is available for this processor:
EFTPOS
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "preferCobadgedSecondaryBrand": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.preferCobadgedSecondaryBrand
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations. common.preferCobadgedSecondaryBrand
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processLevel3Data

Indicates whether the merchant processes Level III transactions.
This field is available for these processors: Barclays Merchant Services
Chase Paymentech Solutions
,
Chase Paymentech Tandem
,
FDC Nashville Global
,
Elavon Americas
, and
TSYS Acquiring Solutions
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processLevel3Data": "true" } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processLevel3Data
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations. common.processLevel3Data
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. amexTransactionAdviceAddendum1

Transaction advice addendum field that is used to display descriptive information about a transaction on a customer’s American Express card statement.
This field is available for these processors:
American Express Direct
,
FDC Nashville Global
, and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "amexTransactionAdviceAddendum1": "amextaa" } } } } } } } } }
The syntax must conform to this regular expression:
^[0-9a-zA-Z\-\s.]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    • American Express Direct
      and
      TSYS Acquiring Solutions
      :
      40
    • FDC Nashville Global
      : 23

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.features.cardNotPresent.amexTransactionAdviceAddendum1
Product Enablement and Configuration Service API Field:
payments.cardProcessing. configurationInformation.configurations.features.cardNotPresent.amexTransactionAdviceAddendum1
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. ignoreAddressVerificationSystem

Flag for a sale request that indicates whether to allow the capture service to run when the authorization receives a address verification system (AVS) decline.
This field is available for these processors:
Barclays
, Barclays HISO, Barclays Merchant Services,
FDC Nashville Global
,
GPN
,
GPX
, and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "ignoreAddressVerificationSystem": "false" } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.ignoreAddressVerificationSystem
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.ignoreAddressVerificationSystem
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. installment. enableInstallment

When set to
true
, this field enables installment plan programs.
This field is available for these processors:
American Express Direct
, Fiserv, and
Vero
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "installment": { "enableInstallment": "true" } } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.enableInstallment
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.enableInstallment
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. installment. installmentPlan

Indicates the type of funding for the installment plan that is associated with the payment.
This field is available for these processors:
American Express Direct
, Fiserv, and
Vero
.

Possible Values

  • issuer
    : Issuer-funded installment plan
  • merchant
    : Merchant-funded installment plan

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "installment": { "installmentPlan": "merchant" } } } } } } } } } }

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.installmentPlan
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.installmentPlan
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. enableEmsTransactionRiskScore

Indicates if Mastercard Expert Monitoring Solutions (EMS) is enabled. EMS provides a predictive, behavior-based fraud score in real time during authorizations for card-not-present transactions on cards issued in the US.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "enableEmsTransactionRiskScore": "true" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].enableEmsTransactionRiskScore
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].enableEmsTransactionRiskScore
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. acquiringInstitutionId

The identifier of the financial institution that is acting as the acquirer of a customer transaction. The acquirer is the member or system user that signed the merchant. This number is typically assigned by Visa.
This field is available for these processors:
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "ctv": { "payouts": { "acquiringInstitutionId": "12345" } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.acquiringInstitutionId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.acquiringInstitutionId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. businessApplicationId

Payout transaction type. This field is a
pass-through
, which means that the value is not verified or modified in any way before it is sent to the processor.
You can provide a business application ID in this field or in your account. When a request includes this field, the value in the field overrides the information in your account. Call customer support to update your account information.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Possible Values

For Payouts transactions on
Visa Platform Connect
  • BB
    : Business to business.
  • CB
    : Consumer Bill Payment
  • FD
    : Funds disbursement (general), including:
    • Commission payments
    • Digital goods or games
    • Insurance payments
    • Loan disbursements
    • Lottery payouts
    • Shared economy
    • Non-government-initiated tax refund services such as tax preparation businesses
  • GD
    : Government disbursement, including:
    • Government-initiated tax refunds
    • Government benefit and welfare disbursements
  • GP
    : Gambling payout other than online gambling.
  • LO
    : Loyalty credits and rebates (not supported in European systems).
  • MD
    : Merchant disbursement (acquirers or aggregators settling to merchants).
  • OG
    : Online gambling payout.
  • PD
    : Payroll pension disbursement.
  • WT
    : Wallet transfer.
Possible values:
  • PP
    : Person to person
  • RP
    : Request to pay.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "businessApplicationId": "" } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String
  • Maximum Data Length:
    2

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.businessApplicationId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.businessApplicationId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. enabledCnp

Indicates whether the card-not-present transaction is activated for the selected currency.
If both of these fields are set to
null
:
  • productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp
  • productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp
Then this field will be set to
true
:
  • productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "currencies": [ "<currency>": { "enabledCnp": "true" } ] } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
  • <currency>
    : The currency that is supported by the merchant.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. enabledCp

Indicates whether the card-not-present transaction is activated for the selected currency.
If both of these fields are set to
null
:
  • productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp
  • productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp
Then this field will be set to
true
:
  • productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "currencies": [ "<currency>": { "enabledCp": "true" } ] } ] } } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
  • <currency>
    : The currency that is supported by the merchant.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. enabled

Indicates which payout currencies are enabled.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "currencies": [ "<currency>": { "enabled": "true" } ] } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
  • <currency>
    : The currency that is supported by the merchant.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabled
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabled
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies. [currency]. merchantId

The merchant identifier that is assigned by an acquirer or a processor. This field should not be overridden by any other party.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "currencies": [ "<currency>": { "merchantId": "testmerch" } ] } ] } } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
  • <currency>
    : The currency that is supported by the merchant.
The syntax must conform to this regular expression:
^[0-9]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].merchantId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].merchantId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. serviceEnablementNumber

The service enablement number (SE number).
A unique 10-digit number assigned by American Express to a merchant that accepts American Express cards that are provided by the acquiring bank. This number might be unique for each currency.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "currencies": [ "<currency>": { "serviceEnablementNumber": "0123456789" } ] } ] } } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
  • <currency>
    : The currency that is supported by the merchant.
The value of this field must conform to this regular expression:
^[0-9]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    10
  • Minimum Data Length:
    10

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].serviceEnablementNumber
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].serviceEnablementNumber
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. terminalId

The terminal ID that is used with the payment processor. Depending on the processor and payment acceptance type, this field value may also be the default terminal ID that is used for card-present and virtual terminal transactions.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "currencies": [ "<currency>": { "terminalId": "018284" } ] } ] } } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
  • <currency>
    : The currency that is supported by the merchant.
The value of this field must conform to this regular expression:
^[0-9:\-]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    255

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].terminalId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].terminalId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. terminalIds

The terminal IDs that are used with the payment processor.
This field is available for this processor:
Prisma
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "prisma": { "payouts": { "currencies": [ "<currency>": { "terminalIds": "190238" } ] } ] } } } } } } } } } }
  • <currency>
    : The currency that is supported by the merchant.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].terminalIds
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName]payouts.currencies.[currency].terminalIds
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. financialInstitutionId

Financial institution identifier that is used with the payment processor.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "financialInstitutionId": "01234" } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.financialInstitutionId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.financialInstitutionId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. merchantAbaNumber

Routing number that is used to identify banks within the US.
This field is available for this processor:
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "ctv": { "payouts": { "merchantAbaNumber": "123456789" } } ] } } } } } } } } }

Specifications

  • Data Type:
    String
  • Data Length:
    9

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.merchantAbaNumber
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.merchantAbaNumber
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. merchantId

The merchant identifier (MID) that is configured for payouts.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "merchantId": "testrest" } } ] } } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to this regular expression:
^[0-9]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.merchantId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.merchantId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. networkOrder

The order of the networks in which Visa should make routing decisions.
This field is available for this processor:
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "networkOrder": "GUFV" } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.networkOrder
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.networkOrder
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. reimbursementCode

The code that indicates how a payout transaction is reimbursed.
This field is available for this processor:
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "reimbursementCode": "05" } } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.reimbursementCode
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.reimbursementCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. terminalId

The terminal ID that is used with the payment processor.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "payouts": { "terminalId": "01234" } } ] } } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to this regular expression:
^[0-9:\-]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    255

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.terminalId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.terminalId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. prestigiousPropertyIndicator

Indicator of prestigious property.
This field is available for this processor:
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "prestigiousPropertyIndicator": "01" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].prestigiousPropertyIndicator
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].prestigiousPropertyIndicator
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystemAllowExpiredCard

When set to
true
, this field allows transactions to use an expired card.
This field is available for these processors:
American Express Direct
, Barclays HISO, CB2A,
Chase Paymentech Solutions
,
GPN
,
GPX
,
Elavon Americas
,
FDC Nashville Global
,
RuPay
,
SIX
, and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "relaxAddressVerificationSystemAllowExpiredCard": "true" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowExpiredCard
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowExpiredCard
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystemAllowZipWithoutCountry

When set to
true
, this field allows transactions that include a zip code without country.
This field is available for these processors:
American Express Direct
, Barclays HISO,
Chase Paymentech Solutions
,
GPN
,
GPX
,
Elavon Americas
,
FDC Nashville Global
,
RuPay
,
Visa Platform Connect

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "relaxAddressVerificationSystemAllowZipWithoutCountry": "true" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowZipWithoutCountry
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowZipWithoutCountry
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystem

Enables you to submit the payment transaction without one or more of the billing to or card expiration fields.
This field is available for these processors:
American Express Direct
, Barclays HISO, CB2A,
Chase Paymentech Solutions
,
Credit Mutuel-CIC
,
Elavon Americas
,
FDC Nashville Global
, Fiserv,
GPN
,
GPX
,
SIX
,
Vero
, and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "relaxAddressVerificationSystem": "true" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystem
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystem
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. visaStraightThroughProcessingOnly

Indicates if a merchant is enabled for straight through processing - B2B invoice payments.
This field is available for these processors:
FDC Nashville Global
,
GPX
,
TSYS Acquiring Solutions
, and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "visaStraightThroughProcessingOnly": "true" } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.visaStraightThroughProcessingOnly
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.visaStraightThroughProcessingOnly
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. enableTerminalIdLookup

Used for card-present and virtual terminal transactions for terminal ID lookup.
This field is available for these processors:
GPX
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent": { "enableTerminalIdLookup": "true" } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.enableTerminalIdLookup
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.enableTerminalIdLookup
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. defaultPointOfSaleTerminalId

The identifier of the default terminal that is used for card-present and virtual terminal transactions.
This field is available for these processors:
American Express Direct
,
Chase Paymentech Solutions
,
GPX
, and
Visa Platform Connect

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent": { "processors": [ "<processor>": { "defaultPointOfSaleTerminalId": "terminal1234" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to this regular expression:
^[0-9:\-]+$

Specifications

  • Data Type:
    String
  • Maximum Data Length:
    1
  • Maximum Data Length:
    255

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].defaultPointOfSaleTerminalId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].defaultPointOfSaleTerminalId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. disablePointOfSaleTerminalIdValidation

Indicates if terminal ID validation is disabled.
This field is available for this processor:
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent": { "processors": [ "ctv": { "disablePointOfSaleTerminalIdValidation": "true" } ] } } } } } } } } }

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].disablePointOfSaleTerminalIdValidation
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].disablePointOfSaleTerminalIdValidation
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. enablePinTranslation

Enables
Cybersource
PIN translation for online PIN transactions. You must exchange PIN keys with
Cybersource
to use this feature.
This field is available for this processor:
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent": { "processors": [ "<processor>": { "enablePinTranslation": "true" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].enablePinTranslation
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].enablePinTranslation
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. financialInstitutionId

Acquirer institution identifier that is used for PIN debit transactions.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent": { "processors": [ "<processor>": { "financialInstitutionId": "01234" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].financialInstitutionId
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].financialInstitutionId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors. [processorName]. pinDebitNetworkOrder

Order of the networks in which Visa should make routing decisions.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent": { "processors": [ "<processor>": { "pinDebitNetworkOrder": "04" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].pinDebitNetworkOrder
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].pinDebitNetworkOrder
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. pinDebitReimbursementCode

PIN debit transaction reimbursement code for a certain type of interchange program.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Possible Values

  • Y
    : SMS supermarket
  • Z
    : SMS general merchant

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardPresent ": { "processors": [ "<processor>": { "pinDebitReimbursementCode": "Z" } ] } } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].pinDebitReimbursementCode
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].pinDebitReimbursementCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. pointOfSaleTerminalIds

A comma separated list of all possible terminal IDs that the merchant is likely to send.
For retail transactions, the value must be validated before the merchant sends the terminal ID using the API.
This field is available for this processor:
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "features": { "cardNotPresent": { "processors": [ "<processor>": { "pointOfSaleTerminalIds": "01234", "12345" } ] } } } } } } } } }
<processor>
: The processor associated with the merchant account.
The value of this field must conform to this regular expression:
^[0-9:\-]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    255

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].pointOfSaleTerminalIds
Product Enablement and Configuration Service API Field:
payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].pointOfSaleTerminalIds
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer

Merchant's acquiring bank.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirer": "acquiringBank" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to the regular expression format:
^[0-9a-zA-Z]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum data Length:
    15

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. allowMerchantDescriptorOverride

Enables a partner to enable or disable merchant descriptor values.
This field is available for these processors:
China UnionPay
,
EFTPOS
, and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "allowMerchantDescriptorOverride": "true" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].allowMerchantDescriptorOverride
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].allowMerchantDescriptorOverride
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. allowMultipleBills

If field it set to
true
, it enables a merchant to allow multiple captures for a single authorization transaction.
This field is available for these processors:
American Express Direct
,
Chase Paymentech Tandem
GPX
,
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "allowMultipleBills": "true" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].allowMultipleBills
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].allowMultipleBills
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enhancedData

Enhanced data available for airline transactions.
This field is available for these processors:
American Express Direct
, Barclays Merchant Services,
Elavon Americas
,
FDC Nashville Global
,
GPX
,
TSYS Acquiring Solutions
and
Visa Platform Connect
.

Possible Values

  • enabled
  • disabled
  • ignored
  • required

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "enhancedData": "enabled" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enhancedData
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enhancedData
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. fireSafetyIndicator

When this field is set to
true
, it indicates that the merchant is compliant with the Hotel and Motel Fire Safety Act of 1990.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Possible Values

  • true
  • false

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "fireSafetyIndicator": "true" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Boolean

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].fireSafetyIndicator
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].fireSafetyIndicator
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. industryCode

Field that is used to identify the industry type of the merchant submitting the authorization request.
This field is available for these processors:
Elavon Americas
,
RuPay
and
TSYS Acquiring Solutions
.

Possible Values

  • 0
    : Unknown or unsure
  • A
    : Auto rental (EMV supported)
  • B
    : Bank/financial institution (EMV supported)
  • D
    : Direct marketing
  • F
    : Food/restaurant (EMV supported)
  • G
    : Grocery store/super market (EMV supported)
  • H
    : Hotel (EMV supported)
  • L
    : Limited amount terminal (EMV supported)
  • O
    : Oil company/automated fueling system (EMV supported)
  • P
    : Passenger transport (EMV supported)
  • R
    : Retail (EMV supported)

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "industryCode": "0" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    Enum

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].industryCode
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].industryCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantId

The merchant ID that is provided by the acquirer or processor.
This field is available for these processors:
Barclays HISO
,
Barclays Merchant Services
, and
Elavon Americas
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "merchantId": "merchant2345" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to the regular expression format:
^[0-9a-zA-Z]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    • Barclays HISO
      :
      15
    • Barclays Merchant Services
      :
      11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantId
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantBinNumber

6-digit acquirer bank identification number (BIN).
This field is available for these processors:
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "vital": { "merchantBinNumber": "123456" } ] } } } } } } } }

Specifications

  • Data Type:
    String
  • Data Length:
    6

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantBinNumber
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantBinNumber
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantLocationNumber

5-digit merchant location number. Unless otherwise specified by merchant’s bank or processor, this field should default to
00001
.
This field is available for the following processors:
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "vital": { "merchantLocationNumber": "00001" } ] } } } } } } } }

Specifications

  • Data Type:
    String
  • Data Length:
    5

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantLocationNumber
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantLocationNumber
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantTier

Defines the type of merchant. The numeric merchant tier value is assigned by
EFTPOS
.
This field is available for these processors:
EFTPOS
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "eftpos": { "merchantTier": "01" } ] } } } } } } } }

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    3
  • Maximum Data Length:
    3

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantTier
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantTier
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. sicCode

Standard Industrial Classification (SIC) code is a 4-digit code that categorizes the industry that the company belongs to based on their business activities. SIC codes were mostly replaced by the 6-digit North American Industry Classification System (NAICS).
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "sicCode": "1234" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].sicCode
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].sicCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. terminalId

Terminal ID used with the payment processor. Depending on the processor and payment acceptance type, this may also be the default terminal ID used for card-present and virtual terminal transactions.
This field is available for this processors:
Barclays HISO
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "terminalId": "merchant2345" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to the regular expression format:
^[0-9a-zA-Z]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    16

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].terminalId
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].terminalId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. abaNumber

Routing number that is used to identify banks within the US.
This field is available for this processor:
GPX
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "abaNumber": "123456789" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String
  • Data Length:
    9

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].abaNumber
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations. common.processors.[processorName].abaNumber
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. acquirer.interbankCardAssociationId

The number assigned by Mastercard to banks to identify the member in transactions.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirer": { "interbankCardAssociationId": "0125" } } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.interbankCardAssociationId
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.interbankCardAssociationId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. countryCode

Two-character ISO country or reason code of the acquirer.
This field is available for these processors:
China UnionPay
,
EFTPOS
,
GPX
,
Prisma
,
RuPay
, and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirer": { "countryCode": "US" } } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.countryCode
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.countryCode
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. discoverInstitutionId

The identifier assigned by Discover that is used to identify the acquirer.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirer": { "discoverInstitutionId": "012" } } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.discoverInstitutionId
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.discoverInstitutionId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. fileDestinationBin

The BIN where the capture file is sent. This field must contain a valid BIN.
This field is available for these processors:
GPX
and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirer": { "fileDestinationBin": "12345678" } } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String
  • Maximum Data Length:
    8

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.fileDestinationBin
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.fileDestinationBin
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. institutionId

Identifier of the acquirer. This number is usually assigned by Visa.
This field is available for these processors:
American Express Direct
, CB2A,
Credit Mutuel-CIC
,
China UnionPay
,
EFTPOS
,
GPX
,
SIX
, and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirer": { "institutionId": "1111" } } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to the regular expression format:
^[0-9]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    13

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.institutionId
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.institutionId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. acquirerMerchantId

Merchant identifier that is assigned by the acquirer.
This field is available for these processors:
RuPay
,
SIX
, and
Visa Platform Connect
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "acquirerMerchantId": "testacquirerid" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    11

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.acquirerMerchantId
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.acquirerMerchantId
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. amexTransactionAdviceAddendum1

American Express advice addendum field. This field is used to display descriptive information about a transaction on customer’s American Express card statement.
This field is available for these processors:
American Express Direct
,
FDC Nashville Global
and
TSYS Acquiring Solutions
.

Syntax

{ "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "configurationInformation": { "configurations": { "common": { "processors": [ "<processor>": { "amexTransactionAdviceAddendum1": "" } ] } } } } } } } }
  • <processor>
    : The processor that is associated with the merchant account.
The value of this field must conform to the regular expression format:
^[0-9a-zA-Z\-\s.]+$

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    40

Mapping Information

Boarding Registration Service API Field:
productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].amexTransactionAdviceAddendum1
Product Enablement and Configuration Service API Field:
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].amexTransactionAdviceAddendum1
productInformation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. avsFormat

Enables Enhanced Address Verification Service (AVS)/Automated Address Verification Plus (AAV+).
This field is available for this processor:
American Express Direct
.

Possible Values

  • basic
    : Standard address verification system. When a processor supports AVS for a transaction’s card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent.
  • basic + name
    : Enhanced address verification system. Consists of the standard AVS functionality plus verification of these additional fields:
    • orderInformation.billTo.firstName
    • orderInformation.billTo.lastName
  • basic + name + shipto
    : Automated address verification plus. Consists of the Enhanced AVS functionality and verification of some additional fields. AAV+ is intended for merchants that deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. These additional fields verified for AAV+:
    • orderInformation.billTo.phoneNumber
      (
      American Express Direct
      only)