Payments Gateway API
Onboarding guide
Check the Payments onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.
The Payments Gateway API allows you to get payment data and process your store's transactions.
Payments Gateway API Index
Installments
Configuration
GETList all affiliationsPOSTInsert a new affiliationPUTUpdate affiliation by IDGETGet affiliation by IDGETList all payment rulesPOSTInsert a new payment ruleGETGet payment rule by IDPUTUpdate payment rule by IDDELETEDelete payment rule by IDGETList all available payment methodsGETGet card data
Transaction Process
POSTStarts a new transactionPOSTSend payments informationPOSTSend additional dataPATCHUpdate additional data (optional)POSTAuthorize new transactionGETGet transaction detailsGETGet payment detailsGETGet transaction settlement details
Transaction Flow
POSTSettle the transactionPOSTRefund the transactionPOSTCancel the transaction
Payment Notification
Endpoints
Installments
| Summary | Method | Path |
|---|---|---|
| Get installments options | GET | /api/pvt/installments |
Configuration
| Summary | Method | Path |
|---|---|---|
| List all affiliations | GET | /api/pvt/affiliations |
| Insert new affiliation | POST | /api/pvt/affiliations |
| Update affiliation by ID | PUT | /api/pvt/affiliations/{affiliationId} |
| Get affiliation by ID | GET | /api/pvt/affiliations/{affiliationId} |
| List all payment rules | GET | /api/pvt/rules |
| Insert a new payment rule | POST | /api/pvt/rules |
| Get payment rule by ID | GET | /api/pvt/rules/{ruleId} |
| Update payment rule by ID | PUT | /api/pvt/rules/{ruleId} |
| Delete payment rule by ID | DELETE | /api/pvt/rules/{ruleId} |
| List all available payment methods | GET | /api/pvt/merchants/payment-systems |
| Get card data | GET | /api/payments/pvt/account/{cardId} |
Transaction process
| Summary | Method | Path |
|---|---|---|
| Start a new transaction | POST | /api/pvt/transactions |
| Send payments information | POST | /api/payments/transactions/{transactionId}/payments |
| Send additional data | POST | /api/pvt/transactions/{transactionId}/additional-data |
| Update additional data | PATCH | /api/pvt/transactions/{transactionId}/additional-data |
| Authorize new transaction | POST | /api/pvt/transactions/{transactionId}/authorization-request |
| Get transaction details | GET | /api/pvt/transactions/{transactionId} |
| Get payment details | GET | /api/pvt/transactions/{transactionId}/payments/{paymentId} |
| Get transaction settlement details | GET | /api/pvt/transactions/{transactionId}/settlements |
Payment notification
| Summary | Method | Path |
|---|---|---|
| Send payment notification with payment ID | GET | /api/payments/pvt/payments/{paymentId}/payment-notification |
| Send payment notification with payment ID, date, and value paid | POST | /api/payments/pvt/payments/{paymentId}/payment-notification |
Transaction flow
| Summary | Method | Path |
|---|---|---|
| Settle the transaction | POST | /api/pvt/transactions/{transactionId}/settlement-request |
| Refund the transaction | POST | /api/pvt/transactions/{transactionId}/refunding-request |
| Cancel the transaction | POST | /api/pvt/transactions/{transactionId}/cancellation-request |