Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Payments
Payment Settings
Register payment and anti-fraud providers
Register payment and anti-fraud providers

VTEX allows you to set up different providers: gateways, acquirers, sub-acquirers, orchestrators, PSPs, and more. These allow you to provide your customers with different payment methods and conditions and antifraud protection services. Previously, these settings were referred to in our system as "gateway providers".

The provider management screen allows you to:

{"base64":"  ","img":{"width":1551,"height":537,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":66008,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_1.jpg"}}

Adding providers

To add a new payment or antifraud provider to your store, follow the steps below:

  1. In the VTEX Admin, go to Store Settings > Payments > Providers, or type Providers in the search bar at the top of the page.
  2. Click New Provider.
  3. Click on your preferred payment provider.
  4. Complete the App key and App token fields with the information supplied by the payment provider.
  5. If a warning message is displayed indicating that you need to install the app, click the Install App button and follow the installation instructions. This message is only displayed for some gateway provider types.
  6. Click Save.

If there are other fields to be completed besides App key and App token (Step 6), the gateway provider must be configured according to the specific tutorial. For more information, see the Payment Settings subsection.

The credentials used to complete the App key and Appn token fields must be supplied by the payment provider to identify the store. Credentials generated in the Admin starting with vtexappkey- should be used.

To configure the payment methods that will be processed by your chosen payment provider, read Configuring Payment Conditions.

To set special conditions for payment methods, read Configuring payment special conditions.

{"base64":"  ","img":{"width":1130,"height":762,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":56051,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_2.JPG"}}

Viewing added providers

The main provider management screen, available in the VTEX Admin under Store Settings > Payments > Providers, displays all the payment or antifraud providers in a store. To allow quick access to information on specific providers, you can search or use filters.

Searching for providers

To search for providers by name, go to the provider management page and enter the name of the provider you want to find.

{"base64":"  ","img":{"width":1548,"height":266,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":29976,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_3.JPG"}}

Filtering providers

To select the providers using filters, go to the provider management page and apply one or more of the filters shown below:

  • Name: Select the payment provider using the name by checking the box or using the menu search bar.

{"base64":"  ","img":{"width":1539,"height":505,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":50418,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_4.JPG"}}

  • Type: Select to display payment providers, antifraud providers, or both.

{"base64":"  ","img":{"width":1547,"height":293,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":31291,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_5.JPG"}}

  • Environment: Select the providers by type of operating environment (production or test).

{"base64":"  ","img":{"width":1542,"height":264,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":29179,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_6.JPG"}}

To clear the applied filters and see all the providers in the store again, click the Clear All button.

Editing provider settings

To edit the settings of existing payment or antifraud providers in the store, follow the steps below:

  1. In the VTEX Admin, go to Store Settings > Payments > Providers, or type Providers in the search bar at the top of the page.
  2. Click the desired payment or antifraud provider.
  3. On the provider configuration screen, click Edit.
  4. Make the necessary changes and click Save.

{"base64":"  ","img":{"width":1130,"height":614,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":41003,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Payments/Payment%20Settings/registering-gateway-affiliations_7.JPG"}}

Before changing the provider's settings, such as authorization details, processing mode, or refund type, ensure the new information entered will not affect your store's performance.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback