Payment Provider Protocol API

The Payment Provider Protocol is a set of definitions to help you integrate your payment processing API into the VTEX platform, including sub-acquirers, acquirers, gateways, and custom payment services.

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

To learn more about the Payment Provider Protocol, check our Help Center article.

Endpoint requirements

• Must use a standard subdomain/domain name, not an IP address.
• Must be served over HTTPS on port 443 with TLS 1.2 support.
• Must respond in less than 5 seconds when running the tests.
• Must respond in less than 20 seconds when in production.
• Must be PCI-DSS compliant or use Secure Proxy to accept branded cards like Visa, Mastercard, Amex, etc.

Testing

You can perform tests on your payment provider using our VTEX - Payment Provider Test Suite.

An extra header X-VTEX-API-Is-TestSuite = true will be sent for every test suite request, to help you easily identify it and mock any required scenarios.

For more details about testing a Payment Provider, check our Payment Provider Homologation article.

Common parameters in the documentation

{{providerApiEndpoint}}	Provider's endpoint for the implementation.
{{X-PROVIDER-API-AppKey}}	Unique identifier created by the provider and configured on the provider configuration page (Admin VTEX).
{{X-PROVIDER-API-AppToken}}	Unique token created by the provider and configured on the provider configuration page (Admin VTEX).

Payment Provider Protocol API Index

Payment Flow

• GET List Payment Provider Manifest
• POST Create payment
• POST Cancel payment
• POST Settle payment
• POST Refund payment
• POST Inbound request (BETA)

Configuration Flow

• POST Create authorization token
• GET Provider authentication
• GET Get credentials