The Payment Provider Protocol is a public contract for those who want to integrate its payment providers into the VTEX platform. In other words, It is the protocol that defines how a Payment Service Provider must integrate with the VTEX SmartCheckout system.

This resource enables us to increase the range of payment methods and partner options that we can offer to our merchants. This way, they have more options to create a strategy aligned with their market needs. It is important to mention that integration is only possible if the store or the partner fulfills some criteria.

Our protocol is composed of nine endpoints, all public and documented in the Developer Portal. To check more details about each one of them, go to the Payment Provider Protocol API overview page. More information about the integration steps can be found in the correspondent Help Center article.

To develop a new payment connector, it is mandatory to follow the prerequisites determined by VTEX. You can learn about them in the Implementation prerequisites section of our Payment Provider Protocol article.