The paymentProvider builder configures the payment methods of a payment connector built using the Payment Provider Framework (PPF).

Payment connectors are developed on VTEX following the Payment Provider Protocol (PPP), a set of rules and endpoints that define the connector behavior and publishing process. They connect the VTEX Payment Gateway with financial institutions (issuing banks, card networks, etc.) to process payment data. Payment connectors can be developed to support multiple payment methods (credit cards, digital wallets, notes payable, etc.) and conditions (split payment, installments, etc.).

Developing a payment connector with PPF accelerates the process using an IO app boilerplate, since all the payment routes and functions available in the PPP are declared in the code. See the Payment Provider Framework article for more details about the connector implementation.

The paymentProvider builder uses a folder named paymentProvider located in the app's root folder. This folder contains a single file: configuration.json.

• configuration.json: Defines the payment methods of the connector and the response of the /manifest route of the connector, so you don't need to include the response body of this route in the code.

To develop an app using the paymentProvider builder, follow the steps below:

1. Start with a template: Download the payment-provider-example template or create a new project using the vtex init CLI command and choose the payment-provider-example option. This template provides a payment connector developed with the Payment Provider Framework.
2. Configure the manifest: Edit the configuration.json file to define the payment methods of the connector and the supported split options. This will define the response body of the /manifest route of the connector. There are also configurable options such as using anti-fraud solutions and Secure Proxy.
3. Implement the app's logic: Edit the TypeScript files inside the node folder to define the behavior of each payment route of the connector. See the Payment Provider Framework guide for more details.
4. Testing: Link the app to a development workspace for testing. To test the payment routes with the connector, install the Payment Provider Test Suite app in your workspace and follow the steps in the Payment Provider Homologation guide.