API Reference

Getting Started

Help us improve our documentation! Tell us about your experience with this article by filling out this form.

Developing an antifraud integration

Antifraud solutions are used along with payment transactions to make them more secure by performing a risk analysis. VTEX allows antifraud systems to be integrated by providers through a protocol. The Antifraud Provider Protocol is a contract between VTEX and providers where VTEX defines a set of rules that have to be implemented by the providers in their integrations. The integrations have to include a set of endpoints defined in our Antifraud Provider Protocol API.

Developing a gift card integration

At VTEX, gift cards are treated as a payment option and their transactions are processed in the Checkout. Besides our native solution, VTEX allows external gift card providers to implement their integrations using our Gift Card Provider Protocol. Through this protocol, providers can develop a middleware containing the endpoints described in our Gift Card Provider Protocol API and connects with our Gift Card Hub. You can check more details about Gift Cards in the articles below:

Understanding VTEX’s Payments architecture

VTEX’s payment systems provide many resources to support all kinds of payment methods, conditions and integrations. This versatility also comes with complexity. If you are developing an integration or dealing with a more complex payment configuration, having a better understanding of our Payments architecture might help you. You can check details about it in these articles:

Configuring specific payment methods or affiliations

The most common process to make payments available in your store is by configuring an affiliation (related to the provider you have a contract with) and a method in the Admin. Instructions for this process are found mostly in our Help Center, but some configurations are more advanced and described in the articles below:

Configuring payments for specific use cases

When adding or editing a payment configuration in your store, you might need specific use cases such as defining a type of interest rate or processing payments through an external seller. Check the articles below for more information:

Developing a payment integration

Payment providers can implement their integrations using our Payment Provider Protocol. This protocol enables providers to create a payment connector that interacts with our Gateway and contains the endpoints described in our Payment Provider Protocol API. Besides developing the connector, providers also need to test them and make sure they follow the required security standards before they can be available to the stores. You can check the details for those steps in the articles below:

Below there are the steps you usually need to follow to implement an integration:

  1. If your integration supports credit, debit or co-branded cards, before start developing, you have to assure that your payment connector follows one of these conditions:
    • The connector is hosted in a secure environment that follows the PCI - DSS security standards. An Attestation of Compliance (AOC) is required in this case.
    • The connector is developed by using Secure Proxy, where it receives tokens instead of sensitive data related to the card transaction, and the Gateway acts as a proxy to communicate with the acquirer.
  2. Implement your payment connector according to our Payment Provider Protocol. This includes all the required endpoints. All the payment methods supported by your integration will have to be listed in the response of the List Payment Provider Manifest endpoint. Also, for each payment method, you will have to implement a specific behavior for the Create Payment endpoint.
  3. Install your connector in a store and perform the homologation step. Here you will test each endpoint of your connector using the Payment Provider Test Suite app.
  4. After your connector passes all the tests, open a ticket so our team can carry out the homologation process.

Customizing your payment integration

When developing a payment integration, you might need to add specific features. You can enable specific payment methods that require additional work (i.e.: Pix), create a custom flow or add a validation step in the Checkout (Payment App), among other options. You can check our available options in the articles below:


{"base64":"  ","img":{"width":1454,"height":1135,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1028404,"url":""}}

Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page