Payment Policies API
The Payment Policies API allows VTEX merchants to configure rules that include or exclude payment systems for specific cart items. The Payment Configuration Service (PCS) stores policy rules, while the Payment Information Service (PIS) evaluates those rules during checkout and returns the payment systems available for each item.
This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Support.
Index
Payment policy rules
POSTCreate policy ruleGETList policy rulesGETGet policy rule by IDPUTUpdate policy ruleDELETEDelete policy rule
Payment policy evaluation
Rule engine
Currently the Payment policies feature supports
and,or,==, andinoperators, with a limit of 500 operators per expression. Available context variables arecollectionIds, containing the collection IDs associated with the item, andshippingState, containing the delivery state code.
Endpoints
Payment policy rules
| Summary | Method | Path |
|---|---|---|
| Create policy rule | POST | /api/payment-configuration-service/policy-rules |
| List policy rules | GET | /api/payment-configuration-service/policy-rules |
| Get policy rule by ID | GET | /api/payment-configuration-service/policy-rules/{id} |
| Update policy rule | PUT | /api/payment-configuration-service/policy-rules/{id} |
| Delete policy rule | DELETE | /api/payment-configuration-service/policy-rules/{id} |
Payment policy evaluation
| Summary | Method | Path |
|---|---|---|
| Evaluate payment policies | POST | /api/pvt/payment-systems/search |