Skip to main content

What is the purpose of the virtualStoreList field, and how should it be configured or updated?

Understanding and Configuring the virtualStoreList Field

The virtualStoreList field is a critical component in the configuration of stores within the Softpay platform. This article explains its purpose, functionality, and guidelines for updating or configuring its fields.

Overview of the virtualStoreList Field

The virtualStoreList field defines the acquirer host(s) to which a store routes transactions and specifies the acquirer-specific store identifier for each host. It is essential for ensuring proper routing and identification of the store within the payment processing system. Each entry in the virtualStoreList includes the following key components:

  • processorType: Identifies the acquirer (e.g., NETS, PAYCORE, FISERV).

  • onlineStoreId: Represents the acquirer’s store ID, such as the MID/store ID provided by the acquirer.

Why is the virtualStoreList Field Required?

The routing layer relies on the virtualStoreList to determine:

  1. Which host to use for transaction processing.

  2. The store's identity on the acquirer side.

Even for single-host setups, at least one entry is required. For multi-host setups, multiple entries are included to enable acquirer switching.

Important: The onlineStoreId is set during the initial creation of the store and cannot be updated later. Ensure its accuracy during setup.

Guidelines for Updating Fields

Updating the Store Name Field

You can safely update the store’s name field without causing any issues. This field is independent of the routing and processing functionality.

Updating the cardAcceptorNameLocation Field

For stores using Elavon as the payment processor, the virtualStoreList.cardAcceptorNameLocation field has no functional effect. It is auto-populated during onboarding and can be ignored or updated without impacting the store's operations.

Do not update onlineStoreId Field

Updating the onlineStoreId for Nets is not supported. Instead the store must be offboarded and a new onboarded.

Best Practices for Initial Setup

  1. Verify Acquirer Information: Ensure that the onlineStoreId and processorType are accurate and correspond to the correct acquirer.

  2. Double-Check Entries: For multi-host setups, confirm that all required entries are included to facilitate acquirer switching.

  3. Avoid Updates to Immutable Fields: Remember that the onlineStoreId cannot be changed after creation, so it must be correct from the start.

Conclusion

The virtualStoreList field is essential for defining store routing and acquirer-specific identifiers. By following the guidelines outlined above, you can ensure a smooth setup and operation of your store within the Softpay platform. For further assistance, refer to the Softpay documentation or contact support.


Related Topics

  • Configuring Acquirer Hosts

  • Managing Store Identifiers

  • Troubleshooting Routing Issues

Did this answer your question?