This API manages and processes payments your system. Payments are monitored to ensure the orders, authorization, refunds, and cancellation processes are successful.
Additionally, authorization and payment method services are included to handle security and authorization with the payment service provider.
V1 and V2 payments
The Payments API has two versions to perform a purchase:
- V1 Payments, which are recommended for the DEUNA widget and the VTEX plugin.
- V2 Payments, which are recommended for direct API integrations
V1
V1 payments involve a two-step process where you create an order and then call the purchase endpoint to process a payment.
The V1 payment process goes as follows:
- User calls POST /merchants/order to get an
order token - User includes the
order_tokenin the request and calls POST /transactions/purchase to create the Payment.
V2
V2 purchases perform the two steps in a single endpoint by adding the order information in the request.
The V2 purchase process goes as follows:
- User calls POST v2/merchants/order/purchase with the order information in the cURL request.
- The internal service creates the order and performs the purchase operation.