diff --git a/PostmanCollections/VTEX - Payment Policies API.json b/PostmanCollections/VTEX - Payment Policies API.json index ea5c5b177..dcebd9bef 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": "b299df5e-642a-477b-8d2a-4288534e1b23" }, "item": [ { - "id": "f9591204-9f82-4c03-8b1f-fa2bb5393e94", + "id": "9dc6768e-1030-4c6c-bbab-1ff75b6fc5cd", "name": "Payment policy rules", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "f66d807e-a5d5-43a0-a661-55835ff80221", + "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": { @@ -29,7 +29,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -77,7 +87,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1b69342e-1e33-47ba-b39c-72312628e791", + "id": "4f38a57f-adc6-4926-8ae8-d640bc1d1a26", "name": "Created", "originalRequest": { "url": { @@ -89,7 +99,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -155,7 +175,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7cb9177e-259c-47c5-960b-b819ecc13c94", + "id": "4c07e934-80b3-4eb7-b48d-ba3aaa246ae6", "name": "Bad Request", "originalRequest": { "url": { @@ -167,7 +187,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -233,7 +263,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "79827f3a-593e-402d-b68a-dbb85e80f65f", + "id": "15a54ae1-52e3-43ce-bddd-c3795946390a", "name": "Unauthorized", "originalRequest": { "url": { @@ -245,7 +275,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -311,7 +351,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "67e487db-dc32-4508-ba7a-422108bac00e", + "id": "83da7443-5e0f-4c33-9425-2b0123aeddb2", "name": "Forbidden", "originalRequest": { "url": { @@ -323,7 +363,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -389,7 +439,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "99eecee7-4bb5-4470-b90b-39b3830f87f2", + "id": "69159eed-a64b-4591-ab94-3220ab74b996", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -401,7 +451,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -468,7 +528,7 @@ { "listen": "test", "script": { - "id": "5c9b294e-a8f6-49b5-9b3f-a87b55f074e0", + "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", @@ -484,12 +544,12 @@ } }, { - "id": "09119e83-02c4-4246-a17c-6afb10f1dc2a", + "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": { @@ -501,7 +561,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -527,7 +597,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "bd2a18a2-1c38-46fe-bdaf-4050519722d5", + "id": "9614bad1-24d3-43c9-91a0-56aa80aa8569", "name": "OK", "originalRequest": { "url": { @@ -539,7 +609,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -583,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1ac3d693-cddd-4a81-9cbd-2414c3ec10e9", + "id": "286803cc-938f-48e4-ba0f-537aeaeb14bb", "name": "Unauthorized", "originalRequest": { "url": { @@ -595,7 +675,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -639,7 +729,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "948e7c5d-018c-409c-b468-aa547717e2a6", + "id": "0ca6522a-cc28-45fe-99de-ab7c2930070b", "name": "Forbidden", "originalRequest": { "url": { @@ -651,7 +741,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -696,7 +796,7 @@ { "listen": "test", "script": { - "id": "494f56ff-3da4-4ec1-8d51-879644f004c8", + "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", @@ -712,12 +812,12 @@ } }, { - "id": "7b860541-571d-4dee-aa45-35996ce9c862", + "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": { @@ -730,7 +830,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [ { "disabled": false, @@ -739,7 +849,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud in adipisicing culpa", + "value": "nulla aliquip", "key": "id" } ] @@ -767,7 +877,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f0507bff-69a1-4866-9135-aef1e8e240d0", + "id": "00298849-b75a-4957-9483-a3dfad3ab3ba", "name": "OK", "originalRequest": { "url": { @@ -780,7 +890,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -824,7 +944,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "11a9f98b-7d74-4d20-82f7-95018cf2678d", + "id": "4a1ba74a-11c7-4cd0-8323-6413c605f7d2", "name": "Unauthorized", "originalRequest": { "url": { @@ -837,7 +957,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -881,7 +1011,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f3db78f1-5cb3-4dc1-8f2a-c2a7e7221b89", + "id": "97dba232-c07f-4041-8846-f91ad78ccff5", "name": "Forbidden", "originalRequest": { "url": { @@ -894,7 +1024,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -938,7 +1078,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1ffbae44-a411-41e3-8521-6e3d7955dd85", + "id": "fe14b74f-f461-47a4-acab-e82eeabacf7b", "name": "Not Found", "originalRequest": { "url": { @@ -951,7 +1091,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -996,7 +1146,7 @@ { "listen": "test", "script": { - "id": "535f67d4-d644-4107-bee8-8ad95e794476", + "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", @@ -1012,12 +1162,12 @@ } }, { - "id": "52228949-64ef-42f2-b471-93b94e952052", + "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": { @@ -1030,7 +1180,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [ { "disabled": false, @@ -1039,7 +1199,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud in adipisicing culpa", + "value": "nulla aliquip", "key": "id" } ] @@ -1089,7 +1249,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "88e29a4d-1ff3-46fd-9ed8-62c69e5e1d8c", + "id": "9fc2c984-cd49-46f5-bf81-fa73c4edbd79", "name": "OK", "originalRequest": { "url": { @@ -1102,7 +1262,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1168,7 +1338,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f66b4ec5-c3d4-44f8-b139-1d3f4bac1a4f", + "id": "f00b6fff-1298-4154-95ff-e9ae2c37806f", "name": "Bad Request", "originalRequest": { "url": { @@ -1181,7 +1351,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1247,7 +1427,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5c5cf1aa-0077-4b9f-8a1e-7403ecc8607f", + "id": "5bc53ae5-c87e-4212-9125-201d3b25ab0c", "name": "Unauthorized", "originalRequest": { "url": { @@ -1260,7 +1440,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1326,7 +1516,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "be8fea73-df9a-4ce9-ad4e-522692b97175", + "id": "a1804152-e41a-421c-b9ed-5f6d14aabe60", "name": "Forbidden", "originalRequest": { "url": { @@ -1339,7 +1529,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1405,7 +1605,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "907e80cd-3c13-427b-abbb-83d55da19c7d", + "id": "0a233b45-0280-4b4b-964f-961049a42492", "name": "Not Found", "originalRequest": { "url": { @@ -1418,7 +1618,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1484,7 +1694,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "210ad315-d0da-4f7c-8168-c1d35063ef5f", + "id": "29b01222-56b4-4c28-8fb4-7b5f35a29b2f", "name": "Conflict", "originalRequest": { "url": { @@ -1497,7 +1707,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1563,7 +1783,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c32258bc-c87c-439d-8deb-4584db90d77c", + "id": "96b2be16-05d7-4215-aaca-a54e97e8bcb7", "name": "Unprocessable Content", "originalRequest": { "url": { @@ -1576,7 +1796,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1643,7 +1873,7 @@ { "listen": "test", "script": { - "id": "9b6ccef6-e5a3-43b3-a775-06b79016d6b3", + "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", @@ -1659,12 +1889,12 @@ } }, { - "id": "4c299793-6410-4277-a080-29119f153ce9", + "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": { @@ -1677,7 +1907,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [ { "disabled": false, @@ -1686,7 +1926,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud in adipisicing culpa", + "value": "nulla aliquip", "key": "id" } ] @@ -1705,7 +1945,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "81fe67aa-d571-46ba-a24e-9b587df381cb", + "id": "04e918be-c2a0-4dea-ad02-c1472161a878", "name": "No Content", "originalRequest": { "url": { @@ -1718,7 +1958,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1743,7 +1993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4f0eb659-32e4-4608-ab40-36d0406628e9", + "id": "12ab7cb6-9799-4ded-a35d-5f330864185a", "name": "Unauthorized", "originalRequest": { "url": { @@ -1756,7 +2006,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1791,7 +2051,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d9b563b8-73ba-46d4-b771-347f5010133a", + "id": "4687c91b-e1fe-4e6c-857a-d9ffc0f53b50", "name": "Forbidden", "originalRequest": { "url": { @@ -1804,7 +2064,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1839,7 +2109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f7e9cf53-5485-4220-9e48-107c02d5d1d9", + "id": "34d04ae1-d2af-4b9b-b584-15d75f0078f4", "name": "Not Found", "originalRequest": { "url": { @@ -1852,7 +2122,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1888,7 +2168,7 @@ { "listen": "test", "script": { - "id": "cb64fb71-54e9-4d6e-9b64-daf3c20c07fe", + "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", @@ -1905,7 +2185,7 @@ "event": [] }, { - "id": "caea438d-df2a-4329-a37a-03fd6dcdeaaf", + "id": "8414ab37-9494-42a7-be49-cdb9c56099b2", "name": "Payment policy evaluation", "description": { "content": "", @@ -1913,7 +2193,7 @@ }, "item": [ { - "id": "ca1a0f44-03ed-4be2-a8c8-ee8d239bd0c0", + "id": "99e76e7f-dbee-4dc0-88d3-8bee03404c0c", "name": "Evaluate payment policies", "request": { "name": "Evaluate payment policies", @@ -1931,7 +2211,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -1979,7 +2269,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8dc025e4-84d6-4cdf-a7e5-b50bb5e61944", + "id": "8692b598-cc9f-4952-ad41-0712fd6024cc", "name": "OK", "originalRequest": { "url": { @@ -1992,7 +2282,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -2058,7 +2358,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "11a6f5a7-319a-41ce-9d92-b5872a4d3f40", + "id": "2bd21405-d71b-41be-947a-7602c032666a", "name": "Bad Request", "originalRequest": { "url": { @@ -2071,7 +2371,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -2137,7 +2447,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cf7fb6e6-816a-4b03-943e-4d7fbca4f2a0", + "id": "f51d8244-8bb5-4d04-bbad-8af4680a17b7", "name": "Unauthorized", "originalRequest": { "url": { @@ -2150,7 +2460,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -2216,7 +2536,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c2141685-72bf-4350-948d-eb850c9469f6", + "id": "f27a54f9-67b0-4da0-ab32-3fff6850245a", "name": "Forbidden", "originalRequest": { "url": { @@ -2229,7 +2549,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -2295,7 +2625,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a6a6da17-de7b-409d-b3a2-ce0ff54cff6f", + "id": "2783cb1f-6655-4614-9933-c347d8aae22a", "name": "Request Timeout", "originalRequest": { "url": { @@ -2308,7 +2638,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policy rules are being managed.", + "type": "text/plain" + }, + "key": "an", + "value": "apiexamples" + } + ], "variable": [] }, "header": [ @@ -2375,7 +2715,7 @@ { "listen": "test", "script": { - "id": "c1929bc7-4079-411e-bbd1-42690df4cf06", + "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", @@ -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": "b299df5e-642a-477b-8d2a-4288534e1b23", "name": "Payment Policies API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - Payment Policies API.json b/VTEX - Payment Policies API.json index 95f62581b..7fff19c30 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": { @@ -48,8 +30,11 @@ ], "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": [ + { + "$ref": "#/components/parameters/An" + }, { "$ref": "#/components/parameters/Content-Type" }, @@ -159,8 +144,11 @@ ], "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": [ + { + "$ref": "#/components/parameters/An" + }, { "$ref": "#/components/parameters/Accept" } @@ -226,14 +214,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": { @@ -242,8 +224,11 @@ ], "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": [ + { + "$ref": "#/components/parameters/An" + }, { "$ref": "#/components/parameters/PolicyRuleId" }, @@ -311,8 +296,11 @@ ], "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": [ + { + "$ref": "#/components/parameters/An" + }, { "$ref": "#/components/parameters/PolicyRuleId" }, @@ -431,8 +419,11 @@ ], "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": [ + { + "$ref": "#/components/parameters/An" + }, { "$ref": "#/components/parameters/PolicyRuleId" } @@ -456,14 +447,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 +459,9 @@ "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": [ + { + "$ref": "#/components/parameters/An" + }, { "$ref": "#/components/parameters/Content-Type" }, @@ -1599,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",