API Reference

Integration Guides

Communication between systems and services of stores, partners and platform is carried out through integration protocols. At VTEX, we use the Payment Provider Protocol (PPP), a protocol created to assist companies that carry out financial transaction operations.

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

  • Acquirer: a company that specializes in payment processing. For more information, access What is an acquirer?.
  • Merchant or Client: an individual or business that holds its ecommerce or physical stores operations in the VTEX platform.
  • Customer: an individual or business that purchases a product or service from a VTEX client.
  • Provider: agent that will process the merchant's payments. It can be a payment system, payment provider, or a gateway.
  • Partner: agent responsible to carry out the integration between the provider and the VTEX platform.
  • VTEX Payment Gateway: VTEX system responsible for processing payments. The gateway communicates with the provider through the Payment Provider Protocol (PPP).
  • Payment Service Provider (PSP): 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: set of data sent in JSON format through a request body of an endpoint.
  • Connector: provider affiliation that acts as a bridge between the provider and the VTEX checkout.
  • Oauth: authorization protocol made for Application Programming Interfaces (APIs). It allows the provider system to access the customer data to process a payment transaction.

The articles listed below present the characteristics and mode of operation of our payment architecture, providing implementation information to allow you to integrate your payment service into VTEX or use the payment solutions already available.

Structure of this guide

Integrating a new payment provider on VTEXA step-by-step guide to integrating your payment provider into VTEX.
Payment Provider ProtocolOverview of our integration protocol, the Payment Provider Protocol (PPP).
Payment Provider Protocol applied to payment with POSPPP information for use in physical stores.
Implementing a Payment ProviderHow to develop your middleware to communicate with the PPP.
Payment Provider FrameworkOverview of our alternative method of developing payment connectors through VTEX IO.
Purchase FlowsInformation on the types of payment flows available on VTEX.
Payment AppOverview of the Payment App and how to implement it in your store.
Payment MethodsOverview of payment methods accepted by VTEX.
Payment Provider HomologationHow to carry out the tests to request the approval of your payment connector.
Anti-fraud Provider ProtocolOverview of our anti-fraud integration protocol, the Anti-fraud Provider Protocol.
PCI - DSS ComplianceInformation about the PCI-DSS certification and when it is required.
Secure ProxyInformation about the VTEX solution for transferring sensitive data in an environment without the use of PCI - Dss certification.
Split Payouts on Payment Provider ProtocolOverview of our Split Payouts process on the PPP.
Layout Development Guide for payment methods in Smart Checkout VTEXHow to develop a custom layout for your payment method.
Custom Auto Capture FeatureInformation from the VTEX solution created to define a custom delay interval for automatically capturing payments.
Pix: Instant Payments in BrazilHow to implement the PIX payment method in your store.
PSE Payment MethodHow to implement the PSE payment method in your store.
Installing Affirm Payment AppHow to implement the Affirm Payment App payment method in your store.
Google Pay: processing information for payment providers and anti-fraudHow the Google Pay payment method is identified in transactions.

✔️ 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.

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