Payment Provider Protocol
The integration standard that defines how payment providers connect to the VTEX Gateway.
The Payment Provider Protocol (PPP) is the integration standard that defines how payment providers connect to the VTEX Gateway. Through the PPP, providers can authorize, settle, refund, and cancel transactions on the VTEX platform.
There are two ways to build a payment connector:
- External middleware: Develop your own backend service that implements the PPP endpoints.
- VTEX IO (Payment Provider Framework): Use a VTEX IO boilerplate that provides the endpoint structure out of the box.
Before starting, you need a partnership agreement for financial services and access to a VTEX environment. Providers processing credit, debit, or co-branded cards must also meet PCI DSS compliance requirements or use Secure Proxy.
In this section
| Article | Description |
|---|---|
| Integrating a new payment provider on VTEX | End-to-end overview of the steps to integrate a payment provider. |
| Implementing a Payment Provider | How to develop the middleware that implements the PPP endpoints. |
| Payment Provider Framework | How to build a connector on VTEX IO using the PPP boilerplate. |
| PPP Versioning | Protocol version history and migration notes. |
| PPP applied to POS | How to use the PPP for physical store payments with VTEX Sales App. |
| Split Payouts on Payment Provider Protocol | How to configure split payouts for marketplace transactions. |
Learn more about the protocol flow in the Help Center tutorial and the Payment Provider Protocol API.