This is a guide intended for payment providers that want to offer PSE payment method in a VTEX store. As part of the order transaction flow, it is necessary to inform the connector that will process the payment which bank was selected by the customer.

To provide this information in a way that is frictionless to the shopper experience, follow the steps below:

1. Send banks and authentication information to VTEX.
2. Update the List Payment Provider Manifest API.
3. POST Create Payment configuration.
4. Request through the VTEX Support Portal for the payment connector update.

To carry out the integration of the PSE, it is necessary to have a partnership contract with VTEX. If you do not have the contract, access VTEX Support Portal.

To start the PSE integration process, VTEX needs to receive information that will allow performing the necessary setting in API requests.

The following information should be sent to VTEX:

• GET Banks endpoint used by you to list the banks available to the customer. It should include the response body and any additional information required.
• Authentication key information required to perform the GET request call.

See below an example of the GET Banks endpoint that VTEX will make:

If there are additional steps to build the auth-token, it should also be described.

After that, VTEX expects a response body following the structure described below:

After forwarding the banking and authentication information to VTEX, it will be necessary for the payment provider to update information in the API, so that the PSE is recognized as a payment method.

The following PSE information should be added on List Payment Provider Manifest API.

The bank selected by the shopper will be sent to the connector on the authorization request in the following format:

Use the bankCode attribute inside the metadata object to create the payment in the PSE and return the paymentUrl in order to redirect the buyer to the bank's authentication. Keep in mind that the metadata field can also be null, so the connector should also handle this case by throwing an error with the following error code: PSE_CUSTOM_APP_NOT_FOUND.

The PSE payment method requires a pre-condition to be processed (bank selection by shopper) and it occurs in an external payment environment. Then, in addition to the fields present in a standard response body, you should use the following fields in the create payment response body:

• status: undefined
• paymentUrl: bank’s authentication page

For more information, check POST Create Payment documentation.

By selecting the PSE payment method at checkout, your customers will be redirected to the bank environment (page). There, they will complete the necessary authentication (specified according to the chosen bank). After that, there are two possible scenarios: Payment approved (a page containing the order details is shown) or Payment denied (a page containing the specific error is shown).