From 074526de9c588174d68a67e5bc3a77171a78c37d Mon Sep 17 00:00:00 2001 From: Ricardo Correia Date: Fri, 7 Aug 2026 14:37:05 -0300 Subject: [PATCH 1/6] fix: payment policies api routes update --- VTEX - Payment Policies API.json | 122 +++++++++++++++++++++---------- 1 file changed, 82 insertions(+), 40 deletions(-) diff --git a/VTEX - Payment Policies API.json b/VTEX - Payment Policies API.json index 95f62581b..a57a026b0 100644 --- a/VTEX - Payment Policies API.json +++ b/VTEX - Payment Policies API.json @@ -8,38 +8,20 @@ }, "servers": [ { - "url": "https://{accountName}.pcs.vtexcommercestable.com.br", - "description": "Payment Configuration Service server URL.", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL.", - "default": "apiexamples" - } - } + "url": "https://pcs.vtexcommercestable.com.br", + "description": "Payment Configuration Service server URL." }, { - "url": "https://{accountName}.vtexpayments.com.br", - "description": "Payment Information Service server URL.", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL.", - "default": "apiexamples" - } - } + "url": "https://vtexpayments.com.br", + "description": "Payment Information Service server URL." } ], "paths": { "/api/payment-configuration-service/policy-rules": { "servers": [ { - "url": "https://{accountName}.pcs.vtexcommercestable.com.br", - "description": "Payment Configuration Service server URL.", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL.", - "default": "apiexamples" - } - } + "url": "https://pcs.vtexcommercestable.com.br", + "description": "Payment Configuration Service server URL." } ], "post": { @@ -50,6 +32,18 @@ "operationId": "createPolicyRule", "description": "Creates a payment policy rule for the VTEX account identified by the `accountName` URL variable. Policy rules define conditions that determine which payment systems are included or excluded when those conditions match a cart item.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ + { + "name": "an", + "in": "query", + "description": "Account name.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, { "$ref": "#/components/parameters/Content-Type" }, @@ -161,6 +155,18 @@ "operationId": "listPolicyRules", "description": "Lists the payment policy rules configured for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ + { + "name": "an", + "in": "query", + "description": "Account name.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, { "$ref": "#/components/parameters/Accept" } @@ -226,14 +232,8 @@ "/api/payment-configuration-service/policy-rules/{id}": { "servers": [ { - "url": "https://{accountName}.pcs.vtexcommercestable.com.br", - "description": "Payment Configuration Service server URL.", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL.", - "default": "apiexamples" - } - } + "url": "https://pcs.vtexcommercestable.com.br", + "description": "Payment Configuration Service server URL." } ], "get": { @@ -244,6 +244,18 @@ "operationId": "getPolicyRuleById", "description": "Retrieves a payment policy rule by ID for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ + { + "name": "an", + "in": "query", + "description": "Account name.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, { "$ref": "#/components/parameters/PolicyRuleId" }, @@ -313,6 +325,18 @@ "operationId": "updatePolicyRule", "description": "Replaces a payment policy rule for the VTEX account identified by the `accountName` URL variable. Send the same request body used to create a rule. Do not include response-only fields such as `id`, `createdAt`, or `updatedAt`, and do not send a `version` field because concurrency is handled server-side.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ + { + "name": "an", + "in": "query", + "description": "Account name.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, { "$ref": "#/components/parameters/PolicyRuleId" }, @@ -433,6 +457,18 @@ "operationId": "deletePolicyRule", "description": "Deletes a payment policy rule for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ + { + "name": "an", + "in": "query", + "description": "Account name.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, { "$ref": "#/components/parameters/PolicyRuleId" } @@ -456,14 +492,8 @@ "/api/pvt/payment-systems/search": { "servers": [ { - "url": "https://{accountName}.vtexpayments.com.br", - "description": "Payment Information Service server URL.", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL.", - "default": "apiexamples" - } - } + "url": "https://vtexpayments.com.br", + "description": "Payment Information Service server URL." } ], "post": { @@ -474,6 +504,18 @@ "operationId": "evaluatePaymentPolicies", "description": "Evaluates active payment policy rules against cart item context and returns payment systems available for each item. Payment systems not mentioned in any matching rule remain available by default. You can also use this endpoint to validate which payment systems are available for cart items before checkout continues.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ + { + "name": "an", + "in": "query", + "description": "Account name.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, { "$ref": "#/components/parameters/Content-Type" }, From 0ee833eae64dfb2417aa115cb38d6dce0121d256 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Fri, 7 Aug 2026 17:40:49 +0000 Subject: [PATCH 2/6] chore: update postman files --- .../VTEX - Payment Policies API.json | 509 +++++++++++++++--- 1 file changed, 422 insertions(+), 87 deletions(-) diff --git a/PostmanCollections/VTEX - Payment Policies API.json b/PostmanCollections/VTEX - Payment Policies API.json index ea5c5b177..987d9bc99 100644 --- a/PostmanCollections/VTEX - Payment Policies API.json +++ b/PostmanCollections/VTEX - Payment Policies API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "4c301992-b388-4642-a143-2d70a80f205f" + "postman_id": "38619a57-45d4-4fb1-bcb2-3314921db515" }, "item": [ { - "id": "f9591204-9f82-4c03-8b1f-fa2bb5393e94", + "id": "4565069a-f598-47f2-acb9-8fc1333ce10d", "name": "Payment policy rules", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "f66d807e-a5d5-43a0-a661-55835ff80221", + "id": "3740408f-d514-4999-a9d2-72799bceb8b8", "name": "Create policy rule", "request": { "name": "Create policy rule", @@ -29,7 +29,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -77,7 +87,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1b69342e-1e33-47ba-b39c-72312628e791", + "id": "b3d8f2b8-3c2c-4c04-a007-a43e91f406e5", "name": "Created", "originalRequest": { "url": { @@ -89,7 +99,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -155,7 +175,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7cb9177e-259c-47c5-960b-b819ecc13c94", + "id": "fbd25a95-7246-4fe9-b6b3-eb8b77de5cba", "name": "Bad Request", "originalRequest": { "url": { @@ -167,7 +187,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -233,7 +263,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "79827f3a-593e-402d-b68a-dbb85e80f65f", + "id": "42f779e4-960e-42dc-ac16-cea0a2146061", "name": "Unauthorized", "originalRequest": { "url": { @@ -245,7 +275,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -311,7 +351,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "67e487db-dc32-4508-ba7a-422108bac00e", + "id": "c8c93151-282e-4150-9fbd-3146cba96e78", "name": "Forbidden", "originalRequest": { "url": { @@ -323,7 +363,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -389,7 +439,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "99eecee7-4bb5-4470-b90b-39b3830f87f2", + "id": "ae27376a-e614-4a2e-b5b5-7100315cfaa0", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -401,7 +451,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -468,7 +528,7 @@ { "listen": "test", "script": { - "id": "5c9b294e-a8f6-49b5-9b3f-a87b55f074e0", + "id": "e3d3e570-0747-40e6-be80-bc0e853ecbd1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -484,7 +544,7 @@ } }, { - "id": "09119e83-02c4-4246-a17c-6afb10f1dc2a", + "id": "3e9d9807-6f87-454b-b489-6b4aa747eab1", "name": "List policy rules", "request": { "name": "List policy rules", @@ -501,7 +561,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -527,7 +597,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "bd2a18a2-1c38-46fe-bdaf-4050519722d5", + "id": "42f620f0-3eef-49f3-87cc-0f970023a8c6", "name": "OK", "originalRequest": { "url": { @@ -539,7 +609,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -583,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1ac3d693-cddd-4a81-9cbd-2414c3ec10e9", + "id": "76048d28-9192-4cde-9b6d-4a30d1d4570a", "name": "Unauthorized", "originalRequest": { "url": { @@ -595,7 +675,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -639,7 +729,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "948e7c5d-018c-409c-b468-aa547717e2a6", + "id": "344b2d68-0de5-413e-9193-eb50560f1d86", "name": "Forbidden", "originalRequest": { "url": { @@ -651,7 +741,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -696,7 +796,7 @@ { "listen": "test", "script": { - "id": "494f56ff-3da4-4ec1-8d51-879644f004c8", + "id": "fd405ef6-b2b9-463a-8e6a-0c91fc1f10e8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -712,7 +812,7 @@ } }, { - "id": "7b860541-571d-4dee-aa45-35996ce9c862", + "id": "87d34181-12d9-4f45-a30b-99097a14e41a", "name": "Get policy rule by ID", "request": { "name": "Get policy rule by ID", @@ -730,7 +830,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [ { "disabled": false, @@ -739,7 +849,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud in adipisicing culpa", + "value": "consectetur qui reprehenderit Duis dolore", "key": "id" } ] @@ -767,7 +877,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f0507bff-69a1-4866-9135-aef1e8e240d0", + "id": "af6719a4-3369-4f64-b609-3b9a110c0490", "name": "OK", "originalRequest": { "url": { @@ -780,7 +890,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -824,7 +944,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "11a9f98b-7d74-4d20-82f7-95018cf2678d", + "id": "366b6070-a682-40b5-b6b2-e5a46afd9eaa", "name": "Unauthorized", "originalRequest": { "url": { @@ -837,7 +957,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -881,7 +1011,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f3db78f1-5cb3-4dc1-8f2a-c2a7e7221b89", + "id": "96234d7c-de08-4dba-979b-3c9e2aa00641", "name": "Forbidden", "originalRequest": { "url": { @@ -894,7 +1024,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -938,7 +1078,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1ffbae44-a411-41e3-8521-6e3d7955dd85", + "id": "38e47fdf-67ac-4a5d-962b-b50953342afe", "name": "Not Found", "originalRequest": { "url": { @@ -951,7 +1091,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -996,7 +1146,7 @@ { "listen": "test", "script": { - "id": "535f67d4-d644-4107-bee8-8ad95e794476", + "id": "b9dd510c-73c2-4841-bf23-eb128d94bf49", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1012,7 +1162,7 @@ } }, { - "id": "52228949-64ef-42f2-b471-93b94e952052", + "id": "57bb1ea7-51d9-4eba-957b-79fb11aaf3bd", "name": "Update policy rule", "request": { "name": "Update policy rule", @@ -1030,7 +1180,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [ { "disabled": false, @@ -1039,7 +1199,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud in adipisicing culpa", + "value": "consectetur qui reprehenderit Duis dolore", "key": "id" } ] @@ -1089,7 +1249,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "88e29a4d-1ff3-46fd-9ed8-62c69e5e1d8c", + "id": "2d4485d7-ed96-43ea-8588-38c2cb750c3e", "name": "OK", "originalRequest": { "url": { @@ -1102,7 +1262,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1168,7 +1338,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f66b4ec5-c3d4-44f8-b139-1d3f4bac1a4f", + "id": "9a4f847e-5d28-450f-8eae-2910625d227b", "name": "Bad Request", "originalRequest": { "url": { @@ -1181,7 +1351,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1247,7 +1427,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5c5cf1aa-0077-4b9f-8a1e-7403ecc8607f", + "id": "8e81448a-42b4-401b-86f9-fea913b6a03c", "name": "Unauthorized", "originalRequest": { "url": { @@ -1260,7 +1440,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1326,7 +1516,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "be8fea73-df9a-4ce9-ad4e-522692b97175", + "id": "4905ac40-f546-4a93-bccd-01ac6e426341", "name": "Forbidden", "originalRequest": { "url": { @@ -1339,7 +1529,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1405,7 +1605,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "907e80cd-3c13-427b-abbb-83d55da19c7d", + "id": "ff752cc8-f532-4a9d-b163-82c22b8fd4da", "name": "Not Found", "originalRequest": { "url": { @@ -1418,7 +1618,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1484,7 +1694,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "210ad315-d0da-4f7c-8168-c1d35063ef5f", + "id": "17801037-8afd-4a50-8480-c0266756fbb2", "name": "Conflict", "originalRequest": { "url": { @@ -1497,7 +1707,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1563,7 +1783,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c32258bc-c87c-439d-8deb-4584db90d77c", + "id": "574844a4-0cde-4bfb-b413-b4f8fe82439f", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -1576,7 +1796,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1643,7 +1873,7 @@ { "listen": "test", "script": { - "id": "9b6ccef6-e5a3-43b3-a775-06b79016d6b3", + "id": "8498ab3d-931a-4782-925a-c99471b47ef1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1659,7 +1889,7 @@ } }, { - "id": "4c299793-6410-4277-a080-29119f153ce9", + "id": "0dfa4f7f-31d5-48cc-9bba-2ad686ae9b4b", "name": "Delete policy rule", "request": { "name": "Delete policy rule", @@ -1677,7 +1907,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [ { "disabled": false, @@ -1686,7 +1926,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud in adipisicing culpa", + "value": "consectetur qui reprehenderit Duis dolore", "key": "id" } ] @@ -1705,7 +1945,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "81fe67aa-d571-46ba-a24e-9b587df381cb", + "id": "97e3c83c-b492-470b-8e97-a6c9be4b5b73", "name": "No Content", "originalRequest": { "url": { @@ -1718,7 +1958,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1743,7 +1993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4f0eb659-32e4-4608-ab40-36d0406628e9", + "id": "f7d3a0ba-62bb-4e6e-af7d-7cae92f6996f", "name": "Unauthorized", "originalRequest": { "url": { @@ -1756,7 +2006,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1791,7 +2051,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d9b563b8-73ba-46d4-b771-347f5010133a", + "id": "a10c47f7-c3d0-4224-87e2-f15c2376702e", "name": "Forbidden", "originalRequest": { "url": { @@ -1804,7 +2064,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1839,7 +2109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f7e9cf53-5485-4220-9e48-107c02d5d1d9", + "id": "21596b24-28d7-45a5-a0ae-51a3ffd7e964", "name": "Not Found", "originalRequest": { "url": { @@ -1852,7 +2122,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1888,7 +2168,7 @@ { "listen": "test", "script": { - "id": "cb64fb71-54e9-4d6e-9b64-daf3c20c07fe", + "id": "a10991bd-679b-423c-91fe-28d846c181dd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1905,7 +2185,7 @@ "event": [] }, { - "id": "caea438d-df2a-4329-a37a-03fd6dcdeaaf", + "id": "c5a25625-0c86-477d-a840-2683c1948761", "name": "Payment policy evaluation", "description": { "content": "", @@ -1913,7 +2193,7 @@ }, "item": [ { - "id": "ca1a0f44-03ed-4be2-a8c8-ee8d239bd0c0", + "id": "927d673f-ecee-4ebf-ab54-cf0b3ac777b0", "name": "Evaluate payment policies", "request": { "name": "Evaluate payment policies", @@ -1931,7 +2211,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -1979,7 +2269,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8dc025e4-84d6-4cdf-a7e5-b50bb5e61944", + "id": "1df8d2cc-08f5-45c0-91ce-3191f8fab518", "name": "OK", "originalRequest": { "url": { @@ -1992,7 +2282,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -2058,7 +2358,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "11a6f5a7-319a-41ce-9d92-b5872a4d3f40", + "id": "59932d7a-7e68-432f-adbf-9fea00244aab", "name": "Bad Request", "originalRequest": { "url": { @@ -2071,7 +2371,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -2137,7 +2447,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cf7fb6e6-816a-4b03-943e-4d7fbca4f2a0", + "id": "ee9990a8-515a-44cc-a8f0-44e728ce7ff4", "name": "Unauthorized", "originalRequest": { "url": { @@ -2150,7 +2460,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -2216,7 +2536,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c2141685-72bf-4350-948d-eb850c9469f6", + "id": "64301a95-a472-468b-b521-432f34b7a07f", "name": "Forbidden", "originalRequest": { "url": { @@ -2229,7 +2549,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -2295,7 +2625,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a6a6da17-de7b-409d-b3a2-ce0ff54cff6f", + "id": "f1eff0a5-a75d-4ab8-8f92-1ac7b8ea8a7c", "name": "Request Timeout", "originalRequest": { "url": { @@ -2308,7 +2638,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Account name.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], "variable": [] }, "header": [ @@ -2375,7 +2715,7 @@ { "listen": "test", "script": { - "id": "c1929bc7-4079-411e-bbd1-42690df4cf06", + "id": "00045964-28dc-4be2-91ef-f563aa6fd751", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/pvt/payment-systems/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2418,17 +2758,12 @@ "variable": [ { "type": "any", - "value": "apiexamples", - "key": "accountName" - }, - { - "type": "any", - "value": "https://{{accountName}}.pcs.vtexcommercestable.com.br", + "value": "https://pcs.vtexcommercestable.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "4c301992-b388-4642-a143-2d70a80f205f", + "_postman_id": "38619a57-45d4-4fb1-bcb2-3314921db515", "name": "Payment Policies API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 0ac70146446f99eb32af2aeb991b2b7f15a9762e Mon Sep 17 00:00:00 2001 From: Ricardo Correia Date: Fri, 7 Aug 2026 17:55:12 -0300 Subject: [PATCH 3/6] Fix comments --- VTEX - Payment Policies API.json | 88 +++++++++----------------------- 1 file changed, 23 insertions(+), 65 deletions(-) diff --git a/VTEX - Payment Policies API.json b/VTEX - Payment Policies API.json index a57a026b0..7fff19c30 100644 --- a/VTEX - Payment Policies API.json +++ b/VTEX - Payment Policies API.json @@ -30,19 +30,10 @@ ], "summary": "Create policy rule", "operationId": "createPolicyRule", - "description": "Creates a payment policy rule for the VTEX account identified by the `accountName` URL variable. Policy rules define conditions that determine which payment systems are included or excluded when those conditions match a cart item.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Creates a payment policy rule for the VTEX account identified by the `an` query parameter. Policy rules define conditions that determine which payment systems are included or excluded when those conditions match a cart item.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { - "name": "an", - "in": "query", - "description": "Account name.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "cosmetics2" - } + "$ref": "#/components/parameters/An" }, { "$ref": "#/components/parameters/Content-Type" @@ -153,19 +144,10 @@ ], "summary": "List policy rules", "operationId": "listPolicyRules", - "description": "Lists the payment policy rules configured for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Lists the payment policy rules configured for the VTEX account identified by the `an` query parameter.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { - "name": "an", - "in": "query", - "description": "Account name.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "cosmetics2" - } + "$ref": "#/components/parameters/An" }, { "$ref": "#/components/parameters/Accept" @@ -242,19 +224,10 @@ ], "summary": "Get policy rule by ID", "operationId": "getPolicyRuleById", - "description": "Retrieves a payment policy rule by ID for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Retrieves a payment policy rule by ID for the VTEX account identified by the `an` query parameter.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { - "name": "an", - "in": "query", - "description": "Account name.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "cosmetics2" - } + "$ref": "#/components/parameters/An" }, { "$ref": "#/components/parameters/PolicyRuleId" @@ -323,19 +296,10 @@ ], "summary": "Update policy rule", "operationId": "updatePolicyRule", - "description": "Replaces a payment policy rule for the VTEX account identified by the `accountName` URL variable. Send the same request body used to create a rule. Do not include response-only fields such as `id`, `createdAt`, or `updatedAt`, and do not send a `version` field because concurrency is handled server-side.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Replaces a payment policy rule for the VTEX account identified by the `an` query parameter. Send the same request body used to create a rule. Do not include response-only fields such as `id`, `createdAt`, or `updatedAt`, and do not send a `version` field because concurrency is handled server-side.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { - "name": "an", - "in": "query", - "description": "Account name.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "cosmetics2" - } + "$ref": "#/components/parameters/An" }, { "$ref": "#/components/parameters/PolicyRuleId" @@ -455,19 +419,10 @@ ], "summary": "Delete policy rule", "operationId": "deletePolicyRule", - "description": "Deletes a payment policy rule for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Deletes a payment policy rule for the VTEX account identified by the `an` query parameter.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { - "name": "an", - "in": "query", - "description": "Account name.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "cosmetics2" - } + "$ref": "#/components/parameters/An" }, { "$ref": "#/components/parameters/PolicyRuleId" @@ -505,16 +460,7 @@ "description": "Evaluates active payment policy rules against cart item context and returns payment systems available for each item. Payment systems not mentioned in any matching rule remain available by default. You can also use this endpoint to validate which payment systems are available for cart items before checkout continues.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { - "name": "an", - "in": "query", - "description": "Account name.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "cosmetics2" - } + "$ref": "#/components/parameters/An" }, { "$ref": "#/components/parameters/Content-Type" @@ -1641,6 +1587,18 @@ } }, "parameters": { + "An": { + "name": "an", + "in": "query", + "description": "Name of the VTEX account whose payment policy rules are being managed.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "apiexamples" + } + }, "Content-Type": { "name": "Content-Type", "in": "header", From 798d3cb2866504d18331073ff813bd0d5674151c Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Fri, 7 Aug 2026 20:59:26 +0000 Subject: [PATCH 4/6] chore: update postman files --- .../VTEX - Payment Policies API.json | 94 +++++++++---------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/PostmanCollections/VTEX - Payment Policies API.json b/PostmanCollections/VTEX - Payment Policies API.json index 987d9bc99..115366d4d 100644 --- a/PostmanCollections/VTEX - Payment Policies API.json +++ b/PostmanCollections/VTEX - Payment Policies API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "38619a57-45d4-4fb1-bcb2-3314921db515" + "postman_id": "d2c83350-9b95-49ee-8595-cf85548b1ddd" }, "item": [ { - "id": "4565069a-f598-47f2-acb9-8fc1333ce10d", + "id": "7bab5055-cca1-4d32-890b-50a05f939804", "name": "Payment policy rules", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "3740408f-d514-4999-a9d2-72799bceb8b8", + "id": "d3c8c29f-7cab-4aac-96d1-59e77590a493", "name": "Create policy rule", "request": { "name": "Create policy rule", @@ -87,7 +87,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b3d8f2b8-3c2c-4c04-a007-a43e91f406e5", + "id": "68146aee-970b-4581-b712-b3890ad269d1", "name": "Created", "originalRequest": { "url": { @@ -175,7 +175,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fbd25a95-7246-4fe9-b6b3-eb8b77de5cba", + "id": "33e97963-1af0-4f6c-b2ee-8ff8227d43a5", "name": "Bad Request", "originalRequest": { "url": { @@ -263,7 +263,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "42f779e4-960e-42dc-ac16-cea0a2146061", + "id": "9f7b7afe-569d-41f1-9295-0f7d42b47c11", "name": "Unauthorized", "originalRequest": { "url": { @@ -351,7 +351,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c8c93151-282e-4150-9fbd-3146cba96e78", + "id": "33250fbe-166b-48f4-a820-d0da023501c1", "name": "Forbidden", "originalRequest": { "url": { @@ -439,7 +439,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ae27376a-e614-4a2e-b5b5-7100315cfaa0", + "id": "422a0c80-1dca-485c-8eab-8fd95e9081b8", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -528,7 +528,7 @@ { "listen": "test", "script": { - "id": "e3d3e570-0747-40e6-be80-bc0e853ecbd1", + "id": "ec318a2c-39ab-4224-8974-22570d4595b9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -544,7 +544,7 @@ } }, { - "id": "3e9d9807-6f87-454b-b489-6b4aa747eab1", + "id": "3a851d47-7e6d-4938-a6db-f091c6bb15d5", "name": "List policy rules", "request": { "name": "List policy rules", @@ -597,7 +597,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "42f620f0-3eef-49f3-87cc-0f970023a8c6", + "id": "9331f8df-b9ce-4aae-987f-c252846095b1", "name": "OK", "originalRequest": { "url": { @@ -663,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "76048d28-9192-4cde-9b6d-4a30d1d4570a", + "id": "4a9bd25e-3121-4f32-b5dd-b21fe5be19dc", "name": "Unauthorized", "originalRequest": { "url": { @@ -729,7 +729,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "344b2d68-0de5-413e-9193-eb50560f1d86", + "id": "b2d73438-f497-425d-af27-bb03ea8ff2cf", "name": "Forbidden", "originalRequest": { "url": { @@ -796,7 +796,7 @@ { "listen": "test", "script": { - "id": "fd405ef6-b2b9-463a-8e6a-0c91fc1f10e8", + "id": "865598a1-b03e-4d8c-8377-b1c19370b2c9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -812,7 +812,7 @@ } }, { - "id": "87d34181-12d9-4f45-a30b-99097a14e41a", + "id": "685d8ac0-330b-453e-8118-c967d3b4cef9", "name": "Get policy rule by ID", "request": { "name": "Get policy rule by ID", @@ -849,7 +849,7 @@ "type": "text/plain" }, "type": "any", - "value": "consectetur qui reprehenderit Duis dolore", + "value": "nisi incididunt repreh", "key": "id" } ] @@ -877,7 +877,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "af6719a4-3369-4f64-b609-3b9a110c0490", + "id": "2472ec04-a14e-4515-b75a-17d31e927b4b", "name": "OK", "originalRequest": { "url": { @@ -944,7 +944,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "366b6070-a682-40b5-b6b2-e5a46afd9eaa", + "id": "f1e7e2b7-a968-496b-8904-8cf6f6a3d7a0", "name": "Unauthorized", "originalRequest": { "url": { @@ -1011,7 +1011,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "96234d7c-de08-4dba-979b-3c9e2aa00641", + "id": "65a3ca57-97f4-4042-a972-d85bb55bd31e", "name": "Forbidden", "originalRequest": { "url": { @@ -1078,7 +1078,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "38e47fdf-67ac-4a5d-962b-b50953342afe", + "id": "79848339-6b05-4606-be0c-b7f1f059cc27", "name": "Not Found", "originalRequest": { "url": { @@ -1146,7 +1146,7 @@ { "listen": "test", "script": { - "id": "b9dd510c-73c2-4841-bf23-eb128d94bf49", + "id": "394da93b-c9f4-4f9e-98eb-efe9a67bb54d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1162,7 +1162,7 @@ } }, { - "id": "57bb1ea7-51d9-4eba-957b-79fb11aaf3bd", + "id": "0cc29f22-8b92-4408-971f-892b1f20837a", "name": "Update policy rule", "request": { "name": "Update policy rule", @@ -1199,7 +1199,7 @@ "type": "text/plain" }, "type": "any", - "value": "consectetur qui reprehenderit Duis dolore", + "value": "nisi incididunt repreh", "key": "id" } ] @@ -1249,7 +1249,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2d4485d7-ed96-43ea-8588-38c2cb750c3e", + "id": "b7577f16-89e9-45d0-92ab-c188b35947b4", "name": "OK", "originalRequest": { "url": { @@ -1338,7 +1338,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9a4f847e-5d28-450f-8eae-2910625d227b", + "id": "cd5a95f4-cc05-4957-9976-48b32ffc92b0", "name": "Bad Request", "originalRequest": { "url": { @@ -1427,7 +1427,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8e81448a-42b4-401b-86f9-fea913b6a03c", + "id": "35b3cda9-e088-48a8-b6d3-03745dc14f67", "name": "Unauthorized", "originalRequest": { "url": { @@ -1516,7 +1516,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4905ac40-f546-4a93-bccd-01ac6e426341", + "id": "d8a929bd-721f-4978-8f06-b0dfe9dafee4", "name": "Forbidden", "originalRequest": { "url": { @@ -1605,7 +1605,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ff752cc8-f532-4a9d-b163-82c22b8fd4da", + "id": "4f6445ae-06ee-472a-a9d7-27e87196c697", "name": "Not Found", "originalRequest": { "url": { @@ -1694,7 +1694,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "17801037-8afd-4a50-8480-c0266756fbb2", + "id": "f51fc595-c03d-4182-8b7e-370db38d1998", "name": "Conflict", "originalRequest": { "url": { @@ -1783,7 +1783,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "574844a4-0cde-4bfb-b413-b4f8fe82439f", + "id": "1657054e-1c1b-4187-ab3d-35ac11dfa103", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -1873,7 +1873,7 @@ { "listen": "test", "script": { - "id": "8498ab3d-931a-4782-925a-c99471b47ef1", + "id": "a86aff3d-0df6-4be0-b8fc-0ee04baa0629", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1889,7 +1889,7 @@ } }, { - "id": "0dfa4f7f-31d5-48cc-9bba-2ad686ae9b4b", + "id": "b6bd7e56-f10b-4126-a6d6-3d7a7755b423", "name": "Delete policy rule", "request": { "name": "Delete policy rule", @@ -1926,7 +1926,7 @@ "type": "text/plain" }, "type": "any", - "value": "consectetur qui reprehenderit Duis dolore", + "value": "nisi incididunt repreh", "key": "id" } ] @@ -1945,7 +1945,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "97e3c83c-b492-470b-8e97-a6c9be4b5b73", + "id": "bf99354b-9415-4058-a3e8-f93b068eabb1", "name": "No Content", "originalRequest": { "url": { @@ -1993,7 +1993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f7d3a0ba-62bb-4e6e-af7d-7cae92f6996f", + "id": "250de28e-0ce4-47b2-9303-69d80328ff31", "name": "Unauthorized", "originalRequest": { "url": { @@ -2051,7 +2051,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a10c47f7-c3d0-4224-87e2-f15c2376702e", + "id": "2bbc4ed4-7627-4d01-b98f-ba174b9e0549", "name": "Forbidden", "originalRequest": { "url": { @@ -2109,7 +2109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "21596b24-28d7-45a5-a0ae-51a3ffd7e964", + "id": "7d386e15-8bdd-47ae-af36-e1c3d2e837b7", "name": "Not Found", "originalRequest": { "url": { @@ -2168,7 +2168,7 @@ { "listen": "test", "script": { - "id": "a10991bd-679b-423c-91fe-28d846c181dd", + "id": "a2287909-35ee-47a9-af37-d27aadfbd642", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2185,7 +2185,7 @@ "event": [] }, { - "id": "c5a25625-0c86-477d-a840-2683c1948761", + "id": "cf772a0c-480d-431d-b2f2-7258da9622ba", "name": "Payment policy evaluation", "description": { "content": "", @@ -2193,7 +2193,7 @@ }, "item": [ { - "id": "927d673f-ecee-4ebf-ab54-cf0b3ac777b0", + "id": "48096134-0050-4be2-8daf-1857ac291a6d", "name": "Evaluate payment policies", "request": { "name": "Evaluate payment policies", @@ -2269,7 +2269,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1df8d2cc-08f5-45c0-91ce-3191f8fab518", + "id": "98c24d39-7e94-4eab-9752-19a3f13bbad0", "name": "OK", "originalRequest": { "url": { @@ -2358,7 +2358,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "59932d7a-7e68-432f-adbf-9fea00244aab", + "id": "5f75bf4f-d385-42d5-bb45-f22fb3b17d33", "name": "Bad Request", "originalRequest": { "url": { @@ -2447,7 +2447,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ee9990a8-515a-44cc-a8f0-44e728ce7ff4", + "id": "93bf5d25-c9b6-48c8-8296-61944fe960fd", "name": "Unauthorized", "originalRequest": { "url": { @@ -2536,7 +2536,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "64301a95-a472-468b-b521-432f34b7a07f", + "id": "10c403ef-f15f-451e-9f92-4c17a9e1cb2b", "name": "Forbidden", "originalRequest": { "url": { @@ -2625,7 +2625,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f1eff0a5-a75d-4ab8-8f92-1ac7b8ea8a7c", + "id": "29589436-f3fa-4911-ba92-1b3df52ac074", "name": "Request Timeout", "originalRequest": { "url": { @@ -2715,7 +2715,7 @@ { "listen": "test", "script": { - "id": "00045964-28dc-4be2-91ef-f563aa6fd751", + "id": "337e2c78-3b6e-47c9-85b1-012c153c712f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/pvt/payment-systems/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2763,7 +2763,7 @@ } ], "info": { - "_postman_id": "38619a57-45d4-4fb1-bcb2-3314921db515", + "_postman_id": "d2c83350-9b95-49ee-8595-cf85548b1ddd", "name": "Payment Policies API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 5807bebc5a5d835752d50c6a13a78b10e9944e85 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Fri, 7 Aug 2026 21:01:42 +0000 Subject: [PATCH 5/6] chore: update postman files --- .../VTEX - Payment Policies API.json | 94 +++++++++---------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/PostmanCollections/VTEX - Payment Policies API.json b/PostmanCollections/VTEX - Payment Policies API.json index 115366d4d..83a1c3dc7 100644 --- a/PostmanCollections/VTEX - Payment Policies API.json +++ b/PostmanCollections/VTEX - Payment Policies API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "d2c83350-9b95-49ee-8595-cf85548b1ddd" + "postman_id": "83d8bb07-1daf-4599-9f9d-eb913db87a8b" }, "item": [ { - "id": "7bab5055-cca1-4d32-890b-50a05f939804", + "id": "808823c0-8b50-42d5-ab2a-4255a934d30c", "name": "Payment policy rules", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "d3c8c29f-7cab-4aac-96d1-59e77590a493", + "id": "25710c29-0393-4c93-afba-7dc7e0a7acaa", "name": "Create policy rule", "request": { "name": "Create policy rule", @@ -87,7 +87,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "68146aee-970b-4581-b712-b3890ad269d1", + "id": "6318bd87-e0bc-412a-aed4-147a9bd0a2e9", "name": "Created", "originalRequest": { "url": { @@ -175,7 +175,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "33e97963-1af0-4f6c-b2ee-8ff8227d43a5", + "id": "acaaf6a6-3105-441b-b130-2d67e43c66c4", "name": "Bad Request", "originalRequest": { "url": { @@ -263,7 +263,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9f7b7afe-569d-41f1-9295-0f7d42b47c11", + "id": "9fbad786-6f7e-4096-986c-00e9bae05685", "name": "Unauthorized", "originalRequest": { "url": { @@ -351,7 +351,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "33250fbe-166b-48f4-a820-d0da023501c1", + "id": "02a3688b-496b-415f-affc-91817bcba580", "name": "Forbidden", "originalRequest": { "url": { @@ -439,7 +439,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "422a0c80-1dca-485c-8eab-8fd95e9081b8", + "id": "5139ca3d-70f7-4de1-ac8e-e53d322a4551", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -528,7 +528,7 @@ { "listen": "test", "script": { - "id": "ec318a2c-39ab-4224-8974-22570d4595b9", + "id": "9d745d06-406f-4316-b409-a879dc0ea1e9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -544,7 +544,7 @@ } }, { - "id": "3a851d47-7e6d-4938-a6db-f091c6bb15d5", + "id": "216bdb5d-fdc7-4d7a-a9f4-81f0deba5cf9", "name": "List policy rules", "request": { "name": "List policy rules", @@ -597,7 +597,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9331f8df-b9ce-4aae-987f-c252846095b1", + "id": "394bb0d9-2541-4a5a-9c91-b53fb308e2e7", "name": "OK", "originalRequest": { "url": { @@ -663,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4a9bd25e-3121-4f32-b5dd-b21fe5be19dc", + "id": "ce185a2f-f31c-4065-8680-32dd33f9a464", "name": "Unauthorized", "originalRequest": { "url": { @@ -729,7 +729,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b2d73438-f497-425d-af27-bb03ea8ff2cf", + "id": "3c3d1695-9ba3-4b5e-8bda-5f8d9b0d9bc7", "name": "Forbidden", "originalRequest": { "url": { @@ -796,7 +796,7 @@ { "listen": "test", "script": { - "id": "865598a1-b03e-4d8c-8377-b1c19370b2c9", + "id": "4c139559-0e65-41a3-a375-7d981aa5dda2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -812,7 +812,7 @@ } }, { - "id": "685d8ac0-330b-453e-8118-c967d3b4cef9", + "id": "10ec2400-517e-41b7-80ed-07023b42037b", "name": "Get policy rule by ID", "request": { "name": "Get policy rule by ID", @@ -849,7 +849,7 @@ "type": "text/plain" }, "type": "any", - "value": "nisi incididunt repreh", + "value": "minim id enim occaecat", "key": "id" } ] @@ -877,7 +877,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2472ec04-a14e-4515-b75a-17d31e927b4b", + "id": "f3088109-eff9-4181-9c02-496e65287193", "name": "OK", "originalRequest": { "url": { @@ -944,7 +944,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f1e7e2b7-a968-496b-8904-8cf6f6a3d7a0", + "id": "2ee839f7-655b-458f-8c46-42dd39d1b895", "name": "Unauthorized", "originalRequest": { "url": { @@ -1011,7 +1011,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "65a3ca57-97f4-4042-a972-d85bb55bd31e", + "id": "1a008e5e-0984-47c1-9c28-83a9117b41f0", "name": "Forbidden", "originalRequest": { "url": { @@ -1078,7 +1078,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "79848339-6b05-4606-be0c-b7f1f059cc27", + "id": "c7b7cee7-2605-4de3-a908-2d6d505a30f6", "name": "Not Found", "originalRequest": { "url": { @@ -1146,7 +1146,7 @@ { "listen": "test", "script": { - "id": "394da93b-c9f4-4f9e-98eb-efe9a67bb54d", + "id": "a8866277-be48-4403-a89c-f2a7362deb47", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1162,7 +1162,7 @@ } }, { - "id": "0cc29f22-8b92-4408-971f-892b1f20837a", + "id": "b5d48ff2-fa7f-41d5-90de-57b1aa9d2c6e", "name": "Update policy rule", "request": { "name": "Update policy rule", @@ -1199,7 +1199,7 @@ "type": "text/plain" }, "type": "any", - "value": "nisi incididunt repreh", + "value": "minim id enim occaecat", "key": "id" } ] @@ -1249,7 +1249,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b7577f16-89e9-45d0-92ab-c188b35947b4", + "id": "83e6ef66-08bc-4545-8365-20141441ba17", "name": "OK", "originalRequest": { "url": { @@ -1338,7 +1338,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cd5a95f4-cc05-4957-9976-48b32ffc92b0", + "id": "e42e1d5d-5922-4b5f-aa84-da474b60e798", "name": "Bad Request", "originalRequest": { "url": { @@ -1427,7 +1427,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "35b3cda9-e088-48a8-b6d3-03745dc14f67", + "id": "149295b0-be0b-480e-8597-a43f788d7c63", "name": "Unauthorized", "originalRequest": { "url": { @@ -1516,7 +1516,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d8a929bd-721f-4978-8f06-b0dfe9dafee4", + "id": "e909fe3f-a0a1-4524-a4c5-1b3c1e57dbaf", "name": "Forbidden", "originalRequest": { "url": { @@ -1605,7 +1605,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4f6445ae-06ee-472a-a9d7-27e87196c697", + "id": "ad5cbf19-1099-4978-817e-75870d6982ab", "name": "Not Found", "originalRequest": { "url": { @@ -1694,7 +1694,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f51fc595-c03d-4182-8b7e-370db38d1998", + "id": "6fca2cab-5cc1-4186-93e4-e6ce63c5c248", "name": "Conflict", "originalRequest": { "url": { @@ -1783,7 +1783,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1657054e-1c1b-4187-ab3d-35ac11dfa103", + "id": "84ef375f-a8fc-4c69-904e-af986df1c667", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -1873,7 +1873,7 @@ { "listen": "test", "script": { - "id": "a86aff3d-0df6-4be0-b8fc-0ee04baa0629", + "id": "06bd97c8-e2e5-4455-bf5e-393399c7b052", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1889,7 +1889,7 @@ } }, { - "id": "b6bd7e56-f10b-4126-a6d6-3d7a7755b423", + "id": "ea2e29cf-f614-41bb-8b65-b7de4c07512f", "name": "Delete policy rule", "request": { "name": "Delete policy rule", @@ -1926,7 +1926,7 @@ "type": "text/plain" }, "type": "any", - "value": "nisi incididunt repreh", + "value": "minim id enim occaecat", "key": "id" } ] @@ -1945,7 +1945,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "bf99354b-9415-4058-a3e8-f93b068eabb1", + "id": "4c3931a0-f0fe-4aaa-b6ea-fbf8e672ac0f", "name": "No Content", "originalRequest": { "url": { @@ -1993,7 +1993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "250de28e-0ce4-47b2-9303-69d80328ff31", + "id": "f6128ca4-befa-4466-9d01-11a46061cd58", "name": "Unauthorized", "originalRequest": { "url": { @@ -2051,7 +2051,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2bbc4ed4-7627-4d01-b98f-ba174b9e0549", + "id": "36849fd8-af40-4252-a7a3-7f287f13a6f2", "name": "Forbidden", "originalRequest": { "url": { @@ -2109,7 +2109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7d386e15-8bdd-47ae-af36-e1c3d2e837b7", + "id": "0abdfca8-a927-43f6-a6e9-d53f14d2d0ae", "name": "Not Found", "originalRequest": { "url": { @@ -2168,7 +2168,7 @@ { "listen": "test", "script": { - "id": "a2287909-35ee-47a9-af37-d27aadfbd642", + "id": "7288d193-bfa7-4ca3-a2b1-110b44b556ae", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2185,7 +2185,7 @@ "event": [] }, { - "id": "cf772a0c-480d-431d-b2f2-7258da9622ba", + "id": "68eecd12-4555-4196-bef8-1b7ad9c672de", "name": "Payment policy evaluation", "description": { "content": "", @@ -2193,7 +2193,7 @@ }, "item": [ { - "id": "48096134-0050-4be2-8daf-1857ac291a6d", + "id": "bbd54e23-5ae6-487a-b11d-532de7c9998d", "name": "Evaluate payment policies", "request": { "name": "Evaluate payment policies", @@ -2269,7 +2269,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "98c24d39-7e94-4eab-9752-19a3f13bbad0", + "id": "9bceef97-4394-476b-af71-f538e3232ac3", "name": "OK", "originalRequest": { "url": { @@ -2358,7 +2358,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5f75bf4f-d385-42d5-bb45-f22fb3b17d33", + "id": "8df046fc-1a49-4885-9d7c-7e55e4e54043", "name": "Bad Request", "originalRequest": { "url": { @@ -2447,7 +2447,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "93bf5d25-c9b6-48c8-8296-61944fe960fd", + "id": "3adcfe4a-d1dc-4630-b6dc-2ce7ea4f4c8f", "name": "Unauthorized", "originalRequest": { "url": { @@ -2536,7 +2536,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "10c403ef-f15f-451e-9f92-4c17a9e1cb2b", + "id": "cfb2bf41-0514-4a2d-9000-47fb4781b89a", "name": "Forbidden", "originalRequest": { "url": { @@ -2625,7 +2625,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "29589436-f3fa-4911-ba92-1b3df52ac074", + "id": "38d66a0f-b299-48b2-9be2-b9f7a9b3001f", "name": "Request Timeout", "originalRequest": { "url": { @@ -2715,7 +2715,7 @@ { "listen": "test", "script": { - "id": "337e2c78-3b6e-47c9-85b1-012c153c712f", + "id": "64952447-c876-4524-becd-45276eabe2ff", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/pvt/payment-systems/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2763,7 +2763,7 @@ } ], "info": { - "_postman_id": "d2c83350-9b95-49ee-8595-cf85548b1ddd", + "_postman_id": "83d8bb07-1daf-4599-9f9d-eb913db87a8b", "name": "Payment Policies API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From cf7dfb7b0525b4ba17e5f3df270ffb35826e5473 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Fri, 7 Aug 2026 21:06:24 +0000 Subject: [PATCH 6/6] chore: update postman files --- .../VTEX - Payment Policies API.json | 240 +++++++++--------- 1 file changed, 120 insertions(+), 120 deletions(-) diff --git a/PostmanCollections/VTEX - Payment Policies API.json b/PostmanCollections/VTEX - Payment Policies API.json index 83a1c3dc7..dcebd9bef 100644 --- a/PostmanCollections/VTEX - Payment Policies API.json +++ b/PostmanCollections/VTEX - Payment Policies API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "83d8bb07-1daf-4599-9f9d-eb913db87a8b" + "postman_id": "b299df5e-642a-477b-8d2a-4288534e1b23" }, "item": [ { - "id": "808823c0-8b50-42d5-ab2a-4255a934d30c", + "id": "9dc6768e-1030-4c6c-bbab-1ff75b6fc5cd", "name": "Payment policy rules", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "25710c29-0393-4c93-afba-7dc7e0a7acaa", + "id": "4155028f-e15b-4714-ab53-2b68753bfb71", "name": "Create policy rule", "request": { "name": "Create policy rule", "description": { - "content": "Creates a payment policy rule for the VTEX account identified by the `accountName` URL variable. Policy rules define conditions that determine which payment systems are included or excluded when those conditions match a cart item.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Creates a payment policy rule for the VTEX account identified by the `an` query parameter. Policy rules define conditions that determine which payment systems are included or excluded when those conditions match a cart item.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -33,11 +33,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -87,7 +87,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6318bd87-e0bc-412a-aed4-147a9bd0a2e9", + "id": "4f38a57f-adc6-4926-8ae8-d640bc1d1a26", "name": "Created", "originalRequest": { "url": { @@ -103,11 +103,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -175,7 +175,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "acaaf6a6-3105-441b-b130-2d67e43c66c4", + "id": "4c07e934-80b3-4eb7-b48d-ba3aaa246ae6", "name": "Bad Request", "originalRequest": { "url": { @@ -191,11 +191,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -263,7 +263,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9fbad786-6f7e-4096-986c-00e9bae05685", + "id": "15a54ae1-52e3-43ce-bddd-c3795946390a", "name": "Unauthorized", "originalRequest": { "url": { @@ -279,11 +279,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -351,7 +351,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "02a3688b-496b-415f-affc-91817bcba580", + "id": "83da7443-5e0f-4c33-9425-2b0123aeddb2", "name": "Forbidden", "originalRequest": { "url": { @@ -367,11 +367,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -439,7 +439,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5139ca3d-70f7-4de1-ac8e-e53d322a4551", + "id": "69159eed-a64b-4591-ab94-3220ab74b996", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -455,11 +455,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -528,7 +528,7 @@ { "listen": "test", "script": { - "id": "9d745d06-406f-4316-b409-a879dc0ea1e9", + "id": "d50e1dce-6804-4983-b032-7fd33f100c0e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -544,12 +544,12 @@ } }, { - "id": "216bdb5d-fdc7-4d7a-a9f4-81f0deba5cf9", + "id": "c4039d1f-c9c7-46bd-a7f4-b5eaa4b3bc46", "name": "List policy rules", "request": { "name": "List policy rules", "description": { - "content": "Lists the payment policy rules configured for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Lists the payment policy rules configured for the VTEX account identified by the `an` query parameter.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -565,11 +565,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -597,7 +597,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "394bb0d9-2541-4a5a-9c91-b53fb308e2e7", + "id": "9614bad1-24d3-43c9-91a0-56aa80aa8569", "name": "OK", "originalRequest": { "url": { @@ -613,11 +613,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -663,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ce185a2f-f31c-4065-8680-32dd33f9a464", + "id": "286803cc-938f-48e4-ba0f-537aeaeb14bb", "name": "Unauthorized", "originalRequest": { "url": { @@ -679,11 +679,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -729,7 +729,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3c3d1695-9ba3-4b5e-8bda-5f8d9b0d9bc7", + "id": "0ca6522a-cc28-45fe-99de-ab7c2930070b", "name": "Forbidden", "originalRequest": { "url": { @@ -745,11 +745,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -796,7 +796,7 @@ { "listen": "test", "script": { - "id": "4c139559-0e65-41a3-a375-7d981aa5dda2", + "id": "5d54148e-53bd-423c-8756-b22177dadfc5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -812,12 +812,12 @@ } }, { - "id": "10ec2400-517e-41b7-80ed-07023b42037b", + "id": "3bd836ec-ac6c-40b8-8d24-82fec68e5dc4", "name": "Get policy rule by ID", "request": { "name": "Get policy rule by ID", "description": { - "content": "Retrieves a payment policy rule by ID for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Retrieves a payment policy rule by ID for the VTEX account identified by the `an` query parameter.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -834,11 +834,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [ @@ -849,7 +849,7 @@ "type": "text/plain" }, "type": "any", - "value": "minim id enim occaecat", + "value": "nulla aliquip", "key": "id" } ] @@ -877,7 +877,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f3088109-eff9-4181-9c02-496e65287193", + "id": "00298849-b75a-4957-9483-a3dfad3ab3ba", "name": "OK", "originalRequest": { "url": { @@ -894,11 +894,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -944,7 +944,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2ee839f7-655b-458f-8c46-42dd39d1b895", + "id": "4a1ba74a-11c7-4cd0-8323-6413c605f7d2", "name": "Unauthorized", "originalRequest": { "url": { @@ -961,11 +961,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1011,7 +1011,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1a008e5e-0984-47c1-9c28-83a9117b41f0", + "id": "97dba232-c07f-4041-8846-f91ad78ccff5", "name": "Forbidden", "originalRequest": { "url": { @@ -1028,11 +1028,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1078,7 +1078,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c7b7cee7-2605-4de3-a908-2d6d505a30f6", + "id": "fe14b74f-f461-47a4-acab-e82eeabacf7b", "name": "Not Found", "originalRequest": { "url": { @@ -1095,11 +1095,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1146,7 +1146,7 @@ { "listen": "test", "script": { - "id": "a8866277-be48-4403-a89c-f2a7362deb47", + "id": "e5ae31d4-f60f-4623-9b51-0e127a0ad658", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1162,12 +1162,12 @@ } }, { - "id": "b5d48ff2-fa7f-41d5-90de-57b1aa9d2c6e", + "id": "0762d7de-3a4e-4488-8b2e-7b0be35dcc4b", "name": "Update policy rule", "request": { "name": "Update policy rule", "description": { - "content": "Replaces a payment policy rule for the VTEX account identified by the `accountName` URL variable. Send the same request body used to create a rule. Do not include response-only fields such as `id`, `createdAt`, or `updatedAt`, and do not send a `version` field because concurrency is handled server-side.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Replaces a payment policy rule for the VTEX account identified by the `an` query parameter. Send the same request body used to create a rule. Do not include response-only fields such as `id`, `createdAt`, or `updatedAt`, and do not send a `version` field because concurrency is handled server-side.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1184,11 +1184,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [ @@ -1199,7 +1199,7 @@ "type": "text/plain" }, "type": "any", - "value": "minim id enim occaecat", + "value": "nulla aliquip", "key": "id" } ] @@ -1249,7 +1249,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "83e6ef66-08bc-4545-8365-20141441ba17", + "id": "9fc2c984-cd49-46f5-bf81-fa73c4edbd79", "name": "OK", "originalRequest": { "url": { @@ -1266,11 +1266,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1338,7 +1338,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e42e1d5d-5922-4b5f-aa84-da474b60e798", + "id": "f00b6fff-1298-4154-95ff-e9ae2c37806f", "name": "Bad Request", "originalRequest": { "url": { @@ -1355,11 +1355,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1427,7 +1427,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "149295b0-be0b-480e-8597-a43f788d7c63", + "id": "5bc53ae5-c87e-4212-9125-201d3b25ab0c", "name": "Unauthorized", "originalRequest": { "url": { @@ -1444,11 +1444,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1516,7 +1516,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e909fe3f-a0a1-4524-a4c5-1b3c1e57dbaf", + "id": "a1804152-e41a-421c-b9ed-5f6d14aabe60", "name": "Forbidden", "originalRequest": { "url": { @@ -1533,11 +1533,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1605,7 +1605,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ad5cbf19-1099-4978-817e-75870d6982ab", + "id": "0a233b45-0280-4b4b-964f-961049a42492", "name": "Not Found", "originalRequest": { "url": { @@ -1622,11 +1622,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1694,7 +1694,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6fca2cab-5cc1-4186-93e4-e6ce63c5c248", + "id": "29b01222-56b4-4c28-8fb4-7b5f35a29b2f", "name": "Conflict", "originalRequest": { "url": { @@ -1711,11 +1711,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1783,7 +1783,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "84ef375f-a8fc-4c69-904e-af986df1c667", + "id": "96b2be16-05d7-4215-aaca-a54e97e8bcb7", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -1800,11 +1800,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1873,7 +1873,7 @@ { "listen": "test", "script": { - "id": "06bd97c8-e2e5-4455-bf5e-393399c7b052", + "id": "cf710fe6-208a-4b5f-84c7-c93c7084399c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1889,12 +1889,12 @@ } }, { - "id": "ea2e29cf-f614-41bb-8b65-b7de4c07512f", + "id": "53aae426-453e-44ef-80c9-ba79c35b130a", "name": "Delete policy rule", "request": { "name": "Delete policy rule", "description": { - "content": "Deletes a payment policy rule for the VTEX account identified by the `accountName` URL variable.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Deletes a payment policy rule for the VTEX account identified by the `an` query parameter.\r\n\r\n> ⚠️ 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](https://support.vtex.com/hc/en-us/).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Payments | Payment Policies | **ManageStore** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1911,11 +1911,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [ @@ -1926,7 +1926,7 @@ "type": "text/plain" }, "type": "any", - "value": "minim id enim occaecat", + "value": "nulla aliquip", "key": "id" } ] @@ -1945,7 +1945,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4c3931a0-f0fe-4aaa-b6ea-fbf8e672ac0f", + "id": "04e918be-c2a0-4dea-ad02-c1472161a878", "name": "No Content", "originalRequest": { "url": { @@ -1962,11 +1962,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -1993,7 +1993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f6128ca4-befa-4466-9d01-11a46061cd58", + "id": "12ab7cb6-9799-4ded-a35d-5f330864185a", "name": "Unauthorized", "originalRequest": { "url": { @@ -2010,11 +2010,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2051,7 +2051,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "36849fd8-af40-4252-a7a3-7f287f13a6f2", + "id": "4687c91b-e1fe-4e6c-857a-d9ffc0f53b50", "name": "Forbidden", "originalRequest": { "url": { @@ -2068,11 +2068,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2109,7 +2109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0abdfca8-a927-43f6-a6e9-d53f14d2d0ae", + "id": "34d04ae1-d2af-4b9b-b584-15d75f0078f4", "name": "Not Found", "originalRequest": { "url": { @@ -2126,11 +2126,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2168,7 +2168,7 @@ { "listen": "test", "script": { - "id": "7288d193-bfa7-4ca3-a2b1-110b44b556ae", + "id": "39c8e694-8c9f-47dc-a7f6-200e6181b774", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2185,7 +2185,7 @@ "event": [] }, { - "id": "68eecd12-4555-4196-bef8-1b7ad9c672de", + "id": "8414ab37-9494-42a7-be49-cdb9c56099b2", "name": "Payment policy evaluation", "description": { "content": "", @@ -2193,7 +2193,7 @@ }, "item": [ { - "id": "bbd54e23-5ae6-487a-b11d-532de7c9998d", + "id": "99e76e7f-dbee-4dc0-88d3-8bee03404c0c", "name": "Evaluate payment policies", "request": { "name": "Evaluate payment policies", @@ -2215,11 +2215,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2269,7 +2269,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9bceef97-4394-476b-af71-f538e3232ac3", + "id": "8692b598-cc9f-4952-ad41-0712fd6024cc", "name": "OK", "originalRequest": { "url": { @@ -2286,11 +2286,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2358,7 +2358,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8df046fc-1a49-4885-9d7c-7e55e4e54043", + "id": "2bd21405-d71b-41be-947a-7602c032666a", "name": "Bad Request", "originalRequest": { "url": { @@ -2375,11 +2375,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2447,7 +2447,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3adcfe4a-d1dc-4630-b6dc-2ce7ea4f4c8f", + "id": "f51d8244-8bb5-4d04-bbad-8af4680a17b7", "name": "Unauthorized", "originalRequest": { "url": { @@ -2464,11 +2464,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2536,7 +2536,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cfb2bf41-0514-4a2d-9000-47fb4781b89a", + "id": "f27a54f9-67b0-4da0-ab32-3fff6850245a", "name": "Forbidden", "originalRequest": { "url": { @@ -2553,11 +2553,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2625,7 +2625,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "38d66a0f-b299-48b2-9be2-b9f7a9b3001f", + "id": "2783cb1f-6655-4614-9933-c347d8aae22a", "name": "Request Timeout", "originalRequest": { "url": { @@ -2642,11 +2642,11 @@ { "disabled": false, "description": { - "content": "(Required) Account name.", + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", "type": "text/plain" }, "key": "an", - "value": "cosmetics2" + "value": "apiexamples" } ], "variable": [] @@ -2715,7 +2715,7 @@ { "listen": "test", "script": { - "id": "64952447-c876-4524-becd-45276eabe2ff", + "id": "c9371e2f-8cce-478a-bd31-69e637654f4d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/pvt/payment-systems/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2763,7 +2763,7 @@ } ], "info": { - "_postman_id": "83d8bb07-1daf-4599-9f9d-eb913db87a8b", + "_postman_id": "b299df5e-642a-477b-8d2a-4288534e1b23", "name": "Payment Policies API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": {