Retrieves the merchant credentials (applicationId, appKey and appToken) registered with the payment provider. These credentials will be saved in the VTEX system and activated when the retailer decides to enable the connector.

Get credentials

Use the application of provider for merchant's authentication.

Provider authentication

Exposes the provider manifest, including metadata settings such as payment methods, split configuration, and custom fields.

List Payment Provider Manifest

Creates the authorization token that will be used for VTEX to redirect the merchant to the provider's authentication application. For more information about the Payment Provider Protocol (PPP) merchant authentication procedure, visit [Configuration Flow](https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider#configuration-flow).

Create authorization token

Creates a new payment and initiates the payment flow.

Create payment

Cancels a payment that was not yet approved or settled.

Cancel payment

The Inbound request (BETA) implements an URL that facilitates a direct connection between VTEX Gateway service and the Payment Provider. This functionality allows the payment provider to create other types of specific routes, in addition to those described in the other PPP endpoints, according to their type of operation (e.g. hook or enrollment routes, among others).

Inbound request (BETA)

Refunds a payment (in full or in part) that was previously settled.

Refund payment

Settles a payment that was previously approved.

Settle payment

To achieve this, you must implement a web API (REST) following the specifications described in this documentation.