VTEX Developer Portal

In VTEX, stores and partners can integrate some of their services into our system by using integration protocols - a set of conditions that must be followed in order to properly establish communication with VTEX.

As every service has its own particularities, VTEX provides an integration protocol for each one. This applies to the Payment Provider Protocol, the protocol created to assist institutions that work with payments and financial transactions to integrate with VTEX.

Before continuing, make sure you are familiar with some terms that will frequently appear in this guide:

  • Acquirer: an acquirer is a company that specializes in processing payments. For more information, refer to What is an acquirer.
  • Merchant or Client: a client that holds its ecommerce operations in VTEX platform.
  • Customer: an individual or business that purchases a product or service from a VTEX client.
  • Provider: it can be a payment system, a gateway, or a provider. The agent that will process the merchant's payments.
  • Partner: the agent responsible to carry out the integration between the provider and VTEX’s SmartCheckout.
  • VTEX Payment Gateway: VTEX system responsible for processing payments. The gateway communicates with the provider through the payment provider protocol
  • Payment Service Provider (PSP): a PSP is a financial entity that is authorized to process financial transactions between merchants, acquiring banks, and card networks. It is a fast and cost-effective way to accept payments without needing to open a company in another country or having to create a merchant account.
  • Payload: request body in JSON format.
  • Connector: the provider’s affiliation that works as a bridge between the provider and VTEX’s SmartCheckout.
  • Oauth: it is an authorization protocol made for APIs. It allows the provider system to access the customer data to process a transaction.

The sections of this tutorial will present the main concepts and guide you through the steps required to complete an integration using the Payment Provider Protocol.

Structure of this guide

Article

Description

Payment Provider Protocol

An overview of our Payment Provider Protocol and how it works.

PCI - DSS Compliance

What the PCI-DSS Certification is and why it is required.

Payment Methods

An explanation of what payment methods are and what types are accepted by VTEX.

Purchase Flows

How the payment flow works and which operations are involved in this process.

Implementing a Payment Provider

Walkthrough of the API endpoints that your middleware must implement to adhere to our Payment Provider Protocol, along with activation instructions.

Payment Provider Homologation

How to proceed with the homologation process in order to check if the integration was done correctly.

Pix: Instant Payments in Brazil

An explanation of what the PIX payment method is and how to use it in your store.

Installing Affirm Payment App

How to install the Affirm Payment App in your store.

Payment App

An explanation of what the Payment App is and how to use it in your store.

Split Payouts on Payment Provider Protocol

An overview of our Split Payouts process on the Payment Provider Protocol and how it works.

Use Cases and Additional Resources
(Article under development)

A final (optional) step covering some use cases and some additional resources to illustrate how the payment provider protocol works in the daily routine.

👍

Become a VTEX Partner

To integrate a payment solution in VTEX you must fill out the registration form to join our Partner Program to get access to your own VTEX account.

If you are already a client or partner, you can open a support ticket if you have any questions.

Updated 17 days ago



Payments


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.