From e02d14960970b04e0992f3bd09309afaae996651 Mon Sep 17 00:00:00 2001 From: Ricardo Correia Date: Mon, 18 May 2026 13:02:13 -0300 Subject: [PATCH 1/8] EDU-18190 Payment Policies API --- Primary APIs.postman_collection (1).json | 15682 +++++++++++++++++++++ 1 file changed, 15682 insertions(+) create mode 100644 Primary APIs.postman_collection (1).json diff --git a/Primary APIs.postman_collection (1).json b/Primary APIs.postman_collection (1).json new file mode 100644 index 000000000..a871641c5 --- /dev/null +++ b/Primary APIs.postman_collection (1).json @@ -0,0 +1,15682 @@ +{ + "info": { + "_postman_id": "6f9ecbeb-2271-4340-8fe1-945d77661db7", + "name": "Primary APIs", + "description": "These are the primary APIs for handling B2B cases.\n\n## Authentication\n\nYou can authenticate requests to these APIs by sending a VTEX user token in a header named `VtexIdclientAutCookie`. Learn more in [API authentication using user tokens](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens).\n\n## Changelog\n\nCheck our [Documentation Changelog](https://vtex.github.io/odp-docs/) to see the latest updates to this collection.", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "48144395", + "_collection_link": "https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/collection/2352637-6f9ecbeb-2271-4340-8fe1-945d77661db7?action=share&source=collection_link&creator=48144395" + }, + "item": [ + { + "name": "Contracts", + "item": [ + { + "name": "Create Contract", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"corporateDocument\": \"{{corporateDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"tradeName\": \"{{tradeName}}\",\r\n \"isCorporate\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\",\r\n \"priceTables\": \"{{priceTables}}\",\r\n \"restrictions\": {\r\n \"vtex.catalog\": {\r\n \"collectionIds\": []\r\n },\r\n \"vtex.checkout\": {\r\n \"creditCards\": [\"da89bc50-994e-4e39-9974-4a9d081cc3f4\",\"65ec3ec6-c504-4431-b17a-ea3800fb03d2\"]\r\n },\r\n \"vtex.payments\": {\r\n \"paymentSystemIds\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5,\r\n 7,\r\n 8,\r\n 9,\r\n 14,\r\n 21,\r\n 29,\r\n 31,\r\n 33,\r\n 34,\r\n 35,\r\n 36,\r\n 37,\r\n 48,\r\n 789]\r\n }\r\n }\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents" + ] + }, + "description": "This endpoint enables you to create a new Contract, also referred to as the `CL` data entity.\n\n> ⚠️ When creating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/CL/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"email\": \"{{email}}\",\n \"firstName\": \"{{firstName}}\",\n \"lastName\": \"{{lastName}}\",\n \"document\": \"{{document}}\",\n \"documentType\": \"{{documentType}}\",\n \"isCorporate\": true,\n \"corporateDocument\": \"{{businessDocument}}\",\n \"homePhone\": \"{{homePhone}}\",\n \"cellPhone\": \"{{cellPhone}}\",\n \"corporateName\": \"{{corporateName}}\",\n \"tradeName\": \"{{doingBusinessAs}}\",\n \"stateRegistration\": \"\",\n \"isFreeStateRegistration\": \"true\",\n \"priceTables\": \"{{priceTables}}\",\n \"restrictions\": {\n \"vtex.catalog\": {\n \"collectionIds\": []\n },\n \"vtex.checkout\": {\n \"creditCards\": [\n \"da89bc50-994e-4e39-9974-4a9d081cc3f4\",\n \"65ec3ec6-c504-4431-b17a-ea3800fb03d2\"\n ]\n },\n \"vtex.payments\": {\n \"paymentSystemIds\": [\n 1, 2, 3, 4, 5, 7, 8, 9, 14, 21, 29, 31, 33, 34, 35, 36, 37, 48, 789\n ]\n }\n }\n}\n\n ```\n\n| Field | Type | Max Length | Description |\n| --- | --- | --- | --- |\n| `email` | `string` | 300 | The email of the contact. |\n| `firstName` | `string` | 300 | The first name of the contact. |\n| `lastName` | `string` | 300 | The last name of the contact. |\n| `document` | `string` | 300 | The document number of the contact. |\n| `documentType` | `string` | 300 | The type of document (e.g., \"EIN\", \"State Business Registration Number\"). |\n| `isCorporate` | `boolean` | \\- | Whether it's a legal entity. Always \"true\" for contracts. |\n| `corporateDocument` | `string` | 300 | The business document of the contact. |\n| `homePhone` | `string` | 300 | The home phone number of the contact. |\n| `cellPhone` | `string` | 300 | The cell phone number of the contact. |\n| `corporateName` | `string` | 300 | The corporate name of the contact. |\n| `tradeName` | `string` | 300 | The trade name (\"doing business as\") of the contact. |\n| `stateRegistration` | `string` | 300 | The state registration of the contact. |\n| `isFreeStateRegistration` | `boolean` | \\- | Indicates if the state registration is free. |\n| `priceTables` | `string` | 50 entries | Price tables associated with the contact, separated by commas. |\n| `restrictions` | `object` | \\- | Object with restriction definitions for `vtex.catalog`, `vtex.checkout`, and `vtex.payments`. |\n| └─ `vtex.catalog` | `object` | \\- | Contains restrictions regarding catalog. Fields: `collectionIds`. |\n| └─ `collectionIds` | `array of string` | | A list of collection IDs that define which product collections (sets of SKUs) the B2B customer can view or purchase from. These IDs are internal catalog entities used to group products logically. |\n| └─ `vtex.checkout` | `object` | \\- | Contains restrictions regarding checkout. Fields: `creditCards`. |\n| └─ `creditCards` | `array of string` | | A list of credit card IDs that the customer is allowed to use during checkout. These IDs reference cards stored in the BK entity, managed by the VTEX Checkout system. |\n| └─ `vtex.payments` | `object` | \\- | Contains restrictions regarding payments. Fields: `paymentSystemIds`. |\n| └─ `paymentSystemIds` | `array of string` | | A list of numeric IDs that represent the allowed payment systems (e.g., credit card processors) for the customer. These IDs are predefined and globally recognized by VTEX. |\n\n**Note**: Only the following restriction fields are accepted:\n\n- `vtex.catalog.collectionIds`\n \n- `vtex.checkout.creditCards`\n \n- `vtex.payments.paymentSystemIds`\n \n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/CL/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | The ID of the created contract document. |\n| `Href` | `string` | URL of the created document. |\n| `DocumentId` | `string` | The document ID. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"business-klub-spc@email.com\",\r\n \"firstName\": \"Business Klub\",\r\n \"lastName\": \"SPC\",\r\n \"document\": \"00000000000000\",\r\n \"documentType\": \"EIN\",\r\n \"corporateDocument\": \"00000000000000\",\r\n \"homePhone\": \"1122223333\",\r\n \"cellPhone\": \"11999991111\",\r\n \"businessPhone\": \"1122223333\",\r\n \"corporateName\": \"Business Klub SPC\",\r\n \"tradeName\": \"Business Klub SPC\",\r\n \"isCorporate\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\",\r\n \"priceTables\": \"CL-4000060,CL3000007,NCC,NCNC\",\r\n \"restrictions\": {\r\n \"vtex.payments\": {\r\n \"paymentSystemIds\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5,\r\n 7,\r\n 8,\r\n 9,\r\n 14,\r\n 21,\r\n 29,\r\n 31,\r\n 33,\r\n 34,\r\n 35,\r\n 36,\r\n 37,\r\n 48,\r\n 789]\r\n }\r\n }\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "202" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Wed, 19 Mar 2025 21:43:29 GMT" + }, + { + "key": "x-vtex-took", + "value": "135" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.8-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "V7-IZnmhGRFbCKMOxAt_deklX3uTFhSkxJZ4UYnFRnif2Y10V_eL4Q==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/CL/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}" + } + ] + }, + { + "name": "Get Contract", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + }, + "description": "This endpoint retrieves information related to a given contract, by its unique identifier. The request should be sent as an HTTP GET to:\n\n```\nhttps://{{accountName}}.myvtex.com/api/dataentities/CL/documents/{{contractId}}?_fields=_all\n\n ```\n\n### Parameters\n\nThe request includes the\\`contractId\\` (ID of the contract to be deleted) as a path parameter, and the \"_fields=_all\" query parameter to specify that all fields of the document should be included in the response.\n\n### Request\n\n- Method: `GET`\n \n- Headers: `VtexIdclientAutCookie`\n \n- No request body required\n \n\n### Response\n\nReturns all available fields for the specified contract.\n\n#### Example Response:\n\n``` json\n{\n \"cluster\": null,\n \"priceTables\": \"CL-4000060,CL3000007,NCC,NCNC\",\n \"isCorporate\": null,\n \"tradeName\": null,\n \"rclastcart\": null,\n \"rclastcartvalue\": null,\n \"rclastsession\": null,\n \"rclastsessiondate\": null,\n \"homePhone\": \"1122223333\",\n \"phone\": null,\n \"brandPurchasedTag\": null,\n \"brandVisitedTag\": null,\n \"categoryPurchasedTag\": null,\n \"categoryVisitedTag\": null,\n \"departmentVisitedTag\": null,\n \"productPurchasedTag\": null,\n \"productVisitedTag\": null,\n \"stateRegistration\": \"\",\n \"email\": \"business-klub-spc@email.com\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"firstName\": \"Business Klub\",\n \"lastName\": \"SPC\",\n \"document\": \"00000000000000\",\n \"isNewsletterOptIn\": false,\n \"localeDefault\": null,\n \"attach\": null,\n \"approved\": null,\n \"birthDate\": null,\n \"businessPhone\": \"1122223333\",\n \"carttag\": null,\n \"checkouttag\": null,\n \"corporateDocument\": null,\n \"corporateName\": \"Business Klub SPC\",\n \"documentType\": \"CNPJ\",\n \"gender\": null,\n \"visitedProductWithStockOutSkusTag\": null,\n \"customerClass\": null,\n \"profilePicture\": null,\n \"birthDateMonth\": null,\n \"id\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"CL\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}\n\n ```\n\n### Field Descriptions\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `cluster`, `tradeName`, etc. | `null` | Internal or optional analytics/tags fields |\n| `priceTables` | `string` | Comma-separated list of assigned price table codes |\n| `homePhone`, `businessPhone` | `string` | Contact phone numbers |\n| `email`, `firstName`, `lastName` | `string` | Basic identity information |\n| `document`, `documentType` | `string` | The type of document (e.g., \"EIN\", \"State Business Registration Number\"). |\n| `corporateName` | `string` | Company’s registered corporate name |\n| `stateRegistration` | `string` | State-level registration number |\n| `isNewsletterOptIn` | `boolean` | Indicates newsletter opt-in status |\n| `createdIn`, `lastInteractionIn` | `string` | Timestamps of document creation and last update |\n| `id`, `dataEntityId` | `string` | Unique contract ID and fixed entity ID (always \"CL\") |\n| `accountId`, `accountName` | `string` | Internal VTEX account identifiers |\n| `followers`, `tags` | `array` | Metadata arrays |\n| Other nullable fields | `null` | May be present depending on account configuration or user interactions |\n\nNote: Some fields may be `null` if not applicable to the specific contract record." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents", + "2da4e9ab-050b-11f0-b37f-f4b136dbcce1" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:27:21 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.024" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "Content-Encoding", + "value": "gzip" + }, + { + "key": "Vary", + "value": "Accept-Encoding" + }, + { + "key": "trace-id", + "value": "00-6c22efa9bd304804c414d791bdf9ae72-a57b0ce57ba791c8-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"b91d4d8cb71380718e01487c9c0e2544\"" + }, + { + "key": "x-vtex-took", + "value": "15" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-31-82" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.022" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "TSeQuAQEPiuuBTWGYrh-90Is8xep2d-m2ouNutIlaxvtodVw0CZaNg==" + } + ], + "cookie": [], + "body": "{\n \"cluster\": null,\n \"priceTables\": \"CL-4000060,CL3000007,NCC,NCNC\",\n \"isCorporate\": true,\n \"tradeName\": null,\n \"rclastcart\": null,\n \"rclastcartvalue\": null,\n \"rclastsession\": null,\n \"rclastsessiondate\": null,\n \"homePhone\": \"1122223333\",\n \"phone\": null,\n \"brandPurchasedTag\": null,\n \"brandVisitedTag\": null,\n \"categoryPurchasedTag\": null,\n \"categoryVisitedTag\": null,\n \"departmentVisitedTag\": null,\n \"productPurchasedTag\": null,\n \"productVisitedTag\": null,\n \"stateRegistration\": \"\",\n \"email\": \"business-klub-spc@email.com\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"firstName\": \"Business Klub\",\n \"lastName\": \"SPC\",\n \"document\": \"00000000000000\",\n \"isNewsletterOptIn\": false,\n \"localeDefault\": null,\n \"attach\": null,\n \"approved\": null,\n \"birthDate\": null,\n \"businessPhone\": \"1122223333\",\n \"carttag\": null,\n \"checkouttag\": null,\n \"corporateDocument\": null,\n \"corporateName\": \"Business Klub SPC\",\n \"documentType\": \"CNPJ\",\n \"gender\": null,\n \"visitedProductWithStockOutSkusTag\": null,\n \"customerClass\": null,\n \"profilePicture\": null,\n \"birthDateMonth\": null,\n \"id\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"CL\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}" + } + ] + }, + { + "name": "Update Contract", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"accountAlias\": null,\r\n \"phone\": \"\",\r\n \"restrictions\": {\r\n \"vtex.catalog\": {\r\n \"collectionIds\": []\r\n },\r\n \"vtex.checkout\": {\r\n \"creditCards\": []\r\n },\r\n \"vtex.payments\": {\r\n \"paymentSystemIds\": [\r\n \"201\"\r\n ]\r\n }\r\n }\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents", + "{{contractId}}" + ] + }, + "description": "**Update Contract**\n\nThis endpoint allows you to update an existing contract by its unique identifier.\n\n> ⚠️ When updating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n---\n\n### Request\n\n**Method:** PATCH \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/CL/documents/{{contractId}}`\n\n**Headers:**\n\n- `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n- `Content-Type: application/json`\n \n\n**Body Example:**\n\n``` json\n{\n \"email\": \"{{email}}\",\n \"firstName\": \"{{firstName}}\",\n \"lastName\": \"{{lastName}}\",\n \"document\": \"{{document}}\",\n \"documentType\": \"{{documentType}}\",\n \"businessDocument\": \"{{businessDocument}}\",\n \"homePhone\": \"{{homePhone}}\",\n \"cellPhone\": \"{{cellPhone}}\",\n \"corporateName\": \"{{corporateName}}\",\n \"tradeName\": \"{{doingBusinessAs}}\",\n \"isCorporate\": \"true\",\n \"stateRegistration\": \"\",\n \"isFreeStateRegistration\": \"true\",\n \"priceTables\": \"{{priceTables}}\"\n}\n\n ```\n\n---\n\n### Field Descriptions\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `email` | string | Yes | Email address of the contact. |\n| `firstName` | string | Yes | First name of the contact. |\n| `lastName` | string | Yes | Last name of the contact. |\n| `document` | string | Yes | Document number (e.g., CNPJ or CPF). |\n| `documentType` | string | Yes | The type of document (e.g., \"EIN\", \"State Business Registration Number\"). |\n| `corporateDocument` | string | No | Business document number if different from main document. |\n| `homePhone` | string | No | Home phone number. |\n| `cellPhone` | string | No | Cell phone number. |\n| `corporateName` | string | Yes | Legal name of the company. |\n| `tradeName` | string | No | Trade/fantasy name. |\n| `isCorporate` | boolean | Yes | Whether it's a legal entity. Always \"true\" for contracts. |\n| `stateRegistration` | string | No | State registration number. Can be empty. |\n| `isFreeStateRegistration` | boolean | No | Indicates if the registration is free/exempt. |\n| `priceTables` | string | No | Comma-separated list of price tables. |\n\n---\n\n### Response\n\n**Status Code:** `204 No Content`\n\nIndicates the contract was updated successfully. No body is returned." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"businessDocument\": \"{{businessDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"tradeName\": \"{{tradeName}}\",\r\n \"isCorporate\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\",\r\n \"priceTables\": \"{{priceTables}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents", + "{{contractId}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": null + } + ] + }, + { + "name": "Delete Contract", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + }, + "description": "**Delete Contract**\n\nThis endpoint allows you to delete a specific contract from the data entity `CL`.\n\n---\n\n### Delete Contract\n\n**Method:** DELETE \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/CL/documents/{{contractId}}?_fields=_all`\n\n**Headers:**\n\n- `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n\n**Request Body:** None\n\n**Response:**\n\n**Status Code:** `204 No Content`\n\nThe contract was deleted successfully. No response body is returned." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{id}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents", + "{{id}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "plain", + "header": [ + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:28:22 GMT" + }, + { + "key": "x-vtex-took", + "value": "225" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "trace-id", + "value": "00-916a9a9627d3152b521eaf9a9ae23532-4edb9c5da7a8d3a3-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "Noe_pmDaIHW1UjbKydoVa0cLLumGh-I13hbiNEBSoKzU8H-Aubgqbw==" + } + ], + "cookie": [], + "body": null + } + ] + }, + { + "name": "Create Address", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"addressLabel\": \"{{addressLabel}}\",\r\n \"postalCode\": \"{{portalCode}}\",\r\n \"street\": \"{{street}}\",\r\n \"number\": \"{{number}}\",\r\n \"neighborhood\": \"{{meighboorhood}}\",\r\n \"complement\": \"\",\r\n \"city\": \"{{city}}\",\r\n \"state\": \"{{state}}\",\r\n \"country\": \"{{country}}\",\r\n \"receiverName\": \"{{receiverName}}\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial|invoice\",\r\n \"userId\": \"{{contractId}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "" + ] + }, + "description": "This endpoint allows you to register a new address, also referred to as the AD data entity.\n\n> ⚠️ When creating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n### Request\n\n**Method:** POST \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/`\n\n**Headers:**\n\n- `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n- `Content-Type: application/json`\n \n\n**Request Body:**\n\n``` json\n{\n \"addressLabel\": \"{{addressLabel}}\",\n \"postalCode\": \"{{postalCode}}\",\n \"street\": \"{{street}}\",\n \"number\": \"{{number}}\",\n \"neighborhood\": \"{{meighboorhood}}\",\n \"complement\": \"\",\n \"city\": \"{{city}}\",\n \"state\": \"{{state}}\",\n \"country\": \"{{country}}\",\n \"receiverName\": \"{{receiverName}}\",\n \"geoCoordinate\": \"\",\n \"addressType\": \"commercial|invoice\",\n \"userId\": \"{{contractId}}\"\n}\n\n ```\n\n### Field Descriptions\n\n| Field | Type | Description |\n| --- | --- | --- |\n| addressLabel | string | A user-defined label to identify the address |\n| postalCode | string | The postal code of the address. The format must be compatible with the address country postal code format. (e.g., '00000' for addresses in the USA) |\n| street | string | The street name of the address |\n| number | string | The street number of the address |\n| neighborhood | string | The neighborhood of the address |\n| complement | string | Any additional address information |\n| city | string | The city of the address |\n| state | string | The state of the address |\n| country | string | The country of the address in three-letter code format (e.g., \"USA\") |\n| receiverName | string | The name of the receiver |\n| geoCoordinate | string | The geographical coordinates of the address (optional) |\n| addressType | string | The type of address:
\\- `commercial`: for shipping.
\\- `invoice`: for billing. |\n| userId | string | The ID of the contract associated with the address |\n\n### Response\n\n**Status Code:** `200 OK`\n\n**Response Body:**\n\n``` json\n{\n \"Id\": \"AD-4286e252-050b-11f0-b37f-d6617047d485\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/AD/documents/4286e252-050b-11f0-b37f-d6617047d485\",\n \"DocumentId\": \"4286e252-050b-11f0-b37f-d6617047d485\"\n}\n\n ```\n\n### Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| Id | string | The prefixed ID of the document |\n| Href | string | The URL to access the created document |\n| DocumentId | string | The actual document ID (UUID) within the entity |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"addressLabel\": \"PRINCIPAL\",\r\n \"postalCode\": \"48226\",\r\n \"street\": \"Toringon Street\",\r\n \"number\": \"11\",\r\n \"neighborhood\": \"\",\r\n \"complement\": \"\",\r\n \"city\": \"Raleigh\",\r\n \"state\": \"NC\",\r\n \"country\": \"USA\",\r\n \"receiverName\": \"Backpack-Klub-LLC\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial\",\r\n \"userId\": \"{{contractBusinessKlubSPCId}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "202" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Wed, 19 Mar 2025 21:44:01 GMT" + }, + { + "key": "x-vtex-took", + "value": "119" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.8-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "laRj6wkBkcRK1VkfvH-LaWVq7jn57yD2N7LGgBzKJgTZ_hpTAduQZg==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"AD-4286e252-050b-11f0-b37f-d6617047d485\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/AD/documents/4286e252-050b-11f0-b37f-d6617047d485\",\n \"DocumentId\": \"4286e252-050b-11f0-b37f-d6617047d485\"\n}" + } + ] + }, + { + "name": "Get Address", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "{{addressId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + }, + "description": "# Get AD Document by ID\n\nThis endpoint retrieves information of a specific address by its unique identifier.\n\n### Request\n\n- **Method:** `GET`\n \n- **URL:** `https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}?_fields=_all`\n \n- **Headers:**\n \n - `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n\n> <p >ℹ️ No request body is required.</p> \n \n\n---\n\n### Response\n\n**Status:** `200 OK`\n\nThe response will contain a JSON object with the full details of the address document.\n\n#### Example Response\n\n``` json\n{\n \"addressLabel\": \"PRINCIPAL\",\n \"addressType\": \"commercial\",\n \"city\": \"Raleigh\",\n \"complement\": \"\",\n \"country\": \"USA\",\n \"countryfake\": null,\n \"geoCoordinate\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"11\",\n \"postalCode\": \"48226\",\n \"receiverName\": \"Backpack-Klub-LLC\",\n \"reference\": null,\n \"state\": \"NC\",\n \"street\": \"Toringon Street\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"id\": \"4286e252-050b-11f0-b37f-d6617047d485\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"AD\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}\n\n ```\n\n#### Response body fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| addressLabel | string | A user-defined label to identify the address |\n| addressType | string | The type of address:
\\- `commercial`: for shipping.
\\- `invoice`: for billing. |\n| city | string | The city of the address |\n| complement | string | Any additional information for the address (e.g., apartment, floor) |\n| country | string | The country of the address in three-letter code format (e.g., \"USA\") |\n| countryfake | string or null | Placeholder or optional country value |\n| geoCoordinate | string | Geographical coordinates of the address (latitude and longitude) |\n| neighborhood | string | The neighborhood of the address |\n| number | string | The street number of the address |\n| postalCode | string | The postal code of the address. The format must be compatible with the address country postal code format. (e.g., '00000' for addresses in the USA) |\n| receiverName | string | The name of the person or entity receiving at this address |\n| reference | string or null | Optional reference point or landmark near the address |\n| state | string | The state or province of the address |\n| street | string | The street name of the address |\n| userId | string | The ID of the user or related entity |\n| id | string | Unique identifier for this address record |\n| accountId | string | ID of the account related to this address |\n| accountName | string | Name of the account related to this address |\n| dataEntityId | string | ID of the data entity this address belongs to |\n| createdBy | string | ID of the user who created the address record |\n| createdIn | string | Timestamp of when the address record was created |\n| updatedBy | string or null | ID of the user who last updated the address record |\n| updatedIn | string or null | Timestamp of the last update to the address record |\n| lastInteractionBy | string | ID of the user who had the last interaction with the record |\n| lastInteractionIn | string | Timestamp of the last interaction with the record |\n| followers | array | List of users following this address record |\n| tags | array | List of tags associated with this address |\n| auto_filter | string or null | Optional field used for automatic filtering or categorization |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{id}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "{{id}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "755" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:29:23 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.088" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "trace-id", + "value": "00-58a18223a783f0dfd0c792be732650f6-dbff3563b6b3d2ac-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"5b1df6c9a17a37929db5da78e1a8d898\"" + }, + { + "key": "x-vtex-took", + "value": "83" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-30-248" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.088" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "D1a5_1N7cu5WSkIRD2lpCecVI3CcQ880Ljk98A-hCoItYQXYSl1u9A==" + } + ], + "cookie": [], + "body": "{\n \"addressLabel\": \"PRINCIPAL\",\n \"addressType\": \"commercial\",\n \"city\": \"Raleigh\",\n \"complement\": \"\",\n \"country\": \"USA\",\n \"countryfake\": null,\n \"geoCoordinate\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"11\",\n \"postalCode\": \"48226\",\n \"receiverName\": \"Backpack-Klub-LLC\",\n \"reference\": null,\n \"state\": \"NC\",\n \"street\": \"Toringon Street\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"id\": \"4286e252-050b-11f0-b37f-d6617047d485\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"AD\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}" + } + ] + }, + { + "name": "Update Address", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"addressLabel\": \"{{addressLabel}}\",\r\n \"postalCode\": \"{{portalCode}}\",\r\n \"street\": \"{{street}}\",\r\n \"number\": \"{{number}}\",\r\n \"neighborhood\": \"{{meighboorhood}}\",\r\n \"complement\": \"\",\r\n \"city\": \"{{city}}\",\r\n \"state\": \"{{state}}\",\r\n \"country\": \"{{country}}\",\r\n \"receiverName\": \"{{receiverName}}\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial|invoice\",\r\n \"userId\": \"{{contractId}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "{{addressId}}" + ] + }, + "description": "### Update Address (AD)\n\nThis endpoint allows you to update an existing address document in the `AD` data entity.\n\n> ⚠️ When updating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n---\n\n#### Request\n\n- **Method**: `PATCH`\n \n- **URL**:\n \n ```\n https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}\n \n ```\n \n- **Headers**:\n \n | Key | Value |\n | --- | --- |\n | `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n | `Content-Type` | `application/json` |\n \n- **Request body fields**:\n \n\n| Field | Type | Description |\n| --- | --- | --- |\n| addressLabel | string | A user-defined label to identify the address |\n| postalCode | string | The postal code of the address. The format must be compatible with the address country postal code format. (e.g., '00000' for addresses in the USA) |\n| street | string | The street name of the address |\n| number | string | The street number of the address |\n| neighborhood | string | The neighborhood of the address |\n| complement | string | Any additional address information |\n| city | string | The city of the address |\n| state | string | The state of the address |\n| country | string | The country of the address in three-letter code format (e.g., \"USA\") |\n| receiverName | string | The name of the receiver |\n| geoCoordinate | string | Geographical coordinates of the address |\n| addressType | string | The type of address:
\\- `commercial`: for shipping.
\\- `invoice`: for billing. |\n| userId | string | The ID of the related contract. |\n\n---\n\n#### Response\n\n- **Status**: `204 No Content` \n The address was successfully updated." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"addressName\": \"{{addressName}}\",\r\n \"postalCode\": \"{{portalCode}}\",\r\n \"street\": \"{{street}}\",\r\n \"number\": \"{{number}}\",\r\n \"neighborhood\": \"\",\r\n \"complement\": \"\",\r\n \"city\": \"{{city}}\",\r\n \"state\": \"{{state}}\",\r\n \"country\": \"{{country}}\",\r\n \"receiverName\": \"{{receiverName}}\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial|invoice\",\r\n \"userId\": \"{{contractId}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "{{addressId}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": null + } + ] + }, + { + "name": "Delete Address", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "{{addressId}}" + ] + }, + "description": "### Delete Address Document (AD Entity)\n\nThis endpoint allows you to delete a specific address document from the `AD` data entity.\n\n#### Request\n\n**Method:** `DELETE` \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}`\n\n**Path Parameters**:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| addressId | string | The ID of the address to be deleted |\n\n**Headers**:\n\n| Header | Value |\n| --- | --- |\n| VtexIdclientAutCookie | `{{vault:VtexIdclientAutCookie}}` |\n\n**Body:** None\n\n#### Response\n\n- **Status Code:** `204 No Content` (on success)\n \n- No response body will be returned.\n \n\n#### Example CURL\n\n``` bash\ncurl --location --globoff --request DELETE 'https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}' \\\n--header 'VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}'\n\n ```" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "AD", + "documents", + "{{id}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "755" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:29:23 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.088" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "trace-id", + "value": "00-58a18223a783f0dfd0c792be732650f6-dbff3563b6b3d2ac-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"5b1df6c9a17a37929db5da78e1a8d898\"" + }, + { + "key": "x-vtex-took", + "value": "83" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-30-248" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.088" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "D1a5_1N7cu5WSkIRD2lpCecVI3CcQ880Ljk98A-hCoItYQXYSl1u9A==" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "These APIs are for creating the contract, and are expected to be used only for store management. Contracts meaning B2B clients of your store.\n\nIn this collection there are auxiliary APIs to support filling out the contract, especially the restrictions object.\n\n### Restrictions\n\nIn the context of this API, **restrictions** define the specific commercial and operational limits that a merchant configures for a contract. These restrictions determine how the customer can interact with the store across key systems such as catalog access, data management, checkout options, and payment methods.\n\nWhile the values configured in the `restrictions` object are not directly passed to the systems, they are used to generate the valid inputs that are. This ensures that the customer’s shopping and purchasing experience aligns with their contract terms and business agreements." + }, + { + "name": "Users & Units", + "item": [ + { + "name": "Users", + "item": [ + { + "name": "Get User", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/users/{{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "users", + "{{userId}}" + ] + }, + "description": "Retrieves information about a specific user from the License Manager.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/license-manager/users/{{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"ad60c84ca72b44da8256a61058c0a4c6\",\n \"email\": \"emily.brown@email.com\",\n \"name\": \"Emily Brown\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the user. |\n| `email` | `string` | Email of the user. |\n| `name` | `string` | Name of the user. |\n\n---\n\n**Official Documentation**: [VTEX License Manager - Get User](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/users/-userId-)" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"Emily Brown\",\r\n \"email\": \"emily.brown@email.com\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "users" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "94" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:58:50 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "vlm-v5.54.7" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 a263c5e625088b97c5317725b2dccc7c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "4FtbmiXmqy1cnhZ3xpI7ittb8GIIKMkFa--j18MSKycgUtWEhEdiAw==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"ad60c84ca72b44da8256a61058c0a4c6\",\n \"email\": \"emily.brown@email.com\",\n \"name\": \"Emily Brown\"\n}" + } + ] + }, + { + "name": "Create User", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIDClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"Beneson Damasceno 2\",\r\n \"email\": \"beneson2010@gmail.com\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/users/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "users", + "" + ] + }, + "description": "Creates a new user in the License Manager.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/license-manager/users/`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Request Body\n\nThe request must include a JSON object in the body with the following parameters:\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| name | string | Yes | Name of the user. |\n| email | string | Yes | Email of the user |\n\n#### Example Request Body\n\n``` json\n{\n \"name\":\"{{name}}\"\n \"email\":\"{{email}}\"\n}\n\n ```\n\n### Response\n\n#### Success Response\n\n- **Status Code:** `200 OK`\n \n- **Body:**\n \n\n``` json\n{\n\"id\": \"16eec272115a4ee8b0063977fa90f904\",\n\"email\": \"lois.lane@company.com\",\n\"name\": \"Lois Lane\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | string | ID of the created user. |\n| name | string | Name os the user. |\n| email | string | Email of the user. |\n\nOfficial Documentation: [VTEX License Manager - Create User](https://developers.vtex.com/docs/api-reference/license-manager-api#post-/api/license-manager/users)" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIDClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"{{name}}\",\r\n \"email\": \"{{email}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/users/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "users", + "" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"id\": \"16eec272115a4ee8b0063977fa90f904\",\n \"email\": \"lois.lane@company.com\",\n \"name\": \"Lois Lane\"\n}" + } + ] + }, + { + "name": "Delete User", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/license-manager/users/{{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "users", + "{{userId}}" + ] + }, + "description": "Deletes a user from the License Manager.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/license-manager/users/{{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `userId` | `string` | Yes | The ID of the user to be deleted. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: `null` (Empty response body indicates successful deletion)\n \n\n---\n\n**Official Documentation**: [VTEX License Manager - Delete User](https://developers.vtex.com/docs/api-reference/license-manager-api#delete-/api/license-manager/users/-userId-)" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"Emily Brown\",\r\n \"email\": \"emily.brown@email.com\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/users/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "users", + "{{id}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Length", + "value": "94" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:58:50 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "vlm-v5.54.7" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 a263c5e625088b97c5317725b2dccc7c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "4FtbmiXmqy1cnhZ3xpI7ittb8GIIKMkFa--j18MSKycgUtWEhEdiAw==" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Get Scope by User", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/users/{{userId}}/scopes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "users", + "{{userId}}", + "scopes" + ] + }, + "description": "Retrieves the scopes of a user within the specified account.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/users/{{userId}}/scopes`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `accountName` | `string` | Yes | The VTEX account name. |\n| `userId` | `string` | Yes | The unique identifier of the user. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"contractIds\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `contractIds` | `string[]` | A list of contract IDs representing user scopes. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/users//scopes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "users", + "", + "scopes" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 28 Mar 2025 21:37:04 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "10" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "e59e5294-aa08-41d1-a539-d00693d99022" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 f3927a57c758d8bb98768c87c3fc924c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "-gdoA1p3g8FSe6oVesvtRc6uJUAFMpOAlifyId_g9gwRtdnVRneTXQ==" + } + ], + "cookie": [], + "body": "{\n \"contractIds\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}" + } + ] + }, + { + "name": "Get Unit by User", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{userId}}/unit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{userId}}", + "unit" + ] + }, + "description": "Retrieves the organization unit assigned to a specific user.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{userId}}/unit`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `accountName` | `string` | Yes | The VTEX account name. |\n| `userId` | `string` | Yes | The ID of the user. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:07.190377Z\",\n \"name\": \"{{unit_name}}\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"names\": \"\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit assignment was created. |\n| `updatedAt` | `string` | Timestamp when the unit assignment was last updated. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | The full ID path of the unit. |\n| `path.names` | `string` | The full name path of the unit (may be empty). |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{userId}}/unit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{userId}}", + "unit" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:07.190377Z\",\n \"name\": \"{{unit_name}}\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"names\": \"\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Get User ID by Email", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/pvt/user/id?usuario={{url-encoded-email-address}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "vtexid", + "pvt", + "user", + "id" + ], + "query": [ + { + "key": "usuario", + "value": "{{url-encoded-email-address}}", + "description": "URL-encoded email address" + } + ] + }, + "description": "This request allows you to retrieve a shopper's information by their email address.\n\n### Example request\n\n```\ncurl -L 'https://mystore.vtexcommercestable.com.br/api/vtexid/pvt/user/id?usuario=clark.kent+buyer@vtex.com' \\\n-H 'VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}'\n\n ```\n\n### Response\n\nThe response to this request is just the user ID in plain text, like the example below:\n\n```\n\"80479899c9d-a34c-437d-92c5-1d774db2dd40\"\n```" + }, + "response": [] + } + ], + "description": "Users are individuals within tha buyer organization that have access to the platform via unique email address. Users belong to an organizational unit and have role-based permissions for purchasing, approvals, or management.\n\n> Each user is tied to a single email and cannot belong to multiple organizational units. \n \n\nUsers actions are limited by scopes inherited from the unit they belong to." + }, + { + "name": "Units", + "item": [ + { + "name": "Scopes", + "item": [ + { + "name": "Contracts", + "item": [ + { + "name": "Create Scope Contracts in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "contractIds" + ] + }, + "description": "This endpoint adds specific scope Contract IDs to a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{scopeId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "contractIds" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Contracts from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "contractIds" + ] + }, + "description": "Remove a contract type of scope from a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "contractIds" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Remove Value from Scope Contracts in Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "contractIds", + "remove" + ] + }, + "description": "Removes specific scope Contract IDs from a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds/remove", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "contractIds", + "remove" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" + } + ] + }, + { + "name": "Update Scope Contracts in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "contractIds" + ] + }, + "description": "This endpoint replaces all Contract IDs in the scope of a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{scopeId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "contractIds" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Addresses", + "item": [ + { + "name": "Create Scope Addresses in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "addresses" + ] + }, + "description": "This endpoint adds specific Addresses IDs to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "addresses" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Addresses from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "addresses" + ] + }, + "description": "Removes all addresses from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "addresses" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Remove Value from Scope Addresses in Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "addresses", + "remove" + ] + }, + "description": "Removes specific Addresses from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"66664b68-74da-4fc4-b51a-9ddcb8baf29a\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "addresses", + "remove" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" + } + ] + }, + { + "name": "Update Scope Addresses in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "addresses" + ] + }, + "description": "This endpoint replaces all Addresses for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "addresses" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Payment Systems", + "item": [ + { + "name": "Create Scope Payment Systems in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "paymentSystemIds" + ] + }, + "description": "Adds specific payment systems to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"4d128b79-5d4b-44d4-bb0f-6d86e2c33317\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "paymentSystemIds" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"4d128b79-5d4b-44d4-bb0f-6d86e2c33317\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Payment Systems from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "paymentSystemIds" + ] + }, + "description": "Removes all payment systems from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "paymentSystemIds" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Remove Value from Scope Payment Systems in Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "paymentSystemIds", + "remove" + ] + }, + "description": "Removes specific payment systems from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"4d128b79-5d4b-44d4-bb0f-6d86e2c33317\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "paymentSystemIds", + "remove" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" + } + ] + }, + { + "name": "Update Scope Payment Systems in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "paymentSystemIds" + ] + }, + "description": "This endpoint replaces all Addresses for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "paymentSystemIds" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Price Tables", + "item": [ + { + "name": "Create Scope Price Tables in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "priceTables" + ] + }, + "description": "Adds specific price tables to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/priceTables`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"863ae2fc-10eb-4468-973a-fe63243dc8c2\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "priceTables" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"863ae2fc-10eb-4468-973a-fe63243dc8c2\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Price Tables from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "priceTables" + ] + }, + "description": "Removes all price tables from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/priceTables`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "priceTables" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Remove Value from Scope Price Tables in Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "priceTables", + "remove" + ] + }, + "description": "Removes specific price tables from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/priceTables/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"863ae2fc-10eb-4468-973a-fe63243dc8c2\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "priceTables", + "remove" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a,\n \"scope\": \"priceTables\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" + } + ] + }, + { + "name": "Update Scope Price Tables in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "priceTables" + ] + }, + "description": "This endpoint replaces all price tables for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/{{scopeType}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n| `scopeType` | `string` | The scope to be replaced. Accepted values: `contractIds`, `addresses`, `paymentSystemIds`, `priceTables`, `collectionIds`, `creditCards`, `customFields`. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{scopeId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "priceTables" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Collections", + "item": [ + { + "name": "Create Scope Collections in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "collectionIds" + ] + }, + "description": "Adds specific collections to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"7d3566c8-c761-4cbf-a347-c94ea6e9985d\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/collectionIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "collectionIds" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"7d3566c8-c761-4cbf-a347-c94ea6e9985d\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Collections from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "collectionIds" + ] + }, + "description": "Removes all collections from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/collectionIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", + "scopes", + "collectionIds" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Remove Value from Scope Collections in Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{collectionId}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "collectionIds", + "remove" + ] + }, + "description": "Removes specific collections from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"7d3566c8-c761-4cbf-a347-c94ea6e9985d\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "collectionIds", + "remove" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" + } + ] + }, + { + "name": "Update Scope Collections in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "collectionIds" + ] + }, + "description": "This endpoint replaces all collections for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/collectionIds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", + "scopes", + "collectionIds" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Credit Cards", + "item": [ + { + "name": "Create Scope Credit Cards in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "creditCards" + ] + }, + "description": "Adds specific credit cards to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"eae94554-5452-4b0f-9eba-901dd8b3512e\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/creditCards", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "creditCards" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"eae94554-5452-4b0f-9eba-901dd8b3512e\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Credit Cards from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "creditCards" + ] + }, + "description": "Removes all credit cards from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/creditCards", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", + "scopes", + "creditCards" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Remove Value from Scope Credit Cards in Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "creditCards", + "remove" + ] + }, + "description": "Removes specific credit cards from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"3\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"eae94554-5452-4b0f-9eba-901dd8b3512e\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/creditCards/remove", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", + "scopes", + "creditCards", + "remove" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" + } + ] + }, + { + "name": "Update Scope Credit Cards in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "creditCards" + ] + }, + "description": "This endpoint replaces all credit cards for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/creditCards", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", + "scopes", + "creditCards" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Custom Fields", + "item": [ + { + "name": "Create Scope Custom Fields in Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\"]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "customFields" + ] + }, + "description": "Adds specific custom fields to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/customFields`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\"]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Custom fields and ids in a single item of the array to be added to the scope. The string is a JSON-serialized object. The keys are custom field names, and the values are objects with an ids array containing UUIDs. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\"]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | A single item array with custom fields and its ids successfully added to the scope. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"ids\": [\r\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes", + "customFields" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:34:04 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "124" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}" + } + ] + }, + { + "name": "Delete Scope Custom Fields from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "customFields" + ] + }, + "description": "Removes all custom fields from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/customFields`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", + "scopes", + "customFields" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Update Scope Custom Fields in Unit", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "customFields" + ] + }, + "description": "This endpoint replaces all custom fields for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/customFields`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Custom fields and ids in a single item of the array to be added to the scope. The string is a JSON-serialized object. The keys are custom field names, and the values are objects with an ids array containing UUIDs. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | Custom fields and ids in a single item of the array that are now assigned. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes", + "customFields" + ] + } + }, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}" + } + ] + } + ] + }, + { + "name": "Delete All Scopes from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes" + ] + }, + "description": "Removes all scope assignments from a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdClientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Get Scopes by Unit", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "scopes" + ] + }, + "description": "Retrieves all scopes assigned to a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scopes\": [\n {\n \"scope\": \"creditCards\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scopes` | `array` | A list of scope objects assigned to the unit. |\n| `scopes[].scope` | `string` | The type of the scope (e.g., `creditCards`). |\n| `scopes[].ids` | `string[]` | Array of IDs associated with the given scope type (e.g., credit card IDs). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "92264b68-74da-4fc4-b51a-9ddcb8baf29a", + "scopes" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 27 Mar 2025 14:29:50 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "26" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "b42c8836-6254-4d56-b6a0-51ed8bf5baee" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b93e1df8c9b030e62bc95fcea82dd72a.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "etbSAbhWxYn4v02bfBURid6a_gLTW9roNvm2jMO1vJCjEVgLSf2UQQ==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scopes\": [\n {\n \"scope\": \"creditCards\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n }\n ]\n}" + } + ] + } + ], + "description": "You can use scopes to restrict access to resources related to the purchase flow. To do this, use the requests below to assign scopes to units. Users belonging to a unit will only be able to access the resources included in that unit's scopes.\n\nThese resources are:\n\n- Contracts\n \n- Addresses\n \n- Payment Systems\n \n- Price Tables\n \n- Collections\n \n- Credit Cards\n \n- Custom Fields\n \n\nSee the sections below to learn more about how to manage scopes for different resources.\n\n### Session\n\nThe enforcing of the scopes during the purchase flow depends on the `vtex_session` cookie. Learn more:\n\n- [Sessions System Overview](https://developers.vtex.com/docs/guides/sessions-system-overview)\n \n- [Session Manager API](https://developers.vtex.com/docs/api-reference/session-manager-api)" + }, + { + "name": "Create Unit", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"{{unitName}}\"\r\n}\r\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1" + ] + }, + "description": "Creates a new organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"name\": \"{{unitName}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | The name of the unit to be created. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-03-19T21:27:15.2275104Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"nationa-chamber\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the newly created unit. |\n| `path.ids` | `string` | The full ID path of the unit. |\n| `id` | `string` | ID of the created organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"nationa-chamber\"\r\n}\r\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Wed, 19 Mar 2025 21:27:15 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "84" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "1fbd3f92-82a2-4008-b7c0-010b58ae3877" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 bea03c5dc8c5155adf8c603f739f7c60.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "K3GeHgCG1s2Rv2lvcPirv6MFdI8mlRFF2bLt7Q8wTow09UZqx1zK6w==" + } + ], + "cookie": [], + "body": "{\n \"createdAt\": \"2025-03-19T21:27:15.2275104Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"nationa-chamber\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Get Unit", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + }, + "description": "Retrieves the details of a specific organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-name\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"names\": \"unit-name\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `path.names` | `string` | Full name path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:37:10 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "67" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" + } + ], + "cookie": [], + "body": "{\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-name\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"names\": \"unit-name\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Get all Units from Scope Value", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "{{scopeName}}", + "value", + "{{scopeValue}}" + ] + }, + "description": "This endpoint retrieves data related to a scope associated with organizational units.\n\n---\n\n| **Variables** | Required | Type | **Description** | **Example** |\n| --- | --- | --- | --- | --- |\n| `{{accountName}}` | Yes | `string` | The name of the VTEX account. | `myaccount` |\n| `{{scopeName}}` | Yes | `string` | The name of the scope category for which data should be retrieved. Supported values are:
\\- `creditCards`
\\- `installmentOptions`
\\- `collectionIds`
\\- `priceTables`
\\- `paymentSystemIds`
\\- `addresses` | `contractIds` |\n| `{{scopeValue}}` | Yes | `string` | The unique identifier within the given scope: For `contractIds`, use the contract ID. | `\"9025fbdd-6271-11f0-b37f-f5b4d28a6ca2\"` |\n\n### Examples\n\nSee below for example routes for each scope:\n\n| **Scope** | **Route** |\n| --- | --- |\n| `creditCards` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/creditCards/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `contractIds` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/creditCards/value/9025fbdd-6271-11f0-b37f-f5b4d28a6ca2 |\n| `installmentOptions` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/installmentOptions/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `collectionIds` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/collectionIds/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `priceTables` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/priceTables/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `paymentSystemIds` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/paymentSystemIds/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `addresses` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/addresses/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: StartFragment{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}EndFragment\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Permission:** You must have the `View_Unit` or `View_Organization_Unit` permission.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\nThe structure and content of the response body follows the pattern below:\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"guid\",\n \"name\": \"string\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the organizational unit. |\n| `name` | `string` | The name of the organizational unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "{{scopeName}}", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:37:10 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "67" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Sales Department Northeast\"\n }\n]" + }, + { + "name": "Success No Content", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "{{scopeName}}", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Error Response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "{{scopeName}}", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Error Response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "{{scopeName}}", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Get all Units from Scope Value - customField", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "customField", + "value", + "{{scopeValue}}" + ] + }, + "description": "This endpoint retrieves data related to scope `customField` associated with organizational units.\n\n---\n\n| **Variables** | Required | Type | **Description** | **Example** |\n| --- | --- | --- | --- | --- |\n| `{{accountName}}` | Yes | `string` | The name of the VTEX account. | `myaccount` |\n| `{{scopeValue}}` | Yes | `string` | The unique identifier for `customField`: Use a stringified JSON object, where keys are field names and values are objects containing an array of `ids`. | `{\"PO Number\":{\"ids\":[\"9025fbdd-6271-11f0-b37f-f5b4d28a6ca2\"]}}` |\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: StartFragment{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}EndFragment\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Permission:** You must have the `View_Unit` or `View_Organization_Unit` permission.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\nThe structure and content of the response body follows the pattern below:\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"guid\",\n \"name\": \"string\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the organizational unit. |\n| `name` | `string` | The name of the organizational unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "customField", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:37:10 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "67" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Sales Department Northeast\"\n }\n]" + }, + { + "name": "Success No Content", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "customField", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Error Response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "customField", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Error Response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "description": "VTEX authentication token", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "scope", + "customField", + "value", + "{{scopeValue}}" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Rename Unit", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{unitName}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + }, + "description": "Updates the name of a specific organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"name\": \"{{unitName}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | New name for the unit. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.8151882Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was originally created. |\n| `updatedAt` | `string` | Timestamp of the most recent update. |\n| `name` | `string` | Updated name of the organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{unitName}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.8151882Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Delete Unit", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + }, + "description": "Deletes a specific organization unit identified by the unit ID.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a body.\n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `unitId` | `string` | Yes | The unique identifier of the unit to delete. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: Empty (indicates successful deletion)" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:37:10 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "67" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Search Units", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/?name={{term}}&page=1&pageSize=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "" + ], + "query": [ + { + "key": "name", + "value": "{{term}}" + }, + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "10" + } + ] + }, + "description": "Retrieves a list of organization units based on the provided query parameters.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/?name={{term}}&page=1&pageSize=10`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | No | A term to filter units by name. |\n| `page` | `number` | No | The page number of the results. |\n| `pageSize` | `number` | No | The number of results per page. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"names\": \"unit-a\"\n },\n \"id\": \"b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-18T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-18T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"names\": \"unit-b\"\n },\n \"id\": \"b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `path.names` | `string` | Full name path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:37:10 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "67" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" + } + ], + "cookie": [], + "body": "[\n {\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"names\": \"unit-a\"\n },\n \"id\": \"b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-18T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-18T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"names\": \"unit-b\"\n },\n \"id\": \"b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n" + } + ] + }, + { + "name": "Move Unit", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"parentId\": \"{{parentId}}\"\r\n}\r\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/path", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "path" + ] + }, + "description": "Updates the path of a specific organization unit, by passing the ID of the unit you wish to be the new parent.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/path`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"parentId\": \"{{parentId}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `parentId` | `string` | Yes | The ID of the new parent unit. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.5957585Z\",\n \"name\": \"hub-365\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp of the most recent update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Updated full ID path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"parentId\": \"{{unitNationaChamberId}}\"\r\n}\r\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/path", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "path" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Wed, 19 Mar 2025 21:28:17 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "140" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "1b917ac5-3755-4930-acc1-8d7753d3ad78" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 bea03c5dc8c5155adf8c603f739f7c60.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "2cRVKSqtJIlzumKgHQfb1ajRMcIWmgQHtsau9Q9dEp1_e9hv7U8GeQ==" + } + ], + "cookie": [], + "body": "{\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.5957585Z\",\n \"name\": \"hub-365\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" + } + ] + }, + { + "name": "Get Unit Children", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/children", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "{{unitId}}", + "children" + ] + }, + "description": "Retrieves the children of a specific organization unit identified by the provided ID.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/children`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"createdAt\": \"2025-03-19T21:44:33.468045Z\",\n \"updatedAt\": \"2025-03-19T21:44:49.331893Z\",\n \"name\": \"unit-1\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\"\n },\n \"id\": \"40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.595758Z\",\n \"name\": \"unit-2\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the child unit was created. |\n| `updatedAt` | `string` | Timestamp when the child unit was last updated. |\n| `name` | `string` | Name of the child organization unit. |\n| `path.ids` | `string` | Full ID path of the child unit. |\n| `id` | `string` | ID of the child organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/b13531bb-8242-43fd-80f5-3263dd4e9cdd/children", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "b13531bb-8242-43fd-80f5-3263dd4e9cdd", + "children" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:40:20 GMT" + }, + { + "key": "x-envoy-upstream-service-time", + "value": "31" + }, + { + "key": "x-envoy-decorator-operation", + "value": "units.units-stable.svc.cluster.local:80/*" + }, + { + "key": "Cache-Control", + "value": "public,max-age=60" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "units-v1.0.0" + }, + { + "key": "x-vtex-operation-id", + "value": "7614c399-6f03-413f-930d-470a4e7611ec" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 0adea8307e9600470efc145509ab5c2e.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "Qt24-cU6kAm7-lUwFvE8l7Pro8ree2ziJQKKC1lSDm2y-z-pX9v30g==" + } + ], + "cookie": [], + "body": "[\n {\n \"createdAt\": \"2025-03-19T21:44:33.468045Z\",\n \"updatedAt\": \"2025-03-19T21:44:49.331893Z\",\n \"name\": \"unit-1\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\"\n },\n \"id\": \"40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.595758Z\",\n \"name\": \"unit-2\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]" + } + ] + }, + { + "name": "Get Root Units", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/roots", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "roots" + ] + }, + "description": "Retrieves all root organization units within the specified account, meaning the first level in the organization unit tree.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/roots`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"createdAt\": \"2025-05-07T21:01:51.588949Z\",\n \"updatedAt\": \"2025-05-07T21:01:51.588949Z\",\n \"name\": \"{{unitName}}\",\n \"path\": {\n \"ids\": \"qastore/0aac12d6-6b22-4483-bd83-eb086c42888e\"\n },\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the root organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/organization-units/v1/roots", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "organization-units", + "v1", + "roots" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "[\n {\n \"createdAt\": \"2025-05-07T21:01:51.588949Z\",\n \"updatedAt\": \"2025-05-07T21:01:51.588949Z\",\n \"name\": \"{{unitName}}\",\n \"path\": {\n \"ids\": \"qastore/0aac12d6-6b22-4483-bd83-eb086c42888e\"\n },\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]" + } + ] + }, + { + "name": "Add User to Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{ \"userIds\": [\"{{userId}}\"]}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users?force=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{unitId}}", + "users" + ], + "query": [ + { + "key": "force", + "value": "false" + } + ] + }, + "description": "Adds one or more users to a specific organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/vtexid/organization-units/{{unitId}}/users?force=false`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n- **Query parameter** `force`: Indicates whether user should be forcefully moved to the unit in the case they are already assigned to another unit. If the `force` query parameter is set to `true`, users already assigned to the unit will be returned in `addedUserIds`. If set to `false`, those users will appear in `failedUserIds` instead.\n \n\n#### Request Body\n\n``` json\n{\n \"userIds\": [\"{{userId}}\"]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `userIds` | `string[]` | Yes | List of user IDs to add to the organization unit. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"addedUserIds\": [\n \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\"\n ],\n \"failedUserIds\": []\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | ID of the organization unit. |\n| `addedUserIds` | `string[]` | List of user IDs that were successfully added. |\n| `failedUserIds` | `string[]` | List of user IDs that failed to be added (can be empty). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{ \"userIds\": [\"{{userEmmaHarris}}\"]}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitNationaChamberId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{unitNationaChamberId}}", + "users" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "157" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 18:50:03 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "vid-v4.181.2" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 6c3d5e1500c1992bef942fe7ee78a09c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "lCW9nAuCQbSDa5WXq55YlywaZUFc4YaukfstlLgf3glA8la6HfIh_Q==" + } + ], + "cookie": [], + "body": "{\n \"organizationUnitId\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"addedUserIds\": [\n \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\"\n ],\n \"failedUserIds\": []\n}" + } + ] + }, + { + "name": "Remove User from Unit", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{ \"userIds\": [\"{{userId}}\"]}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{unitId}}", + "users" + ] + }, + "description": "Removes users from a specific organization unit in the VTEX ID API.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/vtexid/organization-units/{{unitId}}/users`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"userIds\": [\"{{userId}}\"]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `userIds` | `string[]` | Yes | List of user IDs to remove from the unit. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: Empty (indicates successful removal)" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{ \"userIds\": [\"{{userEmmaHarris}}\"]}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{unitId}}", + "users" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "157" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 18:50:03 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "vid-v4.181.2" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 6c3d5e1500c1992bef942fe7ee78a09c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "lCW9nAuCQbSDa5WXq55YlywaZUFc4YaukfstlLgf3glA8la6HfIh_Q==" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "List Users from Unit", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{unitId}}", + "users" + ] + }, + "description": "Retrieves or removes users from a specific organization unit in the VTEX ID API.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Get Users from Organization Unit\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/vtexid/organization-units/{{unitId}}/users`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n#### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n```\n{\n \"users\": [\n {\n \"userId\": \"860cf3ed-1c50-4054-b367-99c8f6138fcc\",\n \"login\": \"daniel.white@email.com\"\n },\n {\n \"userId\": \"37eba317-9154-4844-8ecd-afc5ffb0bf23\",\n \"login\": \"john.thomas@email.com\"\n },\n {\n \"userId\": \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\",\n \"login\": \"emma.harris@email.com\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `userId` | `string` | Unique identifier of the user. |\n| `login` | `string` | Email or login identifier of user. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{unitId}}", + "users" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "17" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 19:35:26 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "vid-v4.181.2" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 c19ece6c416a0e3e3d5938f317467888.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "p8rzoXkLoW66rBHuRfkBYJl0c6Mt0e1tBq7FuTrHtXRxawqvtT-SPA==" + } + ], + "cookie": [], + "body": "{\n \"users\": [\n {\n \"userId\": \"860cf3ed-1c50-4054-b367-99c8f6138fcc\",\n \"login\": \"daniel.white@email.com\"\n },\n {\n \"userId\": \"37eba317-9154-4844-8ecd-afc5ffb0bf23\",\n \"login\": \"john.thomas@email.com\"\n },\n {\n \"userId\": \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\",\n \"login\": \"emma.harris@email.com\"\n }\n ]\n}" + } + ] + } + ], + "description": "Units are an organizational resource that enables hierarchical and exclusive grouping of users. The Top-level organizational unit is typically associated with a contract and serves as the highest entity.\n\nChild organizational units exist within this hierarchy, each with its own users and administrators. If a child organization admin user is assigned, they can manage their unit and any subordinate units below it.\n\nYou can apply scopes at the root level and narrow them down in child units.\n\n## Configure User and Contract Scope for Purchase Flow\n\nThis tutorial outlines the steps needed to create a user, assign the correct permissions, and complete a purchase flow using contract scopes in the new login flow.\n\n### Permissions\n\nA user or appKey must have the `Save user` resource. For testing, you may temporarily assign the Access `Manager - Full Access` role, but ideally, the user or appKey should only have the specific `Save user` permission.\n\n> Learn more about [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) and [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). \n \n\n### Step-by-Step Process\n\nThe relevant APIs are linked in each step of the process.\n\n#### Phase 1: Set Up User and Organization Structure\n\n1. Log in with a user that belongs to the organization and has the required permissions (`Save user`).\n \n2. [Create Unit/Child Unit](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/folder/24701542-eb7eb3f2-34ef-438d-96ae-f8de589958fa?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n3. Create a user. You can use the [Conversation Tracker API](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-a802379f-3db8-402b-8765-86cc9a6ecbbe?action=share&source=copy-link&creator=45103573&ctx=documentation) to do it dynamically.\n \n4. Generate a VTEX ID user and password in VTEX ID for the newly created user. To do this, use the [requests 1-3 in this folder](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/folder/24701542-9fab615c-ff39-4899-9025-2d1f2e143b9f?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n5. [Register the user in License Manager (LM) with the necessary organization associations](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-5003f882-dd7d-47ec-9f2b-00ec80ca9203?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n\n#### Phase 2: Configure Contract and Complete Flow\n\n1. [Create a contract](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-b7f83de6-5caa-477a-bb6e-067cf63d90ee?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n2. [Link the desired scope to the contract](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-652181da-7ca8-4917-9037-2aab2e0969d9?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n3. [Associate the newly created user with the Unit](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-84625d81-7e16-4eb9-a3ae-4ecdaf062708?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n4. [Log in as the new user](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/folder/24701542-8317a373-d626-46c3-acda-46eb2b0700fa?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n5. Complete the user's profile by filling in all required fields. This step is necessary for the checkout process.\n \n\nAfter completing these steps, you should be able to proceed with the purchase flow using the new user and contract scope." + }, + { + "name": "Shopper Data", + "item": [ + { + "name": "Get Shopper Schema", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/schemas/v1", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "dataentities", + "shopper", + "schemas", + "v1" + ] + }, + "description": "This endpoint retrieves a shopper entity [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) with shopper personal data.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/schemas/v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n---\n\n### Response body\n\n``` json\n[\n {\n \"name\": \"v1\",\n \"schema\": {\n \"title\": \"shopper\",\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"document\": {\n \"type\": \"string\"\n },\n \"documentType\": {\n \"type\": \"string\"\n },\n \"phone\": {\n \"type\": \"string\"\n },\n \"cards\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"cardId\": {\n \"type\": \"string\"\n },\n \"paymentSystem\": {\n \"type\": \"string\"\n },\n \"paymentSystemName\": {\n \"type\": \"string\"\n },\n \"cardNumber\": {\n \"type\": \"string\",\n \"pattern\": \"^[\\\\*]{12}[0-9]{4}$\"\n },\n \"bin\": {\n \"type\": \"string\"\n },\n \"expirationDate\": {\n \"type\": \"string\"\n },\n \"useCvvForAuthorization\": {\n \"type\": \"boolean\"\n },\n \"cardLabel\": {\n \"type\": \"string\"\n },\n \"isCardToken\": {\n \"type\": \"boolean\"\n },\n \"availableAddresses\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"additionalProperties\": false\n }\n }\n },\n \"additionalProperties\": false,\n \"required\": [\n \"userId\",\n \"firstName\",\n \"lastName\"\n ],\n \"v-indexed\": [\n \"userId\",\n \"unitId\",\n \"firstName\",\n \"lastName\",\n \"document\",\n \"phone\"\n ]\n }\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `name` | `string` | Schema name. |\n| `schema` | `string` | Object with schema properties. |\n| `schema.title` | `string` | Schema title. |\n| `schema.type` | `string` | Schema type. |\n| `schema.properties` | `string` | Object containing schema properties. |\n| `schema.properties.type` | `string` | Type of property. Allowed types: `array`, `boolean`, `integer`, `number`, `object` and `string`. |\n| `schema.properties.userId` | `string` | Unique shopper identifier. |\n| `schema.properties.email` | `string` | Shopper’s email. |\n| `schema.properties.firstName` | `string` | Shopper’s first name. |\n| `schema.properties.lastName` | `string` | Shoppers last name. |\n| `schema.properties.document` | `string` | Shopper’s document number (e.g., CPF). |\n| `schema.properties.documentType` | `string` | Type of document (e.g., `cpf`). |\n| `schema.properties.phone` | `string` | Shopper’s phone number. |\n| `schema.properties.unitId` | `string` | Unique ID of the Organization Unit. |\n| `schema.properties.cards` | `array` | Array of saved credit cards. |\n| `schema.properties.cards.cardId` | `string` | Unique identifier of the card. |\n| `schema.properties.cards.paymentSystem` | `string` | Payment system code (e.g., `2` for Visa). |\n| `schema.properties.cards.paymentSystemName` | `string` | Name of the payment system (e.g., `Visa`). |\n| `schema.properties.cards.cardNumber` | `string` | Masked card number. |\n| `schema.properties.cards.bin` | `string` | Bank Identification Number – the first digits of the card. |\n| `schema.properties.cards.expirationDate` | `string` | Card expiration date in `MM/YYYY` format. |\n| `schema.properties.cards.useCvvForAuthorization` | `boolean` | Whether CVV is required for authorization. |\n| `schema.properties.cards.cardLabel` | `string` | Label or nickname for the card. |\n| `schema.properties.cards.isCardToken` | `boolean` | Indicates if the card is tokenized. |\n| `schema.properties.cards.availableAddresses` | `array` | List of address IDs available for this card. |\n| `schema.properties.additionalProperties` | `boolean` | Additional properties. |\n| `schema.additionalProperties` | `boolean` | Schema additional properties. |\n| `schema.required` | `array` | Required properties fields. |\n| `schema.v-indexed` | `array` | Indexed properties fields. |" + }, + "response": [] + }, + { + "name": "Create Shopper Document", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"userId\": \"8a9c86b3-3325-4770-bce0-fb6dda4dd942\",\n \"email\": \"fernando.barros+buyer3@vtex.com\",\n\t\"firstName\": \"Fernando\",\n\t\"lastName\": \"Barros\",\n\t\"document\": \"259.559.448-69\",\n\t\"documentType\": \"cpf\",\n\t\"cards\": [],\n \"phone\": \"11917118990\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1", + "protocol": "http", + "host": [ + "{{account}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "dataentities", + "shopper", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + } + ] + }, + "description": "This endpoint creates a shopper entity document.\n\n---\n\n## Request\n\n- **Method**: `POST`\n \n- **URL**: `http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n---\n\n### Request body\n\n``` json\n{\n \"userId\": \"8abea412-4702-46fb-b835-3edb29d8a261\",\n \"email\": \"john@vtex.com\"\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"514.427.690-33\",\n \"documentType\": \"cpf\",\n \"cards\": [],\n \"phone\": \"11917118990\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `userId` | `string` | Yes | Unique identifier for the shopper. |\n| `email` | `string` | No | Shopper's email. |\n| `firstName` | `string` | Yes | Shopper's first name. |\n| `lastName` | `string` | Yes | Shopper's last name. |\n| `document` | `string` | Yes | Shopper's document number (e.g., CPF number). |\n| `documentType` | `string` | Yes | Type of the document provided (e.g., `cpf`). |\n| `cards` | `array` | No | List of cards associated with the user. It must be an empty array. This field will be populated by another API. |\n| `phone` | `string` | No | Shopper’s phone number. |\n| `unitId` | `string` | No | Unique ID of the Organization Unit. |\n\n---\n\n### Response body\n\n``` json\n{\n \"Id\": \"shopper-a26301e6-1a1e-11f0-b37f-e46d3d0578c6\",\n \"Href\": \"\",\n \"DocumentId\": \"a26301e6-1a1e-11f0-b37f-e46d3d0578c6\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the document, often prefixed with the entity name. |\n| `Href` | `string` | URL to access the document. May be empty if not applicable. |\n| `DocumentId` | `string` | Same as `Id`, used internally to identify the document. |" + }, + "response": [] + }, + { + "name": "Get Shopper Document by User ID", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "url": { + "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/documents/{{userId}}", + "protocol": "http", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "dataentities", + "shopper", + "documents", + "{{userId}}" + ] + }, + "description": "This endpoint retrieves a shopper entity document by User ID.\n\n---\n\n## Request\n\n- **Method**: `GET`\n \n- **URL**: `http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/documents/{{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `userId` | `string` | Yes | Unique identifier for the shopper. |\n\n---\n\n### Response\n\n``` json\n{\n \"userId\": \"8abea412-4702-46fb-b835-3edb29d8a261\",\n \"email\": \"john@vtex.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"514.427.690-33\",\n \"documentType\": \"cpf\",\n \"phone\": \"11917118990\"\n \"cards\": [\n{\n \"cardId\": \"D05881AD4F424A6C93D8536C9F7F992E\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************3232\",\n \"bin\": \"22343333\",\n \"availableAddresses\": [\n \"12345\"\n ],\n \"expirationDate\": \"02/2029\",\n \"useCvvForAuthorization\": true,\n \"isCardToken\": false\n }\n ]\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `userId` | `string` | Unique identifier for the shopper. |\n| `email` | `string` | Shopper's email. |\n| `firstName` | `string` | Shopper's first name. |\n| `lastName` | `string` | Shopper's last name. |\n| `document` | `string` | Shopper's document number (e.g., CPF number). |\n| `documentType` | `string` | Type of the document provided (e.g., `cpf`). |\n| `phone` | `string` | Shopper’s phone number. |\n| `unitId` | `string` | Unique ID of the Organization Unit. |\n| `cards` | `array` | List of cards associated with the shopper. |\n| `cards.cardId` | `string` | Unique identifier of the saved card. |\n| `cards.paymentSystem` | `string` | Code representing the payment system (e.g., `2` for Visa). |\n| `cards.paymentSystemName` | `string` | Name of the payment system (e.g., `Visa`). |\n| `cards.cardNumber` | `string` | Masked credit card number. |\n| `cards.bin` | `string` | Bank Identification Number – the first digits of the card. |\n| `cards.availableAddresses` | `array` | Array of address IDs the card is associated with. |\n| `cards.expirationDate` | `string` | Expiry date of the card in `MM/YYYY` format. |\n| `cards.useCvvForAuthorization` | `boolean` | Indicates if CVV is required for authorization. |\n| `cards.isCardToken` | `boolean` | Indicates whether the card data is tokenized. |" + }, + "response": [] + }, + { + "name": "Search Shopper Document", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "url": { + "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/AD/search?_schema=v1&_where=userId={{userId}}&_fields=id,addressName,addressLabel,postalCode,geoCoordinate", + "protocol": "http", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "dataentities", + "AD", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_where", + "value": "userId={{userId}}" + }, + { + "key": "_fields", + "value": "id,addressName,addressLabel,postalCode,geoCoordinate" + } + ] + }, + "description": "This endpoint search a shopper entity document by User ID.\n\n---\n\n## Request\n\n- **Method**: `GET`\n \n- **URL**: `http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/search?_schema=v1&_where=userId={{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Query\n\n| Query | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `_where` | `string` | No | Unique identifier for the shopper. Use the `userId={{userId}}` value. |\n| `_schema` | `string` | No | Schema name. The value must be `v1`. |\n\n---\n\n### Response\n\n``` json\n[\n {\n \"userId\": \"8abea412-4702-46fb-b835-3edb29d8a261\",\n \"email\": \"john@vtex.com\",\n \"fistName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"514.427.690-33\",\n \"documentType\": \"cpf\",,\n \"phone\": \"11917118990\"\n \"cards\": [\n{\n \"cardId\": \"D05881AD4F424A6C93D8536C9F7F992E\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************3232\",\n \"bin\": \"22343333\",\n \"availableAddresses\": [\n \"12345\"\n ],\n \"expirationDate\": \"02/2029\",\n \"useCvvForAuthorization\": true,\n \"isCardToken\": false\n }\n]\n}\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `userId` | `string` | Unique identifier for the shopper. |\n| `email` | `string` | Shopper's email. |\n| `firstName` | `string` | Shopper's first name. |\n| `lastName` | `string` | Shopper's last name. |\n| `document` | `string` | Shopper's document number (e.g., CPF number). |\n| `documentType` | `string` | Type of the document provided (e.g., `cpf`). |\n| `phone` | `string` | Shopper’s phone number. |\n| `unitId` | `string` | Unique identifier for the unit. |\n| `cards` | `array` | List of cards associated with the shopper. |\n| `cards.cardId` | `string` | Unique identifier of the saved card. |\n| `cards.paymentSystem` | `string` | Code representing the payment system (e.g., `2` for Visa). |\n| `cards.paymentSystemName` | `string` | Name of the payment system (e.g., `Visa`). |\n| `cards.cardNumber` | `string` | Masked credit card number. |\n| `cards.bin` | `string` | Bank Identification Number – the first digits of the card. |\n| `cards.availableAddresses` | `array` | Array of address IDs the card is associated with. |\n| `cards.expirationDate` | `string` | Expiry date of the card in `MM/YYYY` format. |\n| `cards.useCvvForAuthorization` | `boolean` | Indicates if CVV is required for authorization. |\n| `cards.isCardToken` | `boolean` | Indicates whether the card data is tokenized. |" + }, + "response": [] + } + ], + "description": "These endpoints will create, update, and retrieve shopper personal information stored in a Master Data entity. These endpoints are complementary to the Units endpoints." + } + ] + }, + { + "name": "Storefront Permissions", + "item": [ + { + "name": "Granted Auth Cookie and Token", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{value:X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{value:X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "users", + "{{userId}}", + "resources", + "{{resourceKey}}", + "granted" + ] + }, + "description": "## Check User Permission on Resource\n\nThis endpoint checks whether a specific user has been granted access to a particular resource in the VTEX License Manager.\n\n> Learn more about permissions in VTEX with [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#). \n \n\n### **Authentication**\n\nThis endpoint accepts `VtexIdclientAutCookie` or `X-VTEX-API-AppKey/X-VTEX-API-AppToken` in the headers.\n\n### Request\n\n**Method:** `GET` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted\n\n ```\n\n**Path Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The ID of the user. |\n| `resourceKey` | string | The key representing the resource. |\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n| `X-VTEX-API-AppKey` | `{{value:X-VTEX-API-AppKey}}` |\n| `X-VTEX-API-AppToken` | `{{value:X-VTEX-API-AppToken}}` |\n\n**Request Body:**\n\nNo request body is required.\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\nReturns `true` if the user has access to the resource, otherwise `false`.\n\n``` json\ntrue\n\n ```" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "users", + "{{userId}}", + "resources", + "{{resourceKey}}", + "granted" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "true" + } + ] + }, + { + "name": "Granted Auth Cookie Only", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie_{tenantName}", + "value": "{{webstore-token}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/bff/users/{{userId}}/resources/{{resourceKey}}/granted/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "bff", + "users", + "{{userId}}", + "resources", + "{{resourceKey}}", + "granted", + "" + ] + }, + "description": "## Check User Permission on Resource\n\nThis endpoint checks whether a specific user has been granted access to a particular resource in the VTEX License Manager.\n\n> Learn more about permissions in VTEX with [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#). \n \n\n### **Authentication**\n\nThis endpoint requires the `VtexIdclientAutCookie_{{tenantName}}={{webstore-token}}` in the headers.\n\n### Request\n\n**Method:** `GET` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted\n\n ```\n\n**Path Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The ID of the user. |\n| `resourceKey` | string | The key representing the resource. |\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie_{{tenantName}}` | `{{webstore-token}}` |\n\n**Request Body:**\n\nNo request body is required.\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\nReturns `true` if the user has access to the resource, otherwise `false`.\n\n``` json\ntrue\n\n ```\n\n> Tenants that call this endpoint without the storefront permissions feature flag enabled will receive a `200 OK` response with `true` in the response body, any combination of `userId` and `resourceKeyId` provided will be considered valid." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "users", + "{{userId}}", + "resources", + "{{resourceKey}}", + "granted" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "true" + } + ] + }, + { + "name": "Assign", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/roles/assign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "roles", + "assign" + ] + }, + "description": "## Assign Role to User\n\nThis endpoint assigns a role to a specific user in the VTEX License Manager. This request can be called by [VTEX IO apps](https://developers.vtex.com/docs/vtex-io-apps) to perform role assignments.\n\n> Roles are groupings of [resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#) that can be assigned to users. Learn more abour [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). \n \n\n### Request\n\n**Method:** `POST` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/roles/assign\n\n ```\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n| `Content-Type` | `application/json` |\n\n**Body Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The user's ID. |\n| `roleId` | integer | The role's ID. |\n\n**Example Body:**\n\n``` json\n{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}\n\n ```\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\n``` json\ntrue\n\n ```\n\nIndicates that the role was successfully assigned to the user." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/roles/assign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "roles", + "assign" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "true" + } + ] + }, + { + "name": "Revoke", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/roles/revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "roles", + "revoke" + ] + }, + "description": "## Revoke Role from User\n\nThis endpoint revokes a role from a specific user in the VTEX License Manager.\n\n> Roles are groupings of [resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#) that can be assigned to users. Learn more abour [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). \n \n\n### Request\n\n**Method:** `DELETE` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/roles/revoke\n\n ```\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n| `Content-Type` | `application/json` |\n\n**Body Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The user's ID. |\n| `roleId` | integer | The role's ID. |\n\n**Example Body:**\n\n``` json\n{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}\n\n ```\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\n``` json\ntrue\n\n ```\n\nIndicates that the role was successfully revoked from the user." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/license-manager/storefront/roles/revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "license-manager", + "storefront", + "roles", + "revoke" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "true" + } + ] + } + ], + "description": "Handles the storefront permissions attributed to users.\n\n## Roles and Permissions\n\nBelow you can learn more abour the different **user roles** available in the procurement and organizational management system, along with their corresponding **permissions**. Each role has specific capabilities tailored to common business functions like purchasing, order approval, and account management. Use this table to understand which role fits your needs and what each user type is allowed to do.\n\n> Each role is associated with a unique **Role ID**, which is used in the API to programmatically assign and manage user roles within the system. \n \n\n| **Permission** | **Organizational Unit Admin** | **Order Approver** | **Order Modifier** | **Buyer** | **Personal Cards User** | **Contract Manager** | **Buyer Organization Manager** | **Contract Viewer** | **Address Manager** |\n| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |\n| _RoleID_ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 |\n| Manage Organization & Contract | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Place Orders | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| View My Contract Orders | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ |\n| View My Org Unit Orders | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ |\n| Modify Orders | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Approve Orders | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Manage Addresses | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |\n| Use ad hoc credit card | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |\n| Manage Authentication | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |\n| View My Cards | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |\n| View Addresses | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |\n| View Budget | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Manage Budget | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| View Buying Policies | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Manage Buying Policies | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n\n### Role descriptions\n\n- **Organizational Unit Admin:** Manages the structure, budget, and policies of an organizational unit.\n \n- **Order Approver:** Reviews and aproves orders placed by others.\n \n- **Order Modifier:** Has permission to adjust orders before final approval or placement.\n \n- **Buyer:** Can place new orders but cannot approve or modify them.\n \n- **Personal Cards User:** Proposed role for users allowed to make purchases using personal or ad hoc credit cards.\n \n- **Contract Manager:** Views and tracks all orders made under a specific contract.\n \n- **Buyer Organization Manager:** Oversees order activity across the entire organization unit.\n \n- **Contract Viewer:** Views authentication, card, and address information.\n \n- **Address Manager:** Manages shipping and billing address records used during order placement.\n \n\n### API Access Requirements\n\nTo use the Storefront Permissions APIs described below, any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). Otherwise they will receive a status code \\`403\\` error. These are the applicable resources for this endpoint:\n\n| Product | Category | Resource |\n| --- | --- | --- |\n| License Manager | Services access control | View Storefront User Permissions |\n| License Manager | Services access control | Edit Storefront User Permissions |\n\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 the resources above in order to use this endpoint.\n\n> To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). \n \n> To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." + }, + { + "name": "Budgets", + "item": [ + { + "name": "Budgets", + "item": [ + { + "name": "Create Budget", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{$randomCompanyName}}\",\n \"description\": \"{{$randomCurrencyName}}\",\n \"amount\": {{$randomInt}},\n \"cycleConfiguration\": {\n \"startDate\": \"{{startDate}}\",\n \"endDate\": \"{{endDate}}\",\n \"autoResetOnPeriodEnd\": {{boolean}},\n \"carryOverBalance\": {{boolean}}\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"{{$randomUUID}}\",\n \"type\": \"{{linkedEntityType}}\"\n },\n \"amount\": {{$randomInt}},\n \"referenceId\": \"{{referenceId}}\",\n \"notificationSettings\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 90,\n \"recipients\": [\n {\n \"email\": \"user2@email.com\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}" + ] + }, + "description": "This endpoint creates a new budget with optional allocations and cycle configuration.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"name\": \"Parker and Sons\",\n \"description\": \"Bermudian Dollar (customarily known as Bermuda Dollar)\",\n \"amount\": 956,\n \"cycleConfiguration\": {\n \"startDate\": \"2025-04-01T00:00:00.0000000Z\",\n \"endDate\": \"2025-04-08T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"4de8235f-ff2d-451b-bfcf-9873aeb9feee\",\n \"type\": \"{{linkedEntityType}}\"\n },\n \"amount\": 639,\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the budget. |\n| `description` | `string` | Yes | Description of the budget. |\n| `amount` | `number` | Yes | Total amount allocated to the budget. |\n| `cycleConfiguration` | `object` | No | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Yes | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | Yes | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Yes | Enable (`true`) or disable (`false`) the autoreset period. |\n| └─ `carryOverBalance` | `boolean` | Yes | Defines wether to carry over balance (`true`) or not (`false`). |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n| `allocations` | `array of objects` | No | Optional list of initial allocations to create with the budget. |\n| └─ `linkedEntity` | `object` | Yes | Information about the entity to which the allocation is linked. |\n| └── `id` | `string` | Yes | Identifier of the entity. If `type` is `User` or `Address`, this should be the ID of the user or address, respectively. If `type` is a custom field (e.g., `PO Number`, `Cost Center`, etc), this should be the **value** of that custom field. |\n| └── `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `amount` | `number` | Yes | Amount allocated. |\n| └─ `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"totalUtilized\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created budget. |\n| `name` | `string` | Name of the budget. |\n| `description` | `string` | Description of the budget. |\n| `balance` | `object` | Budget balance information. |\n| └─ `amount` | `number` | Total amount in the budget. |\n| └─ `totalUtilized` | `number` | Amount already utilized. |\n| └─ `remaining` | `number` | Remaining budget. |\n| `cycleConfiguration` | `object` | Configuration for budget cycle. |\n| └─`startDate` | `string` | Start date of the budget cycle (ISO format). |\n| └─`endDate` | `string` | End date of the budget cycle (ISO format). |\n| └─`autoResetOnPeriodEnd` | `boolean` | Condition if the period will auto reset when ended. |\n| └─`carryOverBalance` | `boolean` | Condition if the remain balance will be transferred to the next cycle. |\n| └─`nextRenewal` | `string` | Next cycle renewal date. |\n| `status` | `string` | Current status of the budget (e.g., `ACTIVE`, `INACTIVE`). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `allocations` | `array of objects` | Optional list of initial allocations to create with the budget. |\n| `id` | `string` | Unique identifier of the allocation. |\n| `budgetId` | `string` | ID of the associated budget. |\n| `linkedEntity` | `object` | Information about the entity to which the allocation is linked. |\n| └── `id` | `string` | Identifier of the entity. If type is `User` or `Address`, this should be the ID of the user or address, respectively. If type is a custom field (e.g., `PO Number`, `Cost Center`, etc), this should be the value of that custom field. |\n| └── `type` | `string` | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `balance` | `object` | Financial details of the allocation. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └── `remaining` | `number` | Remaining balance. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of the context (e.g., `UNIT`, `COSTCENTER`). |\n| `contextId` | `string` | Identifier for the specific context. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Zieme - Bernier\",\n \"description\": \"Czech Koruna\",\n \"amount\": 557,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"contextType\": \"{{context_type}}\",\n \"contextId\": \"{{context_id}}\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"15846e02-2a70-4045-91c3-5ca0d8ada1d5\",\n \"type\": \"PONumber\"\n },\n \"amount\": 451,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + }, + { + "key": "Content-Length", + "value": "404" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 14:58:16 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-5d7dc706948faf117de062d72b9c171b-d9ab20f8fe016e27-01" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "geaNK2sqJRKdHxeMTcr1bLJCH9rNkpPCHhvLUgZbjDS9KDiWoddLHg==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"totalUtilized\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update Budget", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Jones - Lebsack\",\n \"description\": \"Pataca\",\n \"amount\": 783,\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2055-01-01\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint updates an existing budget.\n\n> Note that you can't update the fields `contextType` and `contextId`. You must send the original values, as they are used to validate the request. \n \n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be updated. |\n\n#### Request Body\n\n``` json\n{\n \"name\": \"Graham, O'Reilly and Predovic\",\n \"description\": \"Syrian Pound\",\n \"amount\": 355,\n \"cycleConfiguration\": {\n \"startDate\": \"2025-03-27T00:00:00.0000000Z\",\n \"endDate\": \"2025-04-18T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the budget. |\n| `description` | `string` | Yes | Description of the budget. |\n| `amount` | `number` | Yes | Updated budget amount. |\n| `cycleConfiguration` | `object` | No | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Yes | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | Yes | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Yes | Condition if the period will auto reset when ended. |\n| └─ `carryOverBalance` | `boolean` | Yes | Condition if the remain balance will be transferred to the next cycle. |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"Walker - Waelchi\",\n \"description\": \"Codes specifically reserved for testing purposes\",\n \"balance\": {\n \"amount\": 381,\n \"balanceAdjustment\": 0,\n \"remaining\": 381\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the updated budget. |\n| `name` | `string` | Name of the budget. |\n| `description` | `string` | Description of the budget. |\n| `balance` | `object` | Bugdet balance information. |\n| └─ `amount` | `number` | Total amount in the budget. |\n| └─ `balanceAdjustment` | `number` | Amount already utilized. |\n| └─ `remaining` | `number` | Remaining budget. |\n| `cycleConfiguration` | `object` | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Condition if the period will auto reset when ended. |\n| └─ `carryOverBalance` | `boolean` | Condition if the remain balance will be transferred to the next cycle. |\n| `status` | `string` | Current status of the budget (e.g., `ACTIVE`, `INACTIVE`). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `allocations` | `array of objects` | Optional list of initial allocations to create with the budget. |\n| └─ `id` | `string` | Unique identifier of the allocation. |\n| └─ `budgetId` | `string` | ID of the associated budget. |\n| └─ `linkedEntity` | `object` | Information about the entity to which the allocation is linked. |\n| └── `id` | `string` | Identifier of the entity. If type is `User` or `Address`, this should be the ID of the user or address, respectively. If type is a custom field (e.g., `PO Number`, `Cost Center`, etc), this should be the value of that custom field. |\n| └── `type` | `string` | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `balance` | `object` | Financial details of the allocation. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └── `remaining` | `number` | Remaining balance. |\n| └─ `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| └─ `status` | `string` | Current status of the allocation (e.g., `ACTIVE`). |\n| └─ `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| └─ `contextType` | `string` | Type of the context (e.g., `UNIT`, `COSTCENTER`). |\n| └─ `contextId` | `string` | Identifier for the specific context. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Tromp - Kassulke\",\n \"description\": \"Yen\",\n \"amount\": 490,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"unit\": \"{{unit}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.budget+json" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 14:59:54 GMT" + }, + { + "key": "trace-id", + "value": "00-493d5d793f8c22c08da4baf8396120b5-6f3dc09a51bb94f2-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8925b71bb3654008054231e03eaa658c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "8LjHQy7gWI0W8hzmXNzl7OBNpX8XzAL7qJCNnl00S_PZjVsTwv702g==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"Walker - Waelchi\",\n \"description\": \"Codes specifically reserved for testing purposes\",\n \"balance\": {\n \"amount\": 381,\n \"balanceAdjustment\": 0,\n \"remaining\": 381\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": []\n}\n" + } + ] + }, + { + "name": "Update Budget Status", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}accept:*/*", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"INACTIVE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "status" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint updates the status of a specific budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/status`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be updated. |\n\n#### Request Body\n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `status` | `string` | Yes | New status value for the budget (e.g., `ACTIVE` or `INACTIVE`). |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `status` | `string` | The updated budget status (e.g., `ACTIVE` or `INACTIVE`). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"ACTIVE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "status" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.update-budget-activation+json" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 15:01:12 GMT" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-e5d00c476c44c49289159a1ec5ce022b-8762e42545b8ad33-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8925b71bb3654008054231e03eaa658c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "oo1TsBeC0Np82ARzIp_1dX8pAgNjAJTxTKTslFmLWNkZNIhcNfML2w==" + } + ], + "cookie": [], + "body": "{\n \"status\": \"ACTIVE\"\n}" + } + ] + }, + { + "name": "Get Budget", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint retrieves the details of a specific budget.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be retrieved. |\n\n> ℹ️ This endpoint does not require a request body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Budget ID. |\n| `name` | `string` | Name of the budget. |\n| `description` | `string` | Description of the budget. |\n| `balance` | `object` | Balance information. |\n| └─ `amount` | `number` | Budget amount. |\n| └─ `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └─ `remaining` | `number` | Remaining balance. |\n| `cycleConfiguration` | `object` | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Condition if the period will auto reset when ended. |\n| └─ `carryOverBalance` | `boolean` | Condition if the remain balance will be transferred to the next cycle. |\n| └─ `nextRenewal` | `boolean` | Condition if the next cycle will be renewal. |\n| `status` | `string` | Current status of the budget (e.g., `ACTIVE`). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `allocations` | `array of objects` | Optional list of initial allocations to create with the budget. |\n| └─ `id` | `string` | Unique identifier of the allocation. |\n| └─ `budgetId` | `string` | ID of the associated budget. |\n| └─ `linkedEntity` | `object` | Entity to which the allocation is linked. |\n| └── `id` | `string` | ID of the linked entity (e.g., user or unit). |\n| └── `type` | `string` | Type of the entity (e.g., `USER`, `UNIT`). |\n| └─ `balance` | `object` | Financial details of the allocation. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └── `remaining` | `number` | Remaining balance. |\n| └─ `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE`). |\n| `referenceId` | `string` | ID of the related contract. |\n| `contextType` | `string` | Type of the context (e.g., `UNIT`, `COSTCENTER`). |\n| `contextId` | `string` | Identifier for the specific context. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.budget+json" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:34:57 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.004" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.008" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-4d1d81c147ba52eacabcdf134c359936-6b7dfd491b14189d-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-53-209" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.010" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 fc69aa762ce53e7ffff1543dcab64112.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG52-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "rPVRa0Js1FdKT7eDAE3wSpGk96e0L7HfjiM0bdhCa4rte_ZlX15wMA==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n" + } + ] + }, + { + "name": "List Budgets", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}?page=1&pageSize=20&minAmount=0&maxAmount=500&status=ACTIVE&name=Marketing Budget 2024", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + }, + { + "key": "minAmount", + "value": "0" + }, + { + "key": "maxAmount", + "value": "500" + }, + { + "key": "status", + "value": "ACTIVE" + }, + { + "key": "name", + "value": "Marketing Budget 2024" + } + ] + }, + "description": "Retrieves a paginated list of budgets filtered by context and amount range.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | Yes | Page number to retrieve. |\n| `pageSize` | `integer` | Yes | Number of results per page. |\n| `minAmount` | `float` | No | Minimum budget amount for filtering. |\n| `maxAmount` | `float` | No | Maximum budget amount for filtering. |\n| `status` | `string` | No | Filter by status (e.g., `ACTIVE`, `INACTIVE`). |\n| `name` | `string` | No | Budget name. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 2\n },\n \"items\": [\n {\n \"id\": \"ffc4575e-5e5c-420e-bcb7-bf4a271f5d60\",\n \"name\": \"Graham, O'Reilly and Predovic\",\n \"startDate\": \"2025-03-27T00:00:00.0000000Z\",\n \"endDate\": \"2025-04-18T00:00:00.0000000Z\",\n \"balance\": {\n \"amount\": 657,\n \"balanceAdjustment\": 0,\n \"remaining\": 657\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"unit123\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination information. |\n| └─ `current` | `integer` | Current page number. |\n| └─ `pages` | `integer` | Total number of pages. |\n| └─ `results` | `integer` | Total number of results. |\n| `items` | `array of objects` | Array of budget summaries. |\n| └─`id` | `string` | Identifier of the budget. |\n| └─`name` | `string` | Name of the budget. |\n| └─`startDate` | `string` | Start date of the budget. |\n| └─`endDate` | `string` | End date of the budget. |\n| └─`balance` | `object` | Bugdet balance information. |\n| └──`amount` | `number` | Total budget amount. |\n| └──`balanceAdjustment` | `number` | Amount already used. |\n| └──`remaining` | `number` | Remaining budget. |\n| └─ `status` | `string` | Current status of the allocation (`ACTIVE` or `INACTIVE`). |\n| └─ `contextType` | `string` | Context type. |\n| └─ `contextId` | `string` | Identification of the context type. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets?page=1&pageSize=20&contextType={{context_type}}&minAmount=0&maxAmount=500&status=ACTIVE&contextId={{context_id}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + }, + { + "key": "contextType", + "value": "{{context_type}}" + }, + { + "key": "minAmount", + "value": "0" + }, + { + "key": "maxAmount", + "value": "500" + }, + { + "key": "status", + "value": "ACTIVE" + }, + { + "key": "contextId", + "value": "{{context_id}}" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.list-budgets+json" + }, + { + "key": "Content-Length", + "value": "506" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:35:49 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.104" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-7baa2ccd2bb222add075f6bee525ac35-50c4c614b4ef0645-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-21-30" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.107" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 fc69aa762ce53e7ffff1543dcab64112.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG52-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "pdyB7xtrrcX6gdTVNTn81DIsMgvoH28Imdo-rvVFvgPiwM7rJPzM_A==" + } + ], + "cookie": [], + "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 2\n },\n \"items\": [\n {\n \"id\": \"ffc4575e-5e5c-420e-bcb7-bf4a271f5d60\",\n \"name\": \"Graham, O'Reilly and Predovic\",\n \"startDate\": \"03/27/2025 00:00:00\",\n \"endDate\": \"04/18/2025 00:00:00\",\n \"balance\": {\n \"amount\": 657,\n \"balanceAdjustment\": 0,\n \"remaining\": 657\n },\n \"notifyThresholds\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 75\n }\n ],\n \"status\": \"INACTIVE\"\n },\n {\n \"id\": \"a523928a-2124-40a1-b9a1-675c8f15fe04\",\n \"name\": \"Thompson and Sons\",\n \"startDate\": \"04/01/2025 00:00:00\",\n \"endDate\": \"04/08/2025 00:00:00\",\n \"balance\": {\n \"amount\": 642,\n \"balanceAdjustment\": 0,\n \"remaining\": 642\n },\n \"notifyThresholds\": [\n {\n \"type\": \"AMOUNT\",\n \"threshold\": 215.80\n }\n ],\n \"status\": \"ACTIVE\"\n }\n ]\n}" + } + ] + }, + { + "name": "Reset Budget", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"origin\": \"Conversion\",\r\n \"reference\": \"6787190b-1a55-46cb-b95e-f677f1fdfbc7\",\r\n \"amount\": 505,\r\n \"type\": \"Debit\",\r\n \"requestedBy\": \"user1@email.com\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationID}}/usage", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationID}}", + "usage" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint resets the budget to a specified value.\n\nYou can define the usage amount whenever needed. For example, suppose you set a budget and record an initial debit of USD 500. After 10 days, the new usage is USD 900. In this case, you don’t need to review all the individual transactions — you can simply update the usage amount directly to USD 900.\n\n> Note that you can't update the fields contextType and contextId. You must send the original values, as they are used to validate the request. \n \n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/usage`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the overall budget being updated. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"Conversion\",\n \"reference\": \"6787190b-1a55-46cb-b95e-f677f1fdfbc7\",\n \"amount\": 505,\n \"type\": \"Debit\",\n \"requestedBy\": \"user1@email.com\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | Describes the origin or reason for the adjustment. |\n| `reference` | `string` | Yes | A reference ID tied to the transaction (e.g., order ID). |\n| `amount` | `number` | Yes | The amount of budget used for this allocation. When set to `0`, your budget will correspond to USD 0. |\n| `type` | `string` | Yes | Operation type, which can be `Credit` or `Debit`. |\n| `requestedBy` | `string` | Yes | Indicates who triggered the request — it can be a username, system name, or business process name. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: There is no response body." + }, + "response": [] + }, + { + "name": "Delete Budget", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint deletes a specific budget.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be retrieved. |\n\n> ℹ️ This endpoint does not require a request body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body:** There is no response body." + }, + "response": [] + } + ], + "description": "With these endpoints you can create and manage budgets, which represent the main financial container.\n\n### Budget and Allocation\n\nEach Budget can have one or more **Allocations**, which are subdivisions of the total balance within that budget.\n\nEach **Budget** and **Allocation** has its own **amount**, **start date**, and **end date**. When funds are added to or removed from an Allocation, the corresponding Budget’s total amount is updated accordingly to reflect the change.\n\n### Transactions and Reservations\n\nTo move funds from an Allocation, there are two options:\n\n- **Direct Transaction** \n Used when you want to actually consume the balance. This creates a definitive entry that appears in the **Statements** (transaction history).\n \n- **Reservation** \n Used to temporarily reserve funds without consuming them immediately. Later, you can either:\n \n - **Confirm the reservation**, which automatically creates a transaction.\n \n - **Delete the reservation**, which simply releases the reserved balance without generating any transaction (it does not appear in the Statements).\n \n\n### Refunds\n\nTransactions cannot be deleted. If you need to undo a transaction, you must create a **Refund**, which is a new transaction with the type. Both the original transaction and the refund will appear in the Statements, with a net effect of zero.\n\n### Transaction types\n\nWhen you get a budget or allocation statement, each transaction contains a `type` field, which can carry two values:\n\n- `DEBIT`: Regular transactions, subtracting funds from the budget or allocation.\n \n- `CREDIT`: Associated with refunds, meaning it adds funds to the budget or allocation.\n \n\n### Typical API Call Order\n\n1. Create the **Budget**\n \n2. Create one or more **Allocations**\n \n3. Perform a **Transaction** or a **Reservation**\n \n4. Retrieve the transaction history using the **Statements** endpoints\n \n\n> In a typical purchase flow, we do not use Reservations. We create direct Transactions and use Refunds when needed." + }, + { + "name": "Allocations", + "item": [ + { + "name": "Create Allocation", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"linkedEntity\": {\n \"id\": \"f07c85ed-ea1f-443e-953d-0f1b094ed012\",\n \"type\": \"CostCenter\"\n },\n \"referenceId\": \"4d00d477-e4fe-4345-b5cd-ba2ef1725cc8\",\n \"amount\": 658,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations" + ] + }, + "description": "This endpoint creates a new allocation within a specific VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to create an allocation. |\n\n#### Request Body\n\n``` json\n{\n \"linkedEntity\": {\n \"id\": \"f07c85ed-ea1f-443e-953d-0f1b094ed012\",\n \"type\": \"CostCenter\"\n },\n \"referenceId\": \"4d00d477-e4fe-4345-b5cd-ba2ef1725cc8\",\n \"amount\": 658,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `linkedEntity` | `object` | Yes | Linked entity information. |\n| └─ `id` | `string` | Yes | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| `amount` | `number` | Yes | Amount allocated. |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"3bfdafe0-a111-4ce9-9205-1dd5f872b44e\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 358,\n \"balanceAdjustment\": 0,\n \"remaining\": 358\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"67c9779d-b9a8-4512-a746-5f41361c7270\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created allocation. |\n| `budgetId` | `string` | Identifier of the budget. |\n| `linkedEntity` | `object` | Linked entity information. |\n| └─ `id` | `string` | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `balance` | `object` | Bugdet balance information. |\n| └─ `amount` | `number` | Total amount in the budget. |\n| └─ `balanceAdjustment` | `number` | Amount already utilized. |\n| └─ `remaining` | `number` | Remaining budget. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE` or `INACTIVE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of context (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"linkedEntity\": {\n \"id\": \"528b4e1f-b69d-463d-ae3c-42cf5fbeabc0\",\n \"type\": \"Cont\"\n },\n \"amount\": 868,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"referenceId\": \"67c9779d-b9a8-4512-a746-5f41361c7270\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.allocation+json" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:37:09 GMT" + }, + { + "key": "trace-id", + "value": "00-5343aeed0311c4e04a8cd15dabe8ca98-cf9e7818d1aaff67-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 06208dccf6b8f2d31c71f7b12d1e4bae.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG52-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "Z1vgzK7z7eODhSwU-a754H8Pti9pCYbkxPwXehRZ_iDz_bU69tP-EQ==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"3bfdafe0-a111-4ce9-9205-1dd5f872b44e\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 358,\n \"balanceAdjustment\": 0,\n \"remaining\": 358\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"67c9779d-b9a8-4512-a746-5f41361c7270\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}" + } + ] + }, + { + "name": "Create Batch of Allocations", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040\n },\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/batch", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "batch" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoints creates one or more budget allocations in batch under a specific VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/batch`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to create a batch of allocation. |\n\n#### Request Body\n\n``` json\n{\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"contractId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040\n },\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040,\n \"notificationSettings\": [\n {\n \"type\": \"Amount\",\n \"threshold\": 121,\n \"recipients\": [\n {\n \"email\": \"user1@email.com\"\n }\n ]\n }\n ]\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `allocations` | `array of objects` | Yes | List of allocation objects to be created. |\n| └─ `linkedEntity` | `object` | Yes | Linked entity information. |\n| └── `id` | `string` | Yes | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └── `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| └─ `amount` | `number` | Yes | Amount allocated. |\n| └─ `notificationSettings` | `object` | No | List of thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └── `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └── `threshold` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └── `recipients` | `array of objects` | No | List of recipients to notify. |\n| └─── `email` | `string` | No | Email address of the recipient. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n``` json\n{\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"allocations\": [\n {\n \"id\": \"0197c1f8-082a-776a-ade2-992badbcc96a\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"balanceAdjustment\": 0,\n \"remaining\": 2040\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n },\n {\n \"id\": \"0197c1f8-082a-776b-9eb4-f9d4822f6c34\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"balanceAdjustment\": 0,\n \"remaining\": 2040\n },\n \"notificationSettings\": [\n {\n \"type\": \"AMOUNT\",\n \"threshold\": 121,\n \"recipients\": [\n {\n \"email\": \"user1@email.com\"\n }\n ]\n }\n ],\n \"status\": \"ACTIVE\",\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `budgetId` | `string` | Unique identifier of the budget. |\n| `allocations` | `array of objects` | List of allocation objects to be created. |\n| └─ `id` | `string` | Allocation ID. |\n| └─ `budgetId` | `string` | Budget ID. |\n| └─ `linkedEntity` | `object` | Linked entity information. |\n| └── `id` | `string` | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └── `type` | `string` | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `balance` | `object` | Allocation balance information. |\n| └── `amount` | `number` | Amount allocated. |\n| └── `balanceAdjustment` | `number` | Allocation balance adjustments. |\n| └── `remaining` | `number` | Balance remaining. |\n| └─ `notificationSettings` | `object` | List of thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └── `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └── `threshold` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └── `recipients` | `array of objects` | List of recipients to notify. |\n| └─── `email` | `string` | Email address of the recipient. |\n| └─ `status` | `string` | Current status of the allocation (e.g., `ACTIVE` or `INACTIVE`). |\n| └─ `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| └─ `contextType` | `string` | Type of context (`UNIT`). |\n| └─ `contextId` | `string` | Identifier of the context entity. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"ef3a32c3-4984-44cf-820b-ae864f41d95b\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 215,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"referenceId\": {{referenceId}},\n \"notifyThresholds\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 75\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/batch", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "batch" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"allocations\": [\n {\n \"id\": \"0197c1f8-082a-776a-ade2-992badbcc96a\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"totalUtilized\": 0,\n \"remaining\": 2040\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n },\n {\n \"id\": \"0197c1f8-082a-776b-9eb4-f9d4822f6c34\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"totalUtilized\": 0,\n \"remaining\": 2040\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contractId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update Allocation", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"linkedEntity\": {\n \"id\": \"5ae133af-ea31-44b4-a74e-9e14752673c4\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 40,\n \"referenceId\": \"50e7cb46-ec05-441c-b558-78160798ceb6\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 90\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}" + ] + }, + "description": "This endpoint updates an exiting budget allocation within a specific VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"linkedEntity\": {\n \"id\": \"5ae133af-ea31-44b4-a74e-9e14752673c4\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 40,\n \"contractId\": \"50e7cb46-ec05-441c-b558-78160798ceb6\",\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"contractId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040\n },\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"EMAIL\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `linkedEntity` | `string` | Yes | Linked entity information. |\n| └─ `id` | `string` | Yes | Identifier of the entity linked to this allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Yes | Type of the linked entity Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `amount` | `number` | Yes | Budget amount allocated. |\n| `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"99805a66-143c-4409-a674-600b77e10fe9\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 51,\n \"balanceAdjustment\": 0,\n \"remaining\": 51\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"EMAIL\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"2c817a12-fafd-4fc9-becb-727dd7777d5f\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the updated allocation. |\n| `budgetId` | `string` | ID of the budget. |\n| `linkedEntity` | `string` | Linked entity information. |\n| └─ `id` | `string` | Identifier of the entity linked to this allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `balance` | `number` | Budget balance information. |\n| └─ `amount` | `number` | Allocated amount. |\n| └─ `balanceAdjustment` | `number` | Total utilized amount. |\n| └─ `remaining` | `number` | Remaining balance. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE` or `INACTIVE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"linkedEntity\": {\n \"id\": \"09140d1b-878f-4f2f-8850-8e16819bee7e\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 484,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"contractId\": \"123\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.allocation+json" + }, + { + "key": "Content-Length", + "value": "427" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:39:23 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-013dbc4cf691d503f3f58cd3ac3bf150-16eee697b09e0860-01" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 90c491496585980aceb1033cb1612270.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "VMOHdH8YFqJG6vbq_mMJbuvd7c9ov3hZBUo7L-Ss1k9JZ2XLYOY3Yg==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"99805a66-143c-4409-a674-600b77e10fe9\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 51,\n \"balanceAdjustment\": 0,\n \"remaining\": 51\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 90\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"2c817a12-fafd-4fc9-becb-727dd7777d5f\"\n}" + } + ] + }, + { + "name": "Delete Allocation", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}" + ] + }, + "description": "This endpoint deletes a specific allocation from a budget.\n\n> Allocations are not definitively deleted, they are maintained for the sake of record keeping. When looking at statements you will be able to see transaction history for deleted allocations. \n \n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n> ℹ️ This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n> ℹ️ The allocation was successfully deleted. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.empty+json" + }, + { + "key": "Content-Length", + "value": "2" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:55:56 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-9699de70be9e180c3dd01a24cfa995b6-a3848bf333d50796-01" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 06208dccf6b8f2d31c71f7b12d1e4bae.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG52-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "yp-RGr5nOPflfYT37NR6RLl3ynXqFgtQEg8_K0Y3VPDT7nJZTJueZA==" + } + ], + "cookie": [], + "body": "{}" + } + ] + }, + { + "name": "Get Allocation", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint retrieves a specific allocation within a VTEX budget by its ID.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n> ℹ️This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c65e-1012-70f3-9fef-52bd7fe66a13\",\n \"budgetId\": \"0197c251-5b00-707b-9023-4f3d386be220\",\n \"linkedEntity\": {\n \"id\": \"d5c996af-455e-4b76-a36d-43376e96d82a\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 864,\n \"balanceAdjustment\": 0,\n \"remaining\": 864\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"cd1e8e85-bc9e-479e-b2a5-8d916a33618f\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the allocation. |\n| `budgetId` | `string` | ID of the budget. |\n| `linkedEntity` | `string` | Linked entity information. |\n| └─ `id` | `string` | Identifier of the entity linked to this allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `balance` | `number` | Budget balance information. |\n| └─ `amount` | `number` | Allocated amount. |\n| └─ `balanceAdjustment` | `number` | Total utilized amount. |\n| └─ `remaining` | `number` | Remaining balance. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE`, `INACTIVE` or `DELETE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + }, + { + "key": "Content-Length", + "value": "427" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:44:26 GMT" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-8d877e1d30d92b259e76a351900595aa-da324a4415ecca3f-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-36-99" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.033" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.032" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 d32fe7eed019f3eb6d4b418469d9db02.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "irSLzixo-kdsaMnXe4FvItwGJdKD_J7APxBi0VDUcOfVD54iQPSZig==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0197c65e-1012-70f3-9fef-52bd7fe66a13\",\n \"budgetId\": \"0197c251-5b00-707b-9023-4f3d386be220\",\n \"linkedEntity\": {\n \"id\": \"d5c996af-455e-4b76-a36d-43376e96d82a\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 864,\n \"balanceAdjustment\": 0,\n \"remaining\": 864\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"cd1e8e85-bc9e-479e-b2a5-8d916a33618f\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}" + } + ] + }, + { + "name": "Query Allocations", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/allocations/query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "allocations", + "query" + ] + }, + "description": "This endpoint queries budget allocations by context and linked entities.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/allocations/query`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"items\": [\n {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `items` | `array of objects` | Yes | List of linked entities to query allocations for. |\n| └─ `id` | `string` | Yes | Identifier of the linked entity. |\n| └─ `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"items\": [\n {\n \"budgetId\": \"0197c65f-a1d3-71e8-ab11-013cc2f7f023\",\n \"allocationId\": \"0197c65f-bfb3-7452-8ae2-edf9f83624ae\",\n \"linkedEntity\": {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n },\n \"budgetBalance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"budgetEndDate\": \"2055-01-01T00:00:00.0000000\",\n \"allocationBalance\": {\n \"amount\": 13,\n \"balanceAdjustment\": 0,\n \"remaining\": 13\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `items` | `array of objects` | List of matching allocation entries. |\n| └─ `budgetId` | `string` | Identifier of the budget to which the allocation belongs. |\n| └─ `allocationId` | `string` | Identifier of the specific allocation. |\n| └─ `linkedEntity` | `object` | Linked entity object containing `id` and `type`. |\n| └── `id` | `string` | Identifier of the linked entity. |\n| └── `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release`, or `Location`). |\n| └─ `budgetBalance` | `object` | Budget balance information. |\n| └── `amount` | `number` | Total budget amount. |\n| └── `balanceAdjustment` | `number` | Total amount utilized from the budget. |\n| └── `remaining` | `number` | Remaining amount in the budget. |\n| └─ `budgetEndDate` | `string` (date-time) | Date when the budget ends, in ISO 8601 format. |\n| └─ `allocationBalance` | `object` | Allocation balance information. |\n| └── `amount` | `number` | Total allocation amount. |\n| └── `balanceAdjustment` | `number` | Total amount utilized from the allocation. |\n| └── `remaining` | `number` | Remaining amount in the allocation. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"contextType\": \"Organizaztion\",\n \"contextId\": \"{{contextId}}\",\n \"Items\": [\n {\n \"Id\": \"565db6d8-e125-404d-8d9d-20d96dce10c6\",\n \"Type\": \"Cont\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/allocations/query", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "allocations", + "query" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.query-allocation+json" + }, + { + "key": "Content-Length", + "value": "192" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:54:04 GMT" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-fff9603a54d5e92a21c477565fa772dc-aa828b4c3343fc7e-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "fmAT8PB39_P3hHdWtzpeZpei7A1q5n-p1sv7KGzLl1CTgS5NguTPOA==" + } + ], + "cookie": [], + "body": "{\n \"items\": [\n {\n \"budgetId\": \"0197c65f-a1d3-71e8-ab11-013cc2f7f023\",\n \"allocationId\": \"0197c65f-bfb3-7452-8ae2-edf9f83624ae\",\n \"linkedEntity\": {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n },\n \"budgetBalance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"budgetEndDate\": \"2055-01-01T00:00:00.0000000\",\n \"allocationBalance\": {\n \"amount\": 13,\n \"balanceAdjustment\": 0,\n \"remaining\": 13\n }\n }\n ]\n}" + } + ] + }, + { + "name": "List Budget Allocations", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/?type={{type}}&page={{page}}&pageSize={{pageSize}}&status={{status}}&referenceId={{referenceId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "" + ], + "query": [ + { + "key": "type", + "value": "{{type}}" + }, + { + "key": "page", + "value": "{{page}}" + }, + { + "key": "pageSize", + "value": "{{pageSize}}" + }, + { + "key": "status", + "value": "{{status}}" + }, + { + "key": "referenceId", + "value": "{{referenceId}}" + } + ] + }, + "description": "### Endpoint Summary\n\nThis endpoints retrieves the allocations for a specific budget, with optional filtering by entity type.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/?Type={{type}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n\n> ℹ️ This request does not require a body. \n \n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `type` | `string` | No | Filters the allocations by linked entity type. (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `page` | `integer` | No | |\n| `pageSize` | `integer` | No | |\n| `status` | `string` | No | Filters the allocations by status. |\n| `contractId` | `string` | No | Filters the allocations by contract ID. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 3\n },\n \"items\": [\n {\n \"id\": \"f8dc5da1-bac5-4d5c-8907-b29f8dda4e18\",\n \"budgetId\": \"d5793a13-c453-483b-8fc3-d17d96282c15\",\n \"linkedEntity\": {\n \"id\": \"565db6d8-e125-404d-8d9d-20d96dce10c6\",\n \"type\": \"Cont\"\n },\n \"balance\": {\n \"amount\": 26,\n \"balanceAdjustment\": 0,\n \"remaining\": 26\n },\n \"status\": \"DELETED\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination information. |\n| └─ `current` | `number` | Current page number. |\n| └─ `pages` | `number` | Total number of available pages. |\n| └─ `results` | `number` | Total number of results. |\n| `items[]` | `array of objects` | List of budget allocations. |\n| └─ `id` | `string` | Identifier of the allocation. |\n| └─ `budgetId` | `string` | Identifier of the budget to which the allocation belongs. |\n| └─ `linkedEntity` | `object` | Linked entity information. |\n| └── `id` | `string` | Identifier of the linked entity. |\n| └── `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| └─ `balance` | `object` | Budget balance information. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Total amount used. |\n| └── `remaining` | `number` | Remaining balance. |\n| └─ `status` | `string` | Status of the allocation (e.g., `ACTIVE`, `INACTIVE` or `DELETE`). |\n| └─ `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| └─ `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/?Type=CoNt", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "" + ], + "query": [ + { + "key": "Type", + "value": "CoNt" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.list-allocation+json" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 17:57:03 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.044" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-88fab764e47381b1cc029b784a59c4a3-ed961835c94236f7-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-30-248" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.049" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 06208dccf6b8f2d31c71f7b12d1e4bae.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG52-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "1dCNP2IeyrQr9qIh7y3ynXoD1ImIkbdvNlSCI-Mf8HlztrOFBX-M-w==" + } + ], + "cookie": [], + "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 3\n },\n \"items\": [\n {\n \"id\": \"f8dc5da1-bac5-4d5c-8907-b29f8dda4e18\",\n \"budgetId\": \"d5793a13-c453-483b-8fc3-d17d96282c15\",\n \"linkedEntity\": {\n \"id\": \"565db6d8-e125-404d-8d9d-20d96dce10c6\",\n \"type\": \"Cont\"\n },\n \"balance\": {\n \"amount\": 26,\n \"balanceAdjustment\": 0,\n \"remaining\": 26\n },\n \"notifyThresholds\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 75\n }\n ],\n \"startDate\": \"03/26/2025 00:00:00\",\n \"endDate\": \"04/12/2025 00:00:00\",\n \"status\": \"DELETED\"\n }\n ]\n}" + } + ] + }, + { + "name": "Change Allocation Status", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"ACTIVE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/status/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "status", + "" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint updates the status of a specific allocation within a budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/status/`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `status` | `string` | Yes | The new status value to apply to allocation (e.g., `ACTIVE` or `INACTIVE` ). |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `status` | `string` | The updated status of the allocation (e.g., `ACTIVE`, `INACTIVE`). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"ACTIVE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/status/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "status", + "" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.vtex.update-allocation-activation+json" + }, + { + "key": "Content-Length", + "value": "19" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Thu, 10 Apr 2025 18:00:11 GMT" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "budget-v0.1.11" + }, + { + "key": "Cache-Control", + "value": "private, no-store" + }, + { + "key": "trace-id", + "value": "00-e9f3ed52afe43e076de29155baa48191-3991ba2f0afa33b7-01" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 7d30be9f6840d1673dd31a7f323a018c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG52-P1" + }, + { + "key": "X-Amz-Cf-Id", + "value": "sm8UVyeVTnX4Za0n2CqtzwjPMbF1FeyxYkVLF3ZWXCzOw1Vnl2w1lA==" + } + ], + "cookie": [], + "body": "{\n \"status\": \"ACTIVE\"\n}" + } + ] + }, + { + "name": "Update Allocation Usage", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"origin\": \"manual-adjustment\",\r\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\r\n \"amount\": 150.0,\r\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\r\n \"type\": \"Debit\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}//budgets/{{contextType}}/{{contextId}}/{{budgetId}}/allocations/{{allocationId}}/usage", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "", + "budgets", + "{{contextType}}", + "{{contextId}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "usage" + ] + }, + "description": "This endpoint updates the usage of a specific allocation within a budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/usage/`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": 150.0,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"type\": \"CREDIT\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | Describes the origin or reason for the adjustment. |\n| `reference` | `string` | No | Reference ID or note for tracking the adjustment. |\n| `amount` | `number` | Yes | Amount to adjust (positive or negative). |\n| `requestedBy` | `string` | Yes | Identifier or name of the system requesting the change. |\n| `type` | `string` | Yes | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n\n---\n\n### Response\n\n`200 - OK`\n\n``` json\n{}\n\n ```\n\nℹ️ This request returns an empty response." + }, + "response": [] + } + ], + "description": "Allocations are subdivisions of the main budget allocated to categories, projects, or departments.\n\nWith these endpoints you can create and manage the budget allocation of your store." + }, + { + "name": "Reservations", + "item": [ + { + "name": "Create Reservation", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"origin\": \"{{origin}}\",\n \"reference\": \"{{reference}}\",\n \"amount\": {{amount}},\n \"requestedBy\": \"{{requestedBy}}\",\n \"reservationId\": \"{{reservationId}}\",\n \"type\": \"{{type}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint creates a temporary reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"reservationId\": \"c3722334-3892-418c-a099-b13e9c562c7e\",\n \"type\": \"DEBIT\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Yes | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Yes | Amount to be reserved. |\n| `requestedBy` | `string` | Yes | Email of the user initiating the reservation. |\n| `reservationId` | `string` | Yes | Client-defined identifier for the reservation. |\n| `type` | `string` | Yes | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created reservation. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved. |\n| `requestedBy` | `string` | Email of the user who requested the reservation. |\n| `date` | `string` | Reservation date (ISO format). |\n| `type` | `string` | Adjustment type. |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"origin\": \"{{origin}}\",\n \"reference\": \"{{reference}}\",\n \"amount\": {{amount}},\n \"requestedBy\": \"{{requestedBy}}\",\n \"reservationId\": \"{{reservationId}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"budgetBalance\": {\n \"amount\": 475,\n \"balanceAdjustment\": 528,\n \"remaining\": -53\n },\n \"allocationBalance\": {\n \"amount\": 31,\n \"balanceAdjustment\": 528,\n \"remaining\": -497\n },\n \"status\": \"RESERVED\"\n}" + } + ] + }, + { + "name": "Confirmation Reservation", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}/confirmation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations", + "{{reservationId}}", + "confirmation" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint confirms a reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}/confirmation`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n#### Request Body\n\n``` json\n{\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `requestedBy` | `string` | Yes | Email of the user confirming the reservation. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created reservation. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved. |\n| `requestedBy` | `string` | Email of the user who requested the reservation. |\n| `date` | `string` | Reservation date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}/confirmation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations", + "{{reservationId}}", + "confirmation" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"status\": \"CONFIRMED\"\n}" + } + ] + }, + { + "name": "Delete Reservation", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations", + "{{reservationId}}" + ] + }, + "description": "### Endpoint Summary\n\nThis enpoint cancels a reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `requestedBy` | `string` | Yes | Email of the user canceling the reservation. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the canceled reservation. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the canceled reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the canceled reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved which was canceled. |\n| `requestedBy` | `string` | Email of the user who requested the cancellation. |\n| `date` | `string` | Canceled eservation date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations", + "{{reservationId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"id\": \"db09af7d-c39b-47c4-8724-d693c41e7715\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"status\": \"CANCELLED\"\n}" + } + ] + }, + { + "name": "Get Reservation", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations", + "{{reservationId}}" + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint retrieves a reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n> ℹ️ This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Reservation identifier. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved. |\n| `requestedBy` | `string` | Email of the user who requested the reservation. |\n| `date` | `string` | Reservation date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations", + "{{reservationId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"id\": \"db09af7d-c39b-47c4-8724-d693c41e7715\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"TEST\",\n \"reference\": \"1234\",\n \"amount\": 525,\n \"requestedBy\": \"Brennan_Rice@hotmail.com\",\n \"status\": \"CANCELLED\"\n}" + } + ] + }, + { + "name": "List Reservations", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations?page=1&pageSize=20&status=RESERVED", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + }, + { + "key": "status", + "value": "RESERVED" + } + ] + }, + "description": "### Endpoint Summary\n\nThis endpoint retrieves a list of reservations under a specific allocation in a VTEX budget, optionally filtered by status.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations?page=1&pageSize=20&status=RESERVED`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | No | Page number of the paginated result. |\n| `pageSize` | `integer` | No | Number of reservations per page. |\n| `status` | `string` | No | Filter by reservation status (e.g., `RESERVED`, `CONFIRMED`, or `CANCELED`). |\n\n> ℹ️ This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"items\": [\n {\n \"id\": \"299a291e-65bf-4c4c-9209-bdaa6f620d07\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"type\": \"DEBIT\",\n \"amount\": -726,\n \"date\": \"2025-07-22 20:43:43\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ],\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\" \n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination information. |\n| └─ `current` | `number` | Current page number. |\n| └─ `pages` | `number` | Total number of pages available. |\n| └─ `results` | `number` | Total number of reservations available. |\n| `items` | `array of objects` | List of reservation objects. |\n| └─ `id` | `string` | Identifier of the reservation. |\n| └─ `budgetId` | `string` | Identifier of the associated budget. |\n| └─ `allocationId` | `string` | Identifier of the associated allocation. |\n| └─ `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| └─ `amount` | `number` | Amount reserved. |\n| └─ `date` | `string` | Reservation date (ISO format). |\n| └─ `contextType` | `string` | Context type. |\n| └─ `contextId` | `string` | Identification of the context type. |\n| `contextType` | `string` | Context type. |\n| `contextId` | `string` | Identification of the context type. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations?page=1&pageSize=20&status=RESERVED", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "reservations" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + }, + { + "key": "status", + "value": "RESERVED" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"items\": [\n {\n \"id\": \"299a291e-65bf-4c4c-9209-bdaa6f620d07\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"origin\": \"TEST\",\n \"reference\": \"1234\",\n \"amount\": 596,\n \"requestedBy\": \"Brandt83@hotmail.com\",\n \"status\": \"RESERVED\"\n }\n ]\n}" + } + ] + } + ], + "description": "Reservations are temporary holds on part of the available balance (budget or allocation) to ensure funds are committed before becoming a definitive transaction.\n\nWith these endpoints you can create and manage budget reservations." + }, + { + "name": "Statements", + "item": [ + { + "name": "Get Budget Statements", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/statements?page=1&pageSize=20", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "statements" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + } + ] + }, + "description": "Retrieves the list of transactions (statement) for a specific budget within the VTEX Budget API.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/statements?page=1&pageSize=20`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a body.\n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | No | Page number of the results. |\n| `pageSize` | `integer` | No | Number of items per page. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"019833db-27ad-7264-b104-dfed7c0fcbac\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ] \n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination infor |\n| `pagination.current` | `number` | Current page number. |\n| `pagination.pages` | `number` | Total number of pages available. |\n| `pagination.results` | `number` | Total number of results across all pages. |\n| `transactions[]` | `array of objects` | List of transaction entries. |\n| `transactions[].id` | `string` | ID of the transaction. |\n| `transactions[].budgetId` | `string` | Identifier of the budget. |\n| `transactions[].allocationId` | `string` | ID of the associated allocation. |\n| `transactions[].type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `transactions[].amount` | `number` | Amount involved in the transaction. |\n| `transactions[].date` | `string` | ISO timestamp when the transaction occurred. |\n| `transactions[].contextType` | `string` | Context type. |\n| `transactions[].contextId` | `string` | Identification of the context type. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/statements?page=1&pageSize=20", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "statements" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Allocation Statements", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets//{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/statements?page=1&pageSize=20", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "statements" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + } + ] + }, + "description": "Retrieves the list of transactions (statement) for a specific allocation within a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/statements?page=1&pageSize=20`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a body.\n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | No | Page number of the results. |\n| `pageSize` | `integer` | No | Number of items per page. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"019833db-27ad-7264-b104-dfed7c0fcbac\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ] \n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination infor |\n| `pagination.current` | `number` | Current page number. |\n| `pagination.pages` | `number` | Total number of pages available. |\n| `pagination.results` | `number` | Total number of results across all pages. |\n| `transactions[]` | `array of objects` | List of transaction entries. |\n| `transactions[].id` | `string` | ID of the transaction. |\n| `transactions[].budgetId` | `string` | Identifier of the budget. |\n| `transactions[].allocationId` | `string` | ID of the associated allocation. |\n| `transactions[].type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `transactions[].amount` | `number` | Amount involved in the transaction. |\n| `transactions[].date` | `string` | ISO timestamp when the transaction occurred. |\n| `transactions[].contextType` | `string` | Context type. |\n| `transactions[].contextId` | `string` | Identification of the context type. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/statements?page=1&pageSize=20", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "statements" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "pageSize", + "value": "20" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\"\n }\n ]\n}" + } + ] + } + ], + "description": "With these endpoints you can retrieve the transactions history for a given budget or allocation." + }, + { + "name": "Transactions", + "item": [ + { + "name": "Create Transaction", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"origin\": \"ecommerce\",\n \"reference\": \"093c891a-84a7-42cb-8a23-eb6dcf6607d4\",\n \"amount\": 50.0,\n \"requestedBy\": \"clara.dalle@email.com\",\n \"type\": \"DEBIT\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "transactions" + ] + }, + "description": "Creates a new transaction which subtracts funds from the specified budget allocation.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | ID of the budget to which the adjustment applies. |\n| `allocationId` | `string` | Yes | ID of the specific allocation being adjusted. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"ecommerce\",\n \"reference\": \"093c891a-84a7-42cb-8a23-eb6dcf6607d4\",\n \"amount\": 50.0,\n \"requestedBy\": \"clara.dalle@email.com\",\n \"type\": \"DEBIT\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | Describes the origin or reason for the adjustment. |\n| `reference` | `string` | No | Reference ID or note for tracking the adjustment. |\n| `amount` | `number` | Yes | Amount to adjust (positive or negative). |\n| `type` | `string` | Yes | Condition that defines how the transaction will impact the budget (e.g., `DEBIT` or `CREDIT`). If `type` is `DEBIT`, the amount will be subtracted from the budget. If `type` is `CREDIT`, the amount will be added to the budget. |\n| `requestedBy` | `string` | Yes | Email of the user requesting the change. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"880e8400-e29b-41d4-a716-446655440000\",\n \"budgetId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"allocationId\": \"660e8400-e29b-41d4-a716-446655440000\",\n \"origin\": \"ecommerce\",\n \"reference\": \"093c891a-84a7-42cb-8a23-eb6dcf6607d4\",\n \"amount\": 50.0,\n \"requestedBy\": \"clara.dalle@email.com\",\n \"date\": \"2025-01-20T10:15:00Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the created transaction. |\n| `budgetId` | `string` | ID of the associated budget. |\n| `allocationId` | `string` | ID of the allocation within the budget. |\n| `origin` | `string` | Source system or origin of the transaction. |\n| `reference` | `string` | Reference identifier tied to the transaction. |\n| `amount` | `number` | Amount committed in the transaction. |\n| `requestedBy` | `string` | Email of the user who created the transaction. |\n| `date` | `string` | Date and time of the transaction (ISO format). |\n| `type` | `string` | Condition that defines how the transaction will impact the budget (e.g., `DEBIT` or `CREDIT`). If `type` is `DEBIT`, the amount will be subtracted from the budget. If `type` is `CREDIT`, the amount will be added to the budget. |\n| `contextType` | `string` | Type of context (e.g., `PROMOTIONS`, `UNIT`, `USER`). |\n| `contextId` | `string` | Identifier for the context type. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"origin\": \"{{origin}}\",\n \"reference\": \"{{reference}}\",\n \"amount\": {{amount}},\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}/transactions", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "transactions" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"id\": \"880e8400-e29b-41d4-a716-446655440000\",\n \"budgetId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"allocationId\": \"660e8400-e29b-41d4-a716-446655440000\",\n \"origin\": \"ecommerce\",\n \"reference\": \"order-123\",\n \"amount\": -50,\n \"requestedBy\": \"api-user\",\n \"date\": \"2024-01-20T10:15:00Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"unit123\"\n}" + } + ] + }, + { + "name": "Refund Transaction", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}/refund", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "transactions", + "{{transactionId}}", + "refund" + ] + }, + "description": "Refunds a specific transaction from a budget allocation by creating a new **`CREDIT`** statement item, which adds funds back to the specified budget allocation.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}/refund`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | ID of the budget to which the adjustment applies. |\n| `allocationId` | `string` | Yes | ID of the specific allocation being adjusted. |\n| `transactionId` | `string` | Yes | ID of the transaction being refunded. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"requestedBy\": \"{{requestedBy}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `requestedBy` | `string` | Yes | The email of the user initiating the refund. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"originalTransactionId\": \"b343e863-f558-4b53-b250-0ad819f06642\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the newly created refund transaction. |\n| `originalTransactionId` | `string` | The ID of the original transaction being refunded. |\n| `budgetId` | `string` | The ID of the associated budget. |\n| `allocationId` | `string` | The ID of the associated allocation within the budget. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}/refund", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "transactions", + "{{transactionId}}", + "refund" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"originalTransactionId\": \"b343e863-f558-4b53-b250-0ad819f06642\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\"\n}" + } + ] + }, + { + "name": "Get Transaction", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{context_type}}", + "{{context_id}}", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "transactions", + "{{transactionId}}" + ] + }, + "description": "### Endpoint Summary\n\nRetrieves a specific transaction from a budget allocation in the VTEX Budget API.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Budget ID related to the given transaction. |\n| `allocationId` | `string` | Yes | Allocation ID related to the given transaction. |\n| `transactionId` | `string` | Yes | ID of the desired transaction. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"f0e2b16b-ad4c-485d-adb2-84c78d9354e7\",\n \"amount\": 480,\n \"requestedBy\": \"Declan.McKenzie85@gmail.com\",\n \"date\": \"2025-07-22T20:41:49.8362594Z\",\n \"type\": \"CREDIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the transaction. |\n| `budgetId` | `string` | The ID of the associated budget. |\n| `allocationId` | `string` | The ID of the associated allocation within the budget. |\n| `origin` | `string` | The origin or source of the transaction. |\n| `reference` | `string` | A reference ID tied to the transaction (e.g., order ID). |\n| `amount` | `number` | The amount involved in the transaction. |\n| `requestedBy` | `string` | The email of the user who requested the transaction. |\n| `date` | `string` | Transaction date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (e.g., `PROMOTIONS`, `UNIT`, `USER`). |\n| `contextId` | `string` | Identifier of the corresponding context type. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "budgets", + "{{budgetId}}", + "allocations", + "{{allocationId}}", + "transactions", + "{{transactionId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"TEST\",\n \"reference\": \"f0e2b16b-ad4c-485d-adb2-84c78d9354e7\",\n \"amount\": 480,\n \"requestedBy\": \"Declan.McKenzie85@gmail.com\"\n}" + } + ] + } + ], + "description": "With these endpoints you can create and manage budget transactions." + } + ], + "description": "A budget is a financial management tool that enables organizations to plan and monitor expenses, ensuring resources are allocated efficiently and in compliance with strategic criteria.\n\nThe Budget API is a comprehensive budget management service that allows you to create, manage, and control budgets, allocations, transactions, and reservations.\n\nThis endpoints' collection manages the expenses of your store, promoting finantial transparency, traceability, and control." + }, + { + "name": "Custom Fields", + "item": [ + { + "name": "Settings (Legacy)", + "item": [ + { + "name": "Create Custom Field Settings (Legacy)", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"id\": \"{{contractId}}\",\r\n \"customFields\": [\r\n {\r\n \"name\": \"{{customFieldName}}\",\r\n \"enabled\": true,\r\n \"required\": true,\r\n \"level\": \"{{level}}\", // order | item | address\r\n \"type\": \"option\" // only support \"option\" for now\r\n }\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents" + ] + }, + "description": "Creates a document containing custom fields' settings for a given contract. You can set up multiple custom fields by sending multiple objects in the `customFields` array.\n\nThere are four types of custom fields currently accepted. For each of them that you wish to configure, you must send the exact `name` from the list below:\n\n- `PO Number`\n \n- `Cost Center`\n \n- `Release`\n \n- `Location`\n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"id\": \"{{contractId}}\",\n \"customFields\": [\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\",\n \"type\": \"option\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | The ID of the contract. |\n| `customFields` | `array of objects` | Yes | An array of custom field settings. |\n| `customFields[].name` | `string` | Yes | The name of the custom field. Currently, the accepted values are: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `customFields[].enabled` | `boolean` | Yes | Indicates if the custom field is enabled. |\n| `customFields[].required` | `boolean` | Yes | Indicates if the custom field is required. |\n| `customFields[].level` | `string` | Yes | The level at which the custom field applies (`order`, `item`, `address`). |\n| `customFields[].type` | `string` | Yes | The field type. Although `option`, `number`, and `text` are supported in theory, currently **only** `option` **is accepted**. |\n\n**Note**:\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"DocumentId\": \"c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created document. |\n| `Href` | `string` | Direct URL to access the created document. |\n| `DocumentId` | `string` | The document ID without the data entity prefix. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"id\": \"{{contractBusinessKlubPortalId}}\",\r\n \"customFields\": [\r\n {\r\n \"name\": \"PO Number\",\r\n \"enabled\": true,\r\n \"required\": true,\r\n \"level\": \"order\",\r\n \"type\": \"option\"\r\n }\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFields/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFields", + "documents" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "222" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:38:33 GMT" + }, + { + "key": "x-vtex-took", + "value": "165" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"DocumentId\": \"c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}" + } + ] + }, + { + "name": "Get Custom Field Settings (Legacy)", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + }, + "description": "Retrieves the settings of a given custom field.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n``` json\n{\n \"id\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFields\": [\n {\n \"id\": \"{{customFieldId}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"order|item|address\",\n \"type\": \"option\"\n }\n ],\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"tags\": [],\n \"dataInstanceId\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the custom field settings document. |\n| `dataEntityId` | `string` | The ID of the data entity. |\n| `accountId` | `string` | The ID of the VTEX account. |\n| `accountName` | `string` | The name of the VTEX account. |\n| `followers` | `array` | An array of followers. |\n| `schemas` | `array` | An array of schemas. |\n| `customFields` | `array of objects` | An array of custom field settings. |\n| `customFields[].name` | `string` | The name of the custom field. Currently, the accepted values are: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `customFields[].enabled` | `boolean` | Indicates if the custom field is enabled. |\n| `customFields[].required` | `boolean` | Indicates if the custom field is required. |\n| `customFields[].level` | `string` | The level at which the custom field applies (`order`, `item`, `address`). |\n| `customFields[].type` | `string` | Yes |\n| `createdBy` | `string` | The ID of the user who created the document. |\n| `createdBy_USER` | `object` | Information about the user who created the document. |\n| `createdIn` | `string` | Timestamp of when the document was created. |\n| `lastInteractionBy` | `string` | The ID of the user who last interacted with the document. |\n| `lastInteractionBy_USER` | `object` | Information about the user who last interacted with the document. |\n| `lastInteractionIn` | `string` | Timestamp of the last interaction with the document. |\n| `tags` | `array` | An array of tags. |\n| `dataInstanceId` | `string` | The ID of the data instance. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "814" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:22:00 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.052" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "trace-id", + "value": "00-bb16bf72e685ad9bc17b7a92ffefc376-e1badf7cbb89e9fc-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"76bf42f57385ebf6be7c3e74558c0cab\"" + }, + { + "key": "x-vtex-took", + "value": "46" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-21-30" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.052" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b292206350dba522c123bef9b189a056.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "kUvu6vUrE4wgNEILr0LM-8AGwQLZOQz2n4PN5-zoiOgPakZao5N8qA==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFields\": {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"order|item|address\",\n \"type\": \"text|number|option\"\n },\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"tags\": [],\n \"dataInstanceId\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\"\n}" + } + ] + }, + { + "name": "Delete Custom Field Settings (Legacy)", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ] + }, + "description": "Deletes all custom fields settings associated with a given contract.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The document was successfully deleted. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFields/documents/{{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFields", + "documents", + "{{contractId}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "222" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:38:33 GMT" + }, + { + "key": "x-vtex-took", + "value": "165" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Update Custom Field Settings (Legacy)", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\":\"{{contractId}}\",\n \"customFields\":[\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\", // order | item | address\n \"type\": \"option\" // only support \"option\" for now\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ] + }, + "description": "Updates the configuration of all custom fields for a specific contract in the VTEX Data Entity. This includes enabling/disabling a custom field, marking it as required, and defining its scope and type.\n\nThe entire list of custom field settings must be provided in the PATCH request — partial updates are not supported. Because of this, to update custom field settings, we recommend the following steps:\n\n1. Use the Get Custom Field Settings request described above to get the current settings.\n \n2. Copy the settings array and change the values you wish to update.\n \n3. Send this request with the complete updated settings.\n \n\n---\n\n### **Request**\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### **Request Body**\n\n``` json\n{\n \"id\": \"{{contractId}}\",\n \"customFields\": [\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\",\n \"type\": \"option\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | The ID of the profile (contract) to update. |\n| `customFields` | `array of objects` | Yes | List of custom field configuration objects. |\n| `customFields[].name` | `string` | Yes | The unique identifier (name) of the custom field. |\n| `customFields[].enabled` | `boolean` | Yes | Whether this custom field is active. |\n| `customFields[].required` | `boolean` | Yes | Whether this custom field must be filled. |\n| `customFields[].level` | `string` | Yes | The scope where the custom field is applied. One of: `order`, `item`, `address`. |\n| `customFields[].type` | `string` | Yes | The field type. Although `text`, `number`, and `option` are supported in theory, currently **only** `option` **is accepted**. |\n\n_Important Notes_:\n\n- Partial updates are not supported. You must submit the full list of custom field settings in every request.\n \n- The `type` field accepts only `option` for now, even if other values are theoretically supported.\n \n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created document. |\n| `Href` | `string` | Direct URL to access the created document. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\":\"{{contractId}}\",\n \"customFields\":[\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\", // order | item | address\n \"type\": \"option\" // only support \"option\" for now\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ] + } + }, + "status": "Success", + "code": 200, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": "{\r\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\r\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\"\r\n}" + } + ] + } + ] + }, + { + "name": "Settings v2", + "item": [ + { + "name": "Create Custom Field Settings v2", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"Id\": \"customFieldSettings-89f1da93-6917-4cbf-894e-1f1399682826c\",\r\n \"Href\": \"http://accountName.myvtex.com/api/dataentities/customFieldSettings/documents/89f1da93-6917-4cbf-894e-1f1399682826c?_schema=v2\",\r\n \"DocumentId\": \"89f1da93-6917-4cbf-894e-1f1399682826c\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Create and configure `customFields` for a specific contract.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents?_schema=v2`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `contractId` | string | Yes | The contract ID to which the custom field belongs. |\n| `name` | string | Yes | The custom field name. Accepted values: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `enabled` | boolean | Yes | Indicates whether the custom field is enabled (`true`) or not (`false`). |\n| `required` | boolean | Yes | Indicates whether the custom field is mandatory (`true`) or optional (`false`). |\n| `level` | string | Yes | The level at which the custom field applies. Possible values: `item`, `order`, `address`. |\n| `type` | string | Yes | The value type of the custom field. Possible values: `text`, `number`, `option`. |\n| `additionalData` | string | No | Extra data associated with the custom field . |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-89f1da93-6917-4cbf-894e-1f1399682826c\",\n \"Href\": \"http://accountName.myvtex.com/api/dataentities/customFieldSettings/documents/89f1da93-6917-4cbf-894e-1f1399682826c?_schema=v2\",\n \"DocumentId\": \"89f1da93-6917-4cbf-894e-1f1399682826c\"\n}\n\n ```\n\n| Field | Type | Description |\n| ------------ | ------ | ------------------------------------------------ |\n| `Id` | string | Auto-generated GUID for the custom field. |\n| `Href` | string | Direct URL to the created custom field document. |\n| `DocumentId` | string | Identifier of the custom field document. |\n" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{ \r\n\"contractId\": \"{{contractId}}\", \r\n\"name\": \"{{customFieldName}}\", \r\n\"enabled\": true, \r\n\"required\": false, \r\n\"level\": \"{{level}}\", \r\n\"type\": \"option\", \r\n\"additionalData\": \"{{additionalData}}\" \r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFields/documents?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFields", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "222" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:38:33 GMT" + }, + { + "key": "x-vtex-took", + "value": "165" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"customFieldSettings-89f1da93-6917-4cbf-894e-1f1399682826c\",\n \"Href\": \"http://accountName.myvtex.com/api/dataentities/customFieldSettings/documents/89f1da93-6917-4cbf-894e-1f1399682826c?_schema=v2\",\n \"DocumentId\": \"89f1da93-6917-4cbf-894e-1f1399682826c\"\n}" + } + ] + }, + { + "name": "Get Custom Field Settings v2", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/search/?_fields=_all&_where=contractId={{contractId}}&_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "search", + "" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_where", + "value": "contractId={{contractId}}" + }, + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Retrieves the settings of a given custom field.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accoountName}}.myvtex.com/api/dataentities/customFieldSettings/search/?_fields=_all&_where=contractId={{contractId}}&_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n``` json\n[\n {\n \"id\": \"34575ee8-80c1-458d-b75a-7492b36513e3\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"PO Number\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:32:08.6879184Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:32:08.6879204Z\",\n \"tags\": [],\n \"dataInstanceId\": \"34575ee8-80c1-458d-b75a-7492b36513e3\"\n },\n {\n \"id\": \"8b696650-bc80-40d8-807e-32d46b018863\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"Address\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:35:57.1214314Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:35:57.1214335Z\",\n \"tags\": [],\n \"dataInstanceId\": \"8b696650-bc80-40d8-807e-32d46b018863\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier of the custom field instance. |\n| dataEntityId | string | Identifier of the data entity to which the field belongs. |\n| accountId | string | Identifier of the account associated with the field. |\n| accountName | string | Name of the account associated with the field. |\n| followers | array | List of users following this field (usually empty). |\n| schemas | array | List of applicable schema versions for this field. |\n| contractId | string | Identifier of the contract associated with the field. |\n| name | string | Name of the custom field. |\n| enabled | boolean | Indicates whether the field is enabled. |\n| required | boolean | Indicates whether the field is mandatory. |\n| level | string | Level at which the field is applied (e.g., `item`). |\n| type | string | Type of the field (e.g., `option`). |\n| additionalData | string | Additional field for extra information. |\n| createdBy | string | ID of the user who created the field. |\n| createdBy_USER | object | Details of the user who created the field: Id, Login, Name. |\n| createdIn | string (ISO 8601 datetime) | Date and time when the field was created. |\n| lastInteractionBy | string | ID of the user who last interacted with the field. |\n| lastInteractionBy_USER | object | Details of the user who last interacted: Id, Login, Name. |\n| lastInteractionIn | string (ISO 8601 datetime) | Date and time of the last interaction with the field. |\n| tags | array | List of tags associated with the field (usually empty). |\n| dataInstanceId | string | Identifier of the data instance (usually equal to `id`). |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all&_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "814" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:22:00 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.052" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "trace-id", + "value": "00-bb16bf72e685ad9bc17b7a92ffefc376-e1badf7cbb89e9fc-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"76bf42f57385ebf6be7c3e74558c0cab\"" + }, + { + "key": "x-vtex-took", + "value": "46" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-21-30" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.052" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 b292206350dba522c123bef9b189a056.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "kUvu6vUrE4wgNEILr0LM-8AGwQLZOQz2n4PN5-zoiOgPakZao5N8qA==" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"34575ee8-80c1-458d-b75a-7492b36513e3\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"PO Number\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:32:08.6879184Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:32:08.6879204Z\",\n \"tags\": [],\n \"dataInstanceId\": \"34575ee8-80c1-458d-b75a-7492b36513e3\"\n },\n {\n \"id\": \"8b696650-bc80-40d8-807e-32d46b018863\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"Address\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:35:57.1214314Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:35:57.1214335Z\",\n \"tags\": [],\n \"dataInstanceId\": \"8b696650-bc80-40d8-807e-32d46b018863\"\n }\n]\n" + } + ] + }, + { + "name": "Delete Custom Field Settings v2", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Deletes all custom fields settings associated with a given contract.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The document was successfully deleted. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFields/documents/{{contractId}}?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFields", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "222" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:38:33 GMT" + }, + { + "key": "x-vtex-took", + "value": "165" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Update Custom Field Settings v2", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "This endpoint allows you to enable or disable a custom field, mark it as required, define the level (`item`, `order`or `address`), and set its type (`text`, `number` or `option`). \nYou can also provide optional `additionalData` for custom validations, allowed values, or integration rules. \nEach request handles a single `customField` configuration. The field is identified by the system through its auto-generated id, while the `contractId` defines the contract to which it belongs.\n\n---\n\n### **Request**\n\n- **Method**: `PATCH`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### **Request Body**\n\n``` json\n{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `contractId` | string | Yes | The contract ID to which the custom field belongs. |\n| `name` | string | Yes | The custom field name. Accepted values: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `enabled` | boolean | Yes | Indicates whether the custom field is enabled (`true`) or not (`false`). |\n| `required` | boolean | Yes | Indicates whether the custom field is mandatory (`true`) or optional (`false`). |\n| `level` | string | Yes | The level at which the custom field applies. Possible values: `item`, `order`, `address`. |\n| `type` | string | Yes | The value type of the custom field. Possible values: `text`, `number`, `option`. |\n| `additionalData` | string | No | Extra data associated with the custom field . |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 No Content`" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "dataentities", + "customFieldSettings", + "documents", + "{{contractId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "" + } + ] + } + ] + }, + { + "name": "Values Management (Legacy)", + "item": [ + { + "name": "Populate Custom Field Value (Legacy)", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"{{customFieldName}}\",\r\n \"contractId\": \"{{contractId}}\",\r\n \"auxId\": null, // the address id for \"address\" custom fields\r\n \"value\": \"{{value}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents?_schema=v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + } + ] + }, + "description": "Creates a value for an existing custom field for a given contract.\n\n> If you are creating a value for a custom field configured with level `address`, you must send a valid address ID in the field `auxId`. \n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"name\": \"{{customFieldName}}\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | The name of the custom field. Currently, the accepted values are: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `contractId` | `string` | Yes | The ID of the contract associated with the field. |\n| `auxId` | `null` | No | Address ID. Required only if the configured custom field level is `address`. |\n| `value` | `string` | Yes | The value to be stored for the custom field. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created value. |\n| `Href` | `string` | Direct URL to access the value document created. |\n| `DocumentId` | `string` | The value ID without the data entity prefix. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"contractId\": \"{{contractId}}\",\r\n \"customFieldId\": \"{{customFieldId}}\",\r\n \"auxId\": null,\r\n \"value\": \"{{value}}\",\r\n \"description\": \"{{customField description}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFields/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFields", + "documents" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "222" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:47:22 GMT" + }, + { + "key": "x-vtex-took", + "value": "80" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 efc74c02ba53691bc09b84df59c7ac50.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "O_JjJfGs7w1KbuRxSeLdeKb-FIJv7NOTW6plMt9tYy9w-LkF3m_mNQ==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}" + } + ] + }, + { + "name": "Update Custom Field Value (Legacy)", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"value\":\"CC3\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ] + }, + "description": "Updates the value of a custom field for a given contract.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"value\": \"CC3\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `value` | `string` | Yes | The new value for the custom field. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully updated. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"value\":\"CC3\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": null + } + ] + }, + { + "name": "Get Custom Field Value (Legacy)", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v1" + } + ] + }, + "description": "Retrieves a specific custom field value document.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not contain a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"name\": \"PO Number\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the document. |\n| `dataEntityId` | `string` | The ID of the data entity. |\n| `accountId` | `string` | The ID of the account. |\n| `accountName` | `string` | The name of the VTEX account. |\n| `followers` | `array` | An array of followers. |\n| `schemas` | `array` | An array of schemas. |\n| `name` | `string` | The name of the document (custom field name). |\n| `contractId` | `string` | The ID of the contract. |\n| `auxId` | `string` | Address ID. Used only for custom fields configured with level `address`. |\n| `value` | `string` | The value of the custom field. |\n| `createdBy` | `string` | The ID of the user who created the document. |\n| `createdBy_USER` | `object` | Information about the creator (Id, Login, Name). |\n| `createdIn` | `string` | The timestamp of document creation. |\n| `lastInteractionBy` | `string` | The ID of the last user who interacted with the document. |\n| `lastInteractionBy_USER` | `object` | Information about the last interacting user (Id, Login, Name). |\n| `lastInteractionIn` | `string` | The timestamp of the last interaction. |\n| `tags` | `array` | An array of tags. |\n| `dataInstanceId` | `string` | The ID of the data instance. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "764" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:25:04 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.008" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "trace-id", + "value": "00-2a77c957a08926be0d80c7dd18d6ef85-3e6e8b4097808615-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"ed96eb09817a2a9f8c2e3a34547dd2be\"" + }, + { + "key": "x-vtex-took", + "value": "3" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-36-99" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.009" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "J3DmVzqKQfb6E282p4j9AlMlC2be4NAba3avyByi-lrotD4NwNMTSA==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"name\": \"PO Number\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}" + } + ] + }, + { + "name": "Delete Custom Field Value (Legacy)", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v1" + } + ] + }, + "description": "Deletes a specific custom field value.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully deleted. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "plain", + "header": [ + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:25:53 GMT" + }, + { + "key": "x-vtex-took", + "value": "103" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "trace-id", + "value": "00-bfc81a8ce737ec7f73a2a353c1289ff0-8b1e7fd071812569-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "JjCfTOGcmoM3a84X4_eiBHtIQ95VE-DTThihLJDSCf2bzAg0CWFWcw==" + } + ], + "cookie": [], + "body": null + } + ] + }, + { + "name": "Search Custom Field Specific Value (Legacy)", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%BA-" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"" + } + ] + }, + "description": "Retrieves custom field values, filtered by contract ID, field name, and field value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search`\n \n- **Query Parameters**:\n \n - `_schema=v1`\n \n - `_fields=id,contractId,name,auxId,value`\n \n - `_where=contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"name\": \"PO Number\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the custom field value document. |\n| `contractId` | `string` | The ID of the contract associated with the field. |\n| `name` | `string` | The name of the custom field. |\n| `auxId` | `string` | Address ID. Used only for custom fields configured with level `address`. |\n| `value` | `string` | The value stored in the custom field. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%3A-" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"name\": \"PO Number\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]" + } + ] + }, + { + "name": "Search All Custom Field Values (Legacy)", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%3A-" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\"&_sort%20=value= name ASC", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND name=\"{{customField}}\"" + }, + { + "key": "_sort%20", + "value": "value= name ASC" + } + ] + }, + "description": "Retrieves all custom field values, filtered by contract ID and custom field name, and returns them sorted by value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search`\n \n- **Query Parameters**:\n \n - `_schema=v1`\n \n - `_fields=id,contractId,name,auxId,value`\n \n - `_where=contractId={{contractId}} AND name=\"{{customField}}\"`\n \n - `_sort=value=name ASC`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"name\": \"PO Number\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the custom field value document. |\n| `contractId` | `string` | The ID of the contract associated with the field. |\n| `name` | `string` | The name of the custom field. |\n| `auxId` | `string` | Address ID. Used only for custom fields configured with level `address`. |\n| `value` | `string` | The value stored in the custom field. |" + }, + "response": [ + { + "name": "Search All Custom Field Values", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%3A-" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\"&_sort%20=value= name ASC", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND name=\"{{customField}}\"" + }, + { + "key": "_sort%20", + "value": "value= name ASC" + } + ] + } + }, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"name\": \"PO Number\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]" + } + ] + } + ], + "description": "Once you have set up a custom field, you can use the APIs below to manage their value for specific contracts.\n\nEvery custom field value is associated with a specific contract and may also be associated with a specific address, in case the defined custom field level is `address`. The address ID associated with the custom field value is represented in the field `auxId`." + }, + { + "name": "Values Management v2", + "item": [ + { + "name": "Populate Custom Field Value v2", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"contractId\": \"{{contractId}}\",\r\n \"customFieldId\": \"{{customFieldId}}\",\r\n \"auxId\": null,\r\n \"value\": \"{{value}}\",\r\n \"description\": \"{{customField description}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Creates a value for an existing custom field for a given contract.\n\n> If you are creating a value for a custom field configured with level `address`, you must send a valid address ID in the field `auxId`. \n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"contractId\": \"{{contractId}}\",\n \"customFieldId\": \"{{customFieldId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"{{customField description}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contractId` | `string` | Yes | The ID of the contract associated with the field. |\n| `customFieldId` | `string` | Yes | The ID of the custom field. Which is automatically generated in Create Custom Field Settings. |\n| `auxId` | `null` | No | Address ID. Required only if the configured custom field level is `address`. |\n| `value` | `string` | Yes | The value to be stored for the custom field. |\n| `description` | `string` | No | Details what the value represents. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created value. |\n| `Href` | `string` | Direct URL to access the value document created. |\n| `DocumentId` | `string` | The value ID without the data entity prefix. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"contractId\": \"{{contractId}}\",\r\n \"customFieldId\": \"{{customFieldId}}\",\r\n \"auxId\": null,\r\n \"value\": \"{{value}}\",\r\n \"description\": \"{{customField description}}\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFields/documents?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFields", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "222" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Mon, 24 Mar 2025 17:47:22 GMT" + }, + { + "key": "x-vtex-took", + "value": "80" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 efc74c02ba53691bc09b84df59c7ac50.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "O_JjJfGs7w1KbuRxSeLdeKb-FIJv7NOTW6plMt9tYy9w-LkF3m_mNQ==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}" + } + ] + }, + { + "name": "Update Custom Field Value v2", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"contractId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": \"optionalAuxId\",\n \"value\": \"CC3\",\n \"description\": \"Details about the value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Updates the value of a specific custom field for a given contract.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"contractId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": \"optionalAuxId\",\n \"value\": \"CC3\",\n \"description\": \"Details about the value\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `contractId` | string | Yes | The ID of the contract to which the custom field belongs. |\n| `customFieldId` | string | Yes | The ID of the custom field (from the customFieldSettings document). |\n| `auxId` | string (null) | No | Optional auxiliary ID to further specify the context. |\n| `value` | string | Yes | The new value for the custom field (max length 22). |\n| `description` | string | No | Optional description explaining what the value represents. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully updated. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": null, + "header": null, + "cookie": [], + "body": null + } + ] + }, + { + "name": "Get Custom Field Value v2", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Retrieves a specific custom field value document.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not contain a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Some details about the value\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | string | The ID of the custom field value document. |\n| `dataEntityId` | string | The ID of the data entity (`customFieldValues`). |\n| `accountId` | string | Unique identifier of the VTEX account. |\n| `accountName` | string | Name of the VTEX account. |\n| `followers` | array | Array of followers for this document. |\n| `schemas` | array | Array of schemas associated with this document. |\n| `customFieldId` | string | The ID of the custom field (from `customFieldSettings`). |\n| `contractId` | string | The ID of the contract to which this value belongs. |\n| `auxId` | string (null) | Optional auxiliary ID (e.g., address ID) used for fields with level `address`. |\n| `value` | string | The actual value of the custom field. |\n| `description` | string (null) | Optional description explaining what the value represents. |\n| `createdBy` | string | ID of the user who created the document. |\n| `createdBy_USER` | object | Metadata about the creator (Id, Login, Name). |\n| `createdIn` | string | Timestamp when the document was created. |\n| `lastInteractionBy` | string | ID of the last user who modified the document. |\n| `lastInteractionBy_USER` | object | Metadata about the last interacting user (Id, Login, Name). |\n| `lastInteractionIn` | string | Timestamp of the last modification. |\n| `tags` | array | Tags associated with the document. |\n| `dataInstanceId` | string | Unique identifier of the data instance. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "764" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:25:04 GMT" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.008" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-store, no-cache" + }, + { + "key": "trace-id", + "value": "00-2a77c957a08926be0d80c7dd18d6ef85-3e6e8b4097808615-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "If-None-Match", + "value": "\"ed96eb09817a2a9f8c2e3a34547dd2be\"" + }, + { + "key": "x-vtex-took", + "value": "3" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-36-99" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.009" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "J3DmVzqKQfb6E282p4j9AlMlC2be4NAba3avyByi-lrotD4NwNMTSA==" + } + ], + "cookie": [], + "body": "{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Some details about the value\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}" + } + ] + }, + { + "name": "Delete Custom Field Value v2", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v2" + } + ] + }, + "description": "Deletes a specific custom field value.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully deleted. No content is returned in the response body." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "documents", + "{{customFieldValueId}}" + ], + "query": [ + { + "key": "_fields", + "value": "_all" + }, + { + "key": "_schema", + "value": "v2" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "plain", + "header": [ + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Fri, 11 Apr 2025 18:25:53 GMT" + }, + { + "key": "x-vtex-took", + "value": "103" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "trace-id", + "value": "00-bfc81a8ce737ec7f73a2a353c1289ff0-8b1e7fd071812569-01" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "JjCfTOGcmoM3a84X4_eiBHtIQ95VE-DTThihLJDSCf2bzAg0CWFWcw==" + } + ], + "cookie": [], + "body": null + } + ] + }, + { + "name": "Search Custom Field Specific Value v2", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%BA-" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"" + } + ] + }, + "description": "Retrieves custom field values, filtered by contract ID, field name, and field value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"\n \n- **Query Parameters**:\n \n - `_schema=v2`\n \n - `_fields=id,contractId,customFieldId,auxId,value`\n \n - `_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"CC3\",\n \"description\": \"Optional description\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | string | The unique ID of the custom field value document. |\n| `contractId` | string | The ID of the contract associated with the custom field. |\n| `customFieldId` | string | The ID of the custom field (from `customFieldSettings`). |\n| `auxId` | string (null) | Optional auxiliary |\n| `value` | string | The value stored in the custom field. |\n| `description` | string (null) | Optional text describing what the value represents. |" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%3A-" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"CC3\",\n \"description\": \"Optional description\"\n }\n]" + } + ] + }, + { + "name": "Search All Custom Field Values", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%3A-" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id, contractId, customFieldId, auxId, value&_where=contractId={{contractId}}&_sort%20=value= ASC", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + }, + { + "key": "_fields", + "value": "id, contractId, customFieldId, auxId, value" + }, + { + "key": "_where", + "value": "contractId={{contractId}}" + }, + { + "key": "_sort%20", + "value": "value= ASC" + } + ] + }, + "description": "Retrieves all custom field values, filtered by contract ID and custom field name, and returns them sorted by value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search?_schema=v2&_fields=id, contractId, customFieldId, auxId, value&_where=contractId={{contractId}}&_sort =value= ASC\n \n- **Query Parameters**:\n \n - `_schema=v2`\n \n - `_fields=id,contractId,customFieldId,auxId,value`\n \n - `_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\"`\n \n - `_sort=value=ASC`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Optional description\"\n },\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1564b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789audldef\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Optional description\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | string | The unique ID of the custom field value document. |\n| `contractId` | string | The ID of the contract associated with the custom field. |\n| `customFieldId` | string | The ID of the custom field (from `customFieldSettings`). |\n| `auxId` | string (null) | Optional auxiliary ID, e.g., address ID for fields with level `address`. |\n| `value` | string | The value stored in the custom field. |\n| `description` | string (null) | Optional text describing what the value represents. |" + }, + "response": [ + { + "name": "Search All Custom Field Values", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" + }, + { + "key": "Cookie", + "value": "VtexWorkspace=master%3A-" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\"&_sort%20=value= name ASC", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "customFieldValues", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v2" + }, + { + "key": "_fields", + "value": "id,contractId,name,auxId,value" + }, + { + "key": "_where", + "value": "contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\"" + }, + { + "key": "_sort%20", + "value": "value= name ASC" + } + ] + } + }, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Optional description\"\n }\n]" + } + ] + } + ], + "description": "Once you have set up a custom field, you can use the APIs below to manage their value for specific contracts.\n\nEvery custom field value is associated with a specific contract and may also be associated with a specific address, in case the defined custom field level is `address`. The address ID associated with the custom field value is represented in the field `auxId`." + }, + { + "name": "orderForm management", + "item": [ + { + "name": "Create or update custom field in orderForm", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\":\"Cost Center\",\r\n \"value\":\"CC3\",\r\n \"refId\":\"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "checkout", + "pub", + "orderForm", + "{{orderFormId}}", + "customFields", + "{{linkedEntity.type}}", + "{{linkedEntity.id}}" + ] + }, + "description": "### Request\n\n- **Method**: `PUT`\n \n- **URL**: `{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nCreates or updates a custom field in the orderForm.\n\n#### Path Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| orderFormId | integer | true | Unique identifier for a customer's shopping cart. |\n| linkedEntity.type | string | true | Data entity type, which can be one of the following: `order` `item` `address`. |\n| linkedEntity.id | string | false | Unique identifier of the entity value being included in the orderForm. Required only for `item` and `address` entity types, not for `order`. |\n\n### Request Body\n\n``` json\n{\n\"name\":\"Cost Center\",\n\"value\":\"CC3\",\n\"refId\":\"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| name | string | true | Custom field name. |\n| value | string | true | Custom field value, limited to 50 characters. |\n| refId | string | false | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: The response will be the orderForm updated.\n \n\n``` json\n{\n \"customData\":{\n ...,\n \"customFields\":[\n {\n \"linkedEntity\":{\n \"type\":\"item\",\n \"id\":\"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\":[\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n ]\n },\n ...\n}\n\n ```\n\n| Field | Type | Nullable | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | false | Data entity information. |\n| linkedEntity{ }.type | string | false | Data entity type, which can be one of the following: `order` `item` `address`. |\n| linkedEntity{ }.id | string | true | Data entity ID. This field is nullable when the entity type is `order`. |\n| fields\\[ \\] | array of objects | false | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | false | Custom field name. |\n| fields\\[ \\]{ }.value | string | false | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |" + }, + "response": [] + }, + { + "name": "Create or update custom fields in orderForm in batch", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\r\n {\r\n \"linkedEntity\": {\r\n \"type\": \"order\"\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"PO Number\",\r\n \"value\": \"PO1\",\r\n \"refId\": \"88c4c1e6-1db4-4a13-aa96-e79daba7772d\"\r\n }\r\n ]\r\n },\r\n {\r\n \"linkedEntity\": {\r\n \"type\": \"address\",\r\n \"id\": \"FCDEC51EDF2B4BBFA7E899CD4CA5333C\"\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Location\",\r\n \"value\": \"DSK1\",\r\n \"refId\": \"ff84f2fd-9fe1-48a0-aab2-1e0988e3e889\"\r\n }\r\n ]\r\n },\r\n {\r\n \"linkedEntity\": {\r\n \"type\": \"item\",\r\n \"id\": \"B2949D0A45244825B177D2F9F96DC711\"\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Cost Center\",\r\n \"value\": \"CC3\",\r\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\r\n }\r\n ]\r\n }\r\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "checkout", + "pub", + "orderForm", + "{{orderFormId}}", + "customFields" + ] + }, + "description": "### Request\n\n- **Method**: `PUT`\n \n- **URL**: `{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nCreates or updates custom fields in the orderForm in batch.\n\n#### Path Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| orderFormId | integer | true | Unique identifier for a customer's shopping cart. |\n\n### Request Body\n\n``` json\n[\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"88c4c1e6-1db4-4a13-aa96-e79daba7772d\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"FCDEC51EDF2B4BBFA7E899CD4CA5333C\"\n },\n \"fields\": [\n {\n \"name\": \"Location\",\n \"value\": \"DSK1\",\n \"refId\": \"ff84f2fd-9fe1-48a0-aab2-1e0988e3e889\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\": [\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n]\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | true | Data entity information. |\n| linkedEntity{ }.type | string | true | Data entity type. |\n| linkedEntity{ }.id | string | false | Data entity ID. It is required when the entity type is `address`, but can be omitted for `item` and `order`, because the system considers the current values in the orderForm. |\n| fields\\[ \\] | array of objects | true | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | true | Custom field name. |\n| fields\\[ \\]{ }.value | string | true | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: The response will be the orderForm updated.\n \n\n``` json\n{\n \"customData\":{\n ...,\n \"customFields\":[\n {\n \"linkedEntity\":{\n \"type\":\"item\",\n \"id\":\"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\":[\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n ]\n },\n ...\n}\n\n ```\n\n| Field | Type | Nullable | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | false | Data entity information. |\n| linkedEntity{ }.type | string | false | Data entity type, which can be one of the following: `order` `item` `address` |\n| linkedEntity{ }.id | string | true | Data entity ID. This field is nullable when the entity type is `order`. |\n| fields\\[ \\] | array of objects | false | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | false | Custom field name. |\n| fields\\[ \\]{ }.value | string | false | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |" + }, + "response": [] + }, + { + "name": "Delete custom field in orderForm", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}//api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}/{{fieldName}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "", + "api", + "checkout", + "pub", + "orderForm", + "{{orderFormId}}", + "customFields", + "{{linkedEntity.type}}", + "{{linkedEntity.id}}", + "{{fieldName}}" + ] + }, + "description": "## Request\n\n- **Method**: `DELETE`\n \n- **URL**: `{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}/{fieldName}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nRemoves a field from a custom field in an orderForm given a field name.\n\nThis endpoint doesn’t require a request body.\n\n### Path Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| orderFormId | integer | true | Unique identifier for a customer's shopping cart. |\n| linkedEntity.type | string | true | Data entity type, which can be one of the following: `order` `item` `address`. |\n| linkedEntity.id | string | false | Unique identifier of the entity value being included in the orderForm. Required only for `item` and `address` entity types, not for `order`. |\n| fieldName | string | true | Custom field name. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: The response will be the orderForm updated.\n \n\n``` json\n{\n \"customData\":{\n ...,\n \"customFields\":[\n {\n \"linkedEntity\":{\n \"type\":\"item\",\n \"id\":\"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\":[\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n ]\n },\n ...\n}\n\n ```\n\n| Field | Type | Nullable | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | false | Data entity information. |\n| linkedEntity{ }.type | string | false | Data entity type, which can be one of the following: `order` `item` `address` |\n| linkedEntity{ }.id | string | true | Data entity ID. This field is nullable when the entity type is `order`. |\n| fields\\[ \\] | array of objects | false | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | false | Custom field name. |\n| fields\\[ \\]{ }.value | string | false | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |" + }, + "response": [] + } + ] + } + ], + "description": "You can configure custom fields to collect additional data during checkout, improving order tracking and compliance." + }, + { + "name": "Default Values", + "item": [ + { + "name": "Create Default Values", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"id\":\"orgUnitId-{{unitId}}\",\r\n \"defaultValues\":[\r\n {\r\n \"entity\":\"address/shipping\",\r\n \"entityValueId\":\"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"address/billing\",\r\n \"entityValueId\":\"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"creditCard\",\r\n \"entityValueId\":\"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\r\n }\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "defaultValues", + "documents" + ] + }, + "description": "Creates a document with a set of default values for a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"id\": \"orgUnitId-{{unit-id}}\",\n \"defaultValues\": [\n {\n \"entity\": \"address/shipping\",\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"address/billing\",\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"creditCard\",\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | ID of the organizational Unit prefixed with `orgUnitId-`. |\n| `defaultValues` | `array` | Yes | An array of default value objects. |\n| `defaultValues[].entity` | `string` | Yes | The name of the entity (e.g., `address/shipping`, `creditCard`). |\n| `defaultValues[].entityValueId` | `string` | Yes | The ID of the entity value associated to the entity. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"DocumentId\": \"c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created document. |\n| `Href` | `string` | Direct link to the created document. |\n| `DocumentId` | `string` | The document ID (same value as in `Id` without prefix). |" + }, + "response": [] + }, + { + "name": "Get Default Values", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}?_schema=v1&_fields=id,defaultValues", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "defaultValues", + "documents", + "orgUnitId-{{unitId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_fields", + "value": "id,defaultValues" + } + ] + }, + "description": "Retrieves the default values for a specific organization unit in the VTEX Data Entity by making a GET request.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents/orgUnitId-{{unit}}?_schema=v1&_fields=id,defaultValues`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n```json\n{\n \"id\": \"a6d958c2-25ba-4f4d-9a0a-6b56e458426c\",\n \"defaultValues\": [\n {\n \"entity\": \"address/shipping\",\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"address/billing\",\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"creditCard\",\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\n }\n ]\n}\n\n ```" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}?_schema=v1&_fields=id,defaultValues", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "defaultValues", + "documents", + "orgUnitId-{{unitId}}" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_fields", + "value": "id,defaultValues" + } + ] + } + }, + "_postman_previewlanguage": "", + "header": [], + "cookie": [ + { + "expires": "Invalid Date" + } + ], + "body": "{\r\n \"id\": \"a6d958c2-25ba-4f4d-9a0a-6b56e458426c\",\r\n \"defaultValues\": [\r\n {\r\n \"entity\": \"address/shipping\",\r\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\": \"address/billing\",\r\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\": \"creditCard\",\r\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\r\n }\r\n ]\r\n}" + } + ] + }, + { + "name": "Update Default Values", + "request": { + "method": "PATCH", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"id\":\"orgUnitId-{{unit}}\",\r\n \"defaultValues\":[\r\n {\r\n \"entity\":\"address/shipping\",\r\n \"entityValueId\":\"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"address/billing\",\r\n \"entityValueId\":\"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"creditCard\",\r\n \"entityValueId\":\"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\r\n }\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "defaultValues", + "documents", + "orgUnitId-{{unitId}}" + ] + }, + "description": "Updates the default values for a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents/orgUnitId-{{unit}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"id\": \"orgUnitId-{{unit}}\",\n \"defaultValues\": [\n {\n \"entity\": \"address/shipping\",\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"address/billing\",\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"creditCard\",\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | ID of the organizational Unit prefixed with `orgUnitId-`. |\n| `defaultValues` | `array` | Yes | A list of default value entries. |\n| `defaultValues[].entity` | `string` | Yes | The name of the entity (e.g., `address/shipping`, `creditCard`). |\n| `defaultValues[].entityValueId` | `string` | Yes | The unique ID of the associated entity value. |\n\n**Note**: You must provide the complete list of default values. Partial updates are not supported.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The default values were successfully updated. No content is returned in the response body." + }, + "response": [] + }, + { + "name": "Delete Default Values", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "defaultValues", + "documents", + "orgUnitId-{{unitId}}" + ] + }, + "description": "Deletes all default values for a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents/orgUnitId-{{unit}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `201 Created`\n \n- **Description**: The default values document for the specified organization unit has been successfully deleted.\n \n\n#### Error Responses\n\n- **404 Not Found**: The document with the specified organization unit ID does not exist." + }, + "response": [] + } + ], + "description": "Default values are purchase details, such as addresses and credit cards, that you can configure for an organizational unit to be automatically pre-filled at checkout." + }, + { + "name": "Contact Information", + "item": [ + { + "name": "Create New Contact Information", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "••••••" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"email\": \"rafael.silva@example.com\",\n\t\"firstName\": \"Rafael\",\n\t\"lastName\": \"Silva\",\n\t\"profileId\": \"878fa807-7c7b-4ad3-aaa6-e3ef4fb22b8f\",\n \"phone\": \"+1 212 555 1234\",\n \"phoneExtension\": \"123\",\n \"document\": \"112-3456789\",\n \"documentType\": \"EIN\",\n \"addressIds\": [\n \"1ded2836-2061-4545-96d3-58f5338627c5\",\n \"a3e103fc-d074-44fb-941a-949f1bca937c\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/contact_information/documents?_schema=v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "contact_information", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + } + ] + }, + "description": "This endpoint creates new contact information.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/contact_information/documents?_schema=v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Query\n\n| **Parameter** | **Type** | Required | **Description** |\n| --- | --- | --- | --- |\n| `_schema` | `string` | Yes | Schema version. |\n\n---\n\n### Request body\n\n``` json\n{\n \"email\": \"rafael.silva@example.com\",\n \"firstName\": \"Rafael\",\n \"lastName\": \"Silva\",\n \"profileId\": \"878fa807-7c7b-4ad3-aaa6-e3ef4fb22b8f\",\n \"phone\": \"+1 212 555 1234\",\n \"phoneExtension\": \"123\",\n \"document\": \"112-3456789\",\n \"documentType\": \"EIN\",\n \"addressIds\": [\"1ded2836-2061-4545-96d3-58f5338627c5\", \"a3e103fc-d074-44fb-941a-949f1bca937c\"]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `email` | `string` | No | User email. |\n| `firstName` | `string` | Yes | User first name. |\n| `lastName` | `string` | Yes | User last name. |\n| `profileId` | `string (UUID)` | No | References a Customer entity by its UUID. |\n| `phone` | `string` | No | Main phone number. |\n| `PhoneExtension` | `string` | No | Internal phone extension if applicable. |\n| `document` | `string` | No | Identification document. |\n| `documentType` | `string` | No | Type of document. |\n| `addressIds` | `array (UUID)` | No | References to address entities. |\n\n---\n\n### Response\n\n- **Status Code**: `201 Created`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"contact_information-dd4a6849-58e2-11f0-b37f-d93b9c481b34\",\n \"Href\": \"http://{{account}}.myvtex.com/api/dataentities/contact_information/documents/dd4a6849-58e2-11f0-b37f-d93b9c481b34?_schema=v1\",\n \"DocumentId\": \"dd4a6849-58e2-11f0-b37f-d93b9c481b34\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `Id` | `string` | Contact information identifier. |\n| `Href` | `string` | Contact information store path. |\n| `DocumentId` | `string` | Contact information document identifier. |" + }, + "response": [ + { + "name": "Success Response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"rafael.silva@example.com\",\r\n \"firstName\": \"Rafael\",\r\n \"lastName\": \"Silva\",\r\n \"profileId\": \"878fa807-7c7b-4ad3-aaa6-e3ef4fb22b8f\",\r\n \"phone\": \"+1 212 555 1234\",\r\n \"phoneExtension\": \"123\",\r\n \"document\": \"112-3456789\",\r\n \"documentType\": \"EIN\",\r\n \"addressIds\": [\"1ded2836-2061-4545-96d3-58f5338627c5\", \"a3e103fc-d074-44fb-941a-949f1bca937c\"]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/contact_information/documents?_schema=v1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "contact_information", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"contact_information-dd4a6849-58e2-11f0-b37f-d93b9c481b34\",\n \"Href\": \"http://{{account}}.myvtex.com/api/dataentities/contact_information/documents/dd4a6849-58e2-11f0-b37f-d93b9c481b34?_schema=v1\",\n \"DocumentId\": \"dd4a6849-58e2-11f0-b37f-d93b9c481b34\"\n}" + } + ] + }, + { + "name": "Search Contact Information", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/contact_information/search?_where=profileId={{profileIdValue}}&_fields=firstName, lastName, email&_schema=v1 ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "contact_information", + "search" + ], + "query": [ + { + "key": "_where", + "value": "profileId={{profileIdValue}}", + "description": "Data entities information." + }, + { + "key": "_fields", + "value": "firstName, lastName, email", + "description": "Data entities fields." + }, + { + "key": "_schema", + "value": "v1 ", + "description": "Master Data version." + } + ] + }, + "description": "This endpoint will search contacts information based in the query parameters.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/a`pi/dataentitites/contact_information/search?_where=profileId={{profileIdValue}}&_fields=firstName, lastName, email&_schema=v1\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Query\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `_where` | `string` | Yes | Data entities information. |\n| `_fields` | `string` | Yes | Data entities fields. |\n| `profileIdValue` | `string` | Yes | Customer profile ID used to retrieve their contact information. |\n| `_schema` | `string` | Yes | Master Data version. |\n\n> ℹ️ It is also possible to use Pagination and Sort as described in the [Master Data V2 Search API](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/search) documentation. \n \n\n---\n\n### Response\n\n``` json\n[\n {\n \"firstName\": \"Rafael\",\n \"lastName\": \"Silva\",\n \"email\": \"rafael.silva@example.com\"\n },\n {\n \"firstName\": \"Carolina\",\n \"lastName\": \"Mendes\",\n \"email\": \"carolina.mendes@example.com\"\n },\n {\n \"firstName\": \"Lucas\",\n \"lastName\": \"Oliveira\",\n \"email\": \"lucas.oliveira@example.com\"\n }\n]\n\n ```\n\n| **Field** | Type | **Description** |\n| --- | --- | --- |\n| `firstName` | `string` | User first name. |\n| `lastName` | `string` | User last name. |\n| `email` | `string` | User email. |" + }, + "response": [] + } + ], + "description": "Contacts is a list of the people who receive store's shipments. The contact for each order is distinct from the person who placed the order, so when a shopper is placing the order, they need to inform who will be the receiver from the aforementioned contacts.\n\nThese endpoints manage contact information." + }, + { + "name": "Buying Policies", + "item": [ + { + "name": "Dimensions", + "item": [ + { + "name": "Create Dimension", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{appKey}}" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{appToken}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions" + ] + }, + "description": "This endpoint creates a new authorization dimension with its associated rules.\n\nDimensions contain an `unitId` field that allows grouping of dimensions by units or business areas, enabling more granular authorization control. This field is automatically filled based on the unit relative to the user creating the dimension.\n\nIf you make this request using an appKey/appToken pair, you must explicitly send the `unitId` field in the request body root.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request body\n\n``` json\n{\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the dimension. |\n| `requireAllRulesAcceptance` | `boolean` | Yes | Whether all listed rules must be accepted. If false, the first rule aproval would cause the dimension to be aproved. Always `true` for ODP. |\n| `unitId` | `string` | No | Identifier of the organization unit this dimension belongs to. Each unit can have one dimension. This field is required when using `appKey/appToken` authentication. |\n| `priority` | `number` | Yes | Priority of the dimension. Defines the order of application: lower numbers are evaluated first. Since each unit has a single dimension, this value is fixed as 1 by default. |\n| `ruleCollection` | `array of objects` | Yes | List of rules that define conditions and actions. |\n| └─ `name` | `string` | Yes | Name of the rule. |\n| └─ `priority` | `number` | Yes | Rule priority. Lower numbers are evaluated first. evaluation. |\n| └─ `trigger` | `object` | Yes | Defines the condition and effect that trigger the rule. |\n| └─ `condition` | `object` | Yes | Condition that must be met to trigger the rule. |\n| └─── `conditionType` | `number` | Yes | Type of condition. For ODP, type `2` is recommended, because it can deal with many different use cases. Type `2` defines that the rule condition is set by an expression (see field `expression`). |\n| └─── `description` | `string` | Yes | Description of the condition. |\n| └─── `expression` | `string` | Yes | Expression that defines the condition logic. |\n| └── `effect` | `object` | Yes | Effect to apply when the condition is met. |\n| └─── `description` | `string` | Yes | Description of the effect. |\n| └─── `effectType` | `number` | Yes | Type of effect Possible values are: `0` (approve), `1` (deny) or `2` (pending, which means it require manual aproval/denial). |\n| └`scoreInterval` | `object` | Yes | Defines acceptance and denial thresholds. The values are fixed as accept: 10 and deny: 5. |\n| └── `accept` | `number` | Yes | Minimum score required to accept the rule. Fixed at `10`. |\n| └── `deny` | `number` | Yes | Maximum score to deny the rule. Fixed at `5`. |\n| └─ `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. Supports both `Unit` and `User` authorizers. |\n| └── `requireAllApprovals` | `boolean` | Yes | Condition that makes all authorizers approvals to be required. |\n| └── `authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| └─── `type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| └─── `id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response Example\n\n``` json\n{\n \"id\": \"c20ececf-660f-4656-a802-9ba607e3585b\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - api.vtexinternal.com.br\",\n \"unitId\": \"Tech\",\n \"status\": null,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"ad7742c2-8916-4bd1-86b3-b81f21f9db7e\",\n \"name\": \"Rule Monitoring test\",\n \"status\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Condition Description\",\n \"lessThan\": 90,\n \"greatherThan\": 10,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Efect Description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-10T19:11:14.7103786Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the created dimension. |\n| `name` | `string` | Name of the authorization dimension. |\n| `unitId` | `string` | Identifier of the business unit this dimension belongs to. |\n| If this field is not provided in the request body, the value will default to the business unit associated with the user token from the `VtexIdclientAutCookie`. | | |\n| `status` | `string` | Current status of the dimension (`null`, `accepted`, `denied`, `pending` and `ignored`). |\n| `priority` | `integer` | Execution priority of the dimension. Lower numbers are evaluated first. Since all dimensions must be evaluated either way, priority may be hardcoded to `1` for all dimensions. |\n| `shouldSimulate` | `boolean` | If true, the dimension is simulated and not enforced. |\n| `ruleCollection` | `array` | Collection of rules contained in this dimension. |\n| └─ `name` | `string` | Rule name. |\n| └─ `status` | `string` | Rule status (can be null). |\n| └─ `doId` | `string` | Optional ID of a Decision Object. |\n| └─ `priority` | `integer` | Evaluation priority for the rule. |\n| └─ `trigger` | `object` | Contains the trigger condition and effect logic. |\n| └── `conditionType` | `integer` | Type of condition (e.g., `threshold`, `expression`). |\n| └── `description` | `string` | Description of the condition. |\n| └── `lessThan` | `number` | Optional upper threshold value. |\n| └── `greatherThan` | `number` | Optional lower threshold value. |\n| └─ `effect` | `integer` | Timeout in milliseconds for the rule. |\n| └── `description` | `string` | Description of the effect. |\n| └── `effectType` | `integer` | Type of effect (e.g., `accept`, `deny`, `pending`). |\n| └── `funcPath` | `string` | Optional function path for custom effect logic. |\n| └─ `timeout` | `integer` | Timeout in milliseconds for the rule. |\n| └─ `notification` | `boolean` | Whether this rule should trigger a notification. |\n| └─ `scoreInterval` | `object` | Score range for accepting or denying the rule. |\n| `creationDate` | `string` | Date and time of dimension creation. |\n| `creationVersion` | `string` | Version of the system that created the dimension. |\n| `creationEnvironment` | `string` | Environment (e.g., `stable`, `beta`) where the dimension was created. |" + }, + "response": [] + }, + { + "name": "Update Dimension Information", + "request": { + "method": "PUT", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "jCEtqueIsYSjKiSEW03PsdBi_ImtNSgodLOn70uhKy6FBcsa0jIsITJkdQxIQgIL4Dyc9yM_HfQtrDZOjrH-GidkiEpkenZtiqhLzkSp1C7917HlEDpIYwW4lMeZFKu2nOEmGd9u-jopZYa5n0sRV0f_G_VVkzmfUa4bQEwl2BU" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "vtexappkey-appvtex" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions", + "{{dimensionId}}" + ] + }, + "description": "This endpoint updates information about a specific dimension by its ID.\n\nDimensions contain an `unitId` \nfield that allows grouping of dimensions by units or business areas, \nenabling more granular authorization control. This field is \nautomatically filled based on the unit relative to the user creating the \ndimension.\n\nIf you make this request using an appKey/appToken pair, you must explicitly send the `unitId` field in the request body root.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Dimension identifier. |\n\n---\n\n#### Request body\n\n``` json\n{\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | ID of the dimension. |\n| `name` | `string` | Yes | Name of the dimension. |\n| `requireAllRulesAcceptance` | `boolean` | Yes | Whether all listed rules must be accepted. If false, the first rule aproval would cause the dimension to be aproved. Always `true` for ODP. |\n| `unitId` | `string` | No | Identifier of the business unit this dimension belongs to. This field is required when using `appKey/appToken` authentication. |\n| `priority` | `number` | Yes | Execution priority of the dimension. Lower numbers are evaluated first. Since all dimensions must be evaluated either way, priority may be hardcoded to `1` for all dimensions. |\n| `ruleCollection` | `array of objects` | Yes | List of rules that define conditions and actions. |\n| └─ `name` | `string` | Yes | Name of the rule. |\n| └─ `priority` | `number` | Yes | Rule priority. Lower numbers are evaluated first. evaluation. |\n| └─ `trigger` | `object` | Yes | Defines the condition and effect that trigger the rule. |\n| └─ `condition` | `object` | Yes | Condition that must be met to trigger the rule. |\n| └─── `conditionType` | `number` | Yes | Type of condition. For ODP, type `2` is recommended, because it can deal with many different use cases. Type `2` defines that the rule condition is set by an expression (see field `expression`). |\n| └─── `description` | `string` | Yes | Description of the condition. |\n| └─── `expression` | `string` | Yes | Expression that defines the condition logic. |\n| └── `effect` | `object` | Yes | Effect to apply when the condition is met. |\n| └─── `description` | `string` | Yes | Description of the effect. |\n| └─── `effectType` | `number` | Yes | Type of effect Possible values are: `0` (approve), `1` (deny) or `2` (pending, which means it require manual aproval/denial). |\n| └`scoreInterval` | `object` | Yes | Defines acceptance and denial thresholds. |\n| └── `accept` | `number` | Yes | Minimum score required to accept the rule. |\n| └── `deny` | `number` | Yes | Maximum score to deny the rule. |\n| └─ `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| └── `requireAllApprovals` | `boolean` | Yes | Condition that makes all authorizers approvals to be required. |\n| └── `authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| └─── `type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| └─── `id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response Example\n\n``` json\n{\n \"id\": \"c20ececf-660f-4656-a802-9ba607e3585b\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - api.vtexinternal.com.br\",\n \"unitId\": \"Tech\",\n \"status\": null,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"ad7742c2-8916-4bd1-86b3-b81f21f9db7e\",\n \"name\": \"Rule Monitoring test\",\n \"status\": null,\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Condition Description\",\n \"lessThan\": 90,\n \"greatherThan\": 10,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Efect Description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-10T19:11:14.7103786Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the created dimension. |\n| `name` | `string` | Name of the authorization dimension. |\n| `unitId` | `string` | Identifier of the business unit this dimension belongs to. |\n| If this field is not provided in the request body, the value will default to the business unit associated with the user token from the `VtexIdclientAutCookie`. | | |\n| `status` | `string` | Current status of the dimension (`null`, `accepted`, `denied`, `pending` and `ignored`). |\n| `priority` | `integer` | Execution priority of the dimension. Lower numbers are evaluated first. |\n| `shouldSimulate` | `boolean` | If true, the dimension is simulated and not enforced. |\n| `ruleCollection` | `array` | Collection of rules contained in this dimension. |\n| └─ `name` | `string` | Rule name. |\n| └─ `status` | `string` | Rule status (can be null). |\n| └─ `doId` | `string` | Optional ID of a Decision Object. |\n| └─ `priority` | `integer` | Evaluation priority for the rule. |\n| └─ `trigger` | `object` | Contains the trigger condition and effect logic. |\n| └── `conditionType` | `integer` | Type of condition (e.g., `threshold`, `expression`). |\n| └── `description` | `string` | Description of the condition. |\n| └── `lessThan` | `number` | Optional upper threshold value. |\n| └── `greatherThan` | `number` | Optional lower threshold value. |\n| └─ `effect` | `integer` | Timeout in milliseconds for the rule. |\n| └── `description` | `string` | Description of the effect. |\n| └── `effectType` | `integer` | Type of effect (e.g., `accept`, `deny`, `pending`). |\n| └── `funcPath` | `string` | Optional function path for custom effect logic. |\n| └─ `timeout` | `integer` | Timeout in milliseconds for the rule. |\n| └─ `notification` | `boolean` | Whether this rule should trigger a notification. |\n| └─ `scoreInterval` | `object` | Score range for accepting or denying the rule. |\n| `creationDate` | `string` | Date and time of dimension creation. |\n| `creationVersion` | `string` | Version of the system that created the dimension. |\n| `creationEnvironment` | `string` | Environment (e.g., `stable`, `beta`) where the dimension was created. |" + }, + "response": [] + }, + { + "name": "Get Dimensions Information", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-OANE}}" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-OANE}}" + } + ], + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions" + ] + }, + "description": "This endpoint retrieves a list with dimensions information.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n---\n\n### Response body\n\n``` json\n[\n {\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test\",\n \"unitId\": null,\n \"status\": null,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"36f6fa52-231c-4a16-963d-f2347cebae60\",\n \"name\": \"Rule Monitoring 1 - Rule CRUD test\",\n \"status\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Rule Monitoring 1 - Rule CRUD test- Description\",\n \"lessThan\": 30.0,\n \"greatherThan\": 0.01,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Rule Monitoring 1 - Rule CRUD test - Effect Description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 5000,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"id\": \"a2cd4605-1765-4e95-80e8-018a3223e2be\",\n \"name\": \"Rule Monitoring test\",\n \"status\": null,\n \"priority\": 2,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Condition Description\",\n \"lessThan\": 90.0,\n \"greatherThan\": 10.0,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Efect Description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-16T17:01:42.0989019Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the dimension. |\n| `name` | `string` | Name of the dimension. |\n| `unitId` | `string` | Identifier of the organizational unit this dimension belongs to. |\n| `status` | `string` | Status of the dimension. Can be used to control activation. |\n| `priority` | `number` | Execution priority of the dimension. Lower numbers are evaluated first. |\n| `shouldSimulate` | `boolean` | Indicates if the rules should be simulated instead of enforced. |\n| `ruleCollection` | `array of objects` | List of rules contained within the dimension. |\n| `ruleCollection.id` | `string` | Unique identifier of the rule. |\n| `ruleCollection.name` | `string` | Name of the rule. |\n| `ruleCollection.status` | `string` | Current status of the rule. |\n| `ruleCollection.priority` | `number` | Rule execution priority within the dimension. |\n| `ruleCollection.trigger.condition.conditionType` | `number` | Type of the condition logic (e.g., numerical range, expression). |\n| `ruleCollection.trigger.condition.description` | `string` | Description of the condition being evaluated. |\n| `ruleCollection.trigger.condition.lessThan` | `number` | Maximum value allowed for validation. |\n| `ruleCollection.trigger.condition.greatherThan` | `number` | Minimum value allowed for validation. |\n| `ruleCollection.trigger.condition.expression` | `string` | Expression to evaluate if applicable. |\n| `ruleCollection.trigger.effect.description` | `string` | Description of the effect applied if condition is met. |\n| `ruleCollection.trigger.effect.effectType` | `number` | Type of effect to apply (e.g., accept, deny, pending). |\n| `ruleCollection.timeout` | `number` | Time in milliseconds to wait for rule evaluation. |\n| `ruleCollection.notification` | `boolean` | Whether a notification should be triggered. |\n| `ruleCollection.scoreInterval.accept` | `number` | Minimum score required to accept the order. Default is `51`. |\n| `ruleCollection.scoreInterval.deny` | `number` | Maximum score allowed to deny the order. Default is `49`. |\n| `creationDate` | `string` | Date when the dimension was created (ISO 8601). |\n| `creationVersion` | `string` | Version of the system at creation time. |\n| `creationEnvironment` | `string` | Environment in which the dimension was created (e.g., `stable`, `beta`). |" + }, + "response": [] + }, + { + "name": "Delete Dimension", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-OANE}}" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-OANE}}" + } + ], + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions", + "{{dimensionId}}" + ] + }, + "description": "This endpoint deletes a specific dimension by its ID.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Dimension identifier. |\n\n---\n\n### Response body\n\n``` json\n{}\n\n ```" + }, + "response": [] + } + ], + "description": "A dimension is a container that groups authorization rules for a specific organization unit. All buying policies (rules) belonging to that unit are stored within this single dimension. Dimensions are also known as \"buying policy groups\"." + }, + { + "name": "Rules", + "item": [ + { + "name": "Create Dimension Rule", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Cookie", + "value": "VtexIdclientAutCookie={{your_token}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions", + "{{dimensionId}}", + "rules" + ] + }, + "description": "This endpoint registers a new diumension rule.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | Unique identifier of the rule. |\n| `name` | `string` | Yes | Name of the rule. |\n| `priority` | `number` | Yes | Execution priority of the rule within the dimension. |\n| `trigger.condition.conditionType` | `number` | Yes | Type of condition logic (e.g., numerical range, expression). |\n| `trigger.condition.description` | `string` | Yes | Description of the condition being evaluated. |\n| `trigger.condition.expression` | `string` | No | Expression used for evaluation, if applicable. |\n| `trigger.effect.description` | `string` | Yes | Description of the effect to be applied if condition is met. |\n| `trigger.effect.effectType` | `number` | Yes | Type of effect (e.g., accept, deny, pending). |\n| `timeout` | `number` | Yes | Maximum time (ms) allowed for rule evaluation. |\n| `notification` | `boolean` | Yes | Whether a notification should be triggered if the rule is evaluated. |\n| `scoreInterval.accept` | `number` | Yes | Minimum score required to accept the rule. |\n| `scoreInterval.deny` | `number` | Yes | Maximum score allowed to deny the rule. |\n| `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| `authorizationData.requireAllApprovals` | `boolean` | No | Condition that makes all authorizers approvals to be required. |\n| `authorizationData.authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| `authorizationData.authorizers[].type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| `authorizationData.authorizers[].id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response\n\n``` json\n[\n {\n \"id\":\"202cd02c-e36f-4f79-85f4-91210fac8b98\",\n \"name\":\"Order cannot exceed budget\",\n \"status\":null,\n \"doId\":null,\n \"priority\":1,\n \"trigger\":{\n \"condition\":{\n \"conditionType\":2,\n \"description\":\"JSONata Rule\",\n \"lessThan\":null,\n \"greatherThan\":null,\n \"expression\":\"budgetData.budgetAllocations.budgetBalance.remaining < 0\"\n },\n \"effect\":{\n \"description\":\"Send Order Auth update event\",\n \"effectType\":2,\n \"funcPath\":null\n }\n },\n \"timeout\":5000,\n \"notification\":false,\n \"scoreInterval\":{\n \"accept\":51,\n \"deny\":49\n }\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | `string` | Rule identifier. |\n| `name` | `string` | Name of the rule. |\n| `status` | `string` | Status of the rule. |\n| `doId` | `string` | Deployment object ID (optional). |\n| `priority` | `number` | Rule evaluation priority. |\n| `trigger` | `object` | Trigger information. |\n| └─ `condition` | `object` | Condition that triggers the rule evaluation. |\n| └── `conditionType` | `number` | Type of condition. |\n| └── `description` | `string` | Description of the condition. |\n| └── `expression` | `string` | JSONata expression for rule condition evaluation. |\n| └─ `effect` | `object` | Effect applied when the condition is satisfied. |\n| └── `description` | `string` | Description of the effect. |\n| └── `effectType` | `number` | Type of effect. |\n| └── `funcPath` | `string` | Optional path to a function to be executed. |\n| `timeout` | `number` | Timeout in milliseconds. |\n| `notification` | `boolean` | Whether to trigger a notification. |\n| `scoreInterval` | `object` | Score interval information. |\n| └─ `accept` | `number` | Score interval to automatically accept. |\n| └─ `deny` | `number` | Score interval to automatically deny. |" + }, + "response": [] + }, + { + "name": "Update All Dimension Rules", + "request": { + "method": "PUT", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-OANE}}" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-OANE}}" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"Accounting Limit - Max spend limit per order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value >= 10000 ($100)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value >= 10000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $100 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Max spend limit per order line\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 1000 ($10)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $max(items.sellingPrice + items.tax + items.customTax) >= 1000\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with value above $10 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Minimum order value required to place an order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value below 100 ($1)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value <= 100\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value below $1\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value above $50 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $.value > 5000 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value above $50 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order line for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value above $5 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $max(items.sellingPrice + items.tax + items.customTax) > 500 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders that contains items with value above $5 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max spend limit per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 30000 ($300) for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.sellingPrice + items.tax + items.customTax) >= 300000\"\n },\n \"effect\": {\n \"description\": \"Order items for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 that exceed $300 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Only one approver\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"User 8f6b3712-4c05-4ce5-8057-63fd0d69a587 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 15000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions", + "{{dimensionId}}", + "rules" + ] + }, + "description": "This endpoint updates all dimension rules.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n[\n {\n \"name\": \"Accounting Limit - Max spend limit per order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value >= 10000 ($100)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value >= 10000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $100 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Max spend limit per order line\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 1000 ($10)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $max(items.sellingPrice + items.tax + items.customTax) >= 1000\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with value above $10 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Minimum order value required to place an order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value below 100 ($1)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value <= 100\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value below $1\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value above $50 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $.value > 5000 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value above $50 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order line for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value above $5 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $max(items.sellingPrice + items.tax + items.customTax) > 500 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders that contains items with value above $5 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max spend limit per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 30000 ($300) for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.sellingPrice + items.tax + items.customTax) >= 300000\"\n },\n \"effect\": {\n \"description\": \"Order items for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 that exceed $300 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Only one approver\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"User 8f6b3712-4c05-4ce5-8057-63fd0d69a587 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 15000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n ]\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the rule. |\n| `priority` | `number` | Yes | Priority of the rule within the dimension. Lower numbers are evaluated first. |\n| `trigger.condition.conditionType` | `number` | Yes | Type of the condition logic (e.g., range, expression). |\n| `trigger.condition.description` | `string` | Yes | Description of the condition being evaluated. |\n| `trigger.condition.expression` | `string` | No | Expression to evaluate, if applicable. |\n| `trigger.effect.description` | `string` | Yes | Description of the effect applied when the condition is met. |\n| `trigger.effect.effectType` | `number` | Yes | Type of effect applied (e.g., 1 = deny, 2 = accept). |\n| `scoreInterval.accept` | `number` | Yes | Minimum score required to accept the order. |\n| `scoreInterval.deny` | `number` | Yes | Maximum score allowed to deny the order. |\n| `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| `authorizationData.requireAllApprovals` | `boolean` | Yes | Condition that makes all authorizers approvals to be required. |\n| `authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| `authorizers[].type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| `authorizers[].id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response body\n\n``` json\n{\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - Update\",\n \"unitId\": null,\n \"status\": null,\n \"priority\": 2,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"bf2ed52d-b128-4099-b3e3-43153e85b463\",\n \"name\": \"New rule\",\n \"status\": null,\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"New Rule\",\n \"lessThan\": 30.0,\n \"greatherThan\": 0.01,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"New Rule\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 5000,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n ],\n \"creationDate\": \"2025-06-16T17:01:42.0989019Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the dimension. |\n| `name` | `string` | Name of the dimension. |\n| `unitId` | `string` | Identifier of the organizational unit this dimension belongs to. |\n| `status` | `string` | Status of the dimension. Can be used to control activation. |\n| `priority` | `number` | Execution priority of the dimension. Lower numbers are evaluated first. |\n| `shouldSimulate` | `boolean` | Indicates if the rules should be simulated instead of enforced. |\n| `ruleCollection` | `array of objects` | List of rules contained within the dimension. |\n| `ruleCollection.id` | `string` | Unique identifier of the rule. |\n| `ruleCollection.name` | `string` | Name of the rule. |\n| `ruleCollection.status` | `string` | Current status of the rule. |\n| `ruleCollection.doId` | `string` | Identifier for Decision Object (optional). |\n| `ruleCollection.priority` | `number` | Rule execution priority within the dimension. |\n| `ruleCollection.trigger.condition.conditionType` | `number` | Type of the condition logic (e.g., numerical range, expression). |\n| `ruleCollection.trigger.condition.description` | `string` | Description of the condition being evaluated. |\n| `ruleCollection.trigger.condition.lessThan` | `number` | Maximum value allowed for validation. |\n| `ruleCollection.trigger.condition.greatherThan` | `number` | Minimum value allowed for validation. |\n| `ruleCollection.trigger.condition.expression` | `string` | Expression to evaluate if applicable. |\n| `ruleCollection.trigger.effect.description` | `string` | Description of the effect applied if condition is met. |\n| `ruleCollection.trigger.effect.effectType` | `number` | Type of effect to apply (e.g., accept, deny, pending). |\n| `ruleCollection.trigger.effect.funcPath` | `string` | Optional path to a function to execute as an effect. |\n| `ruleCollection.timeout` | `number` | Time in milliseconds to wait for rule evaluation. |\n| `ruleCollection.notification` | `boolean` | Whether a notification should be triggered. |\n| `ruleCollection.scoreInterval.accept` | `number` | Minimum score required to accept the order. |\n| `ruleCollection.scoreInterval.deny` | `number` | Maximum score allowed to deny the order. |\n| `creationDate` | `string` | Date when the dimension was created (ISO 8601). |\n| `creationVersion` | `string` | Version of the system at creation time. |\n| `creationEnvironment` | `string` | Environment in which the dimension was created (e.g., `stable`, `beta`). |" + }, + "response": [] + }, + { + "name": "Update Dimension Rule", + "request": { + "method": "PUT", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-OANE}}" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-OANE}}" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions", + "{{dimensionId}}", + "rules", + "{{ruleId}}" + ] + }, + "description": "This endpoint updates a specific dimension rule.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n| `ruleId` | `string` | Yes | Identifier for the dimension rule. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | Unique identifier of the rule. |\n| `name` | `string` | Yes | Name of the rule. |\n| `priority` | `number` | Yes | Execution priority of the rule within the dimension. |\n| `trigger.condition.conditionType` | `number` | Yes | Type of condition logic (e.g., numerical range, expression). |\n| `trigger.condition.description` | `string` | Yes | Description of the condition being evaluated. |\n| `trigger.condition.expression` | `string` | No | Expression used for evaluation, if applicable. |\n| `trigger.effect.description` | `string` | Yes | Description of the effect to be applied if condition is met. |\n| `trigger.effect.effectType` | `number` | Yes | Type of effect (e.g., accept, deny, pending). |\n| `timeout` | `number` | Yes | Maximum time (ms) allowed for rule evaluation. |\n| `notification` | `boolean` | Yes | Whether a notification should be triggered if the rule is evaluated. |\n| `scoreInterval.accept` | `number` | Yes | Minimum score required to accept the rule. |\n| `scoreInterval.deny` | `number` | Yes | Maximum score allowed to deny the rule. |\n| `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| `authorizationData.requireAllApprovals` | `boolean` | No | Condition that makes all authorizers approvals to be required. |\n| `authorizationData.authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| `authorizationData.authorizers[].type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| `authorizationData.authorizers[].id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response body\n\n``` json\n{\n \"id\": \"bf2ed52d-b128-4099-b3e3-43153e85b463\",\n \"name\": \"Updated rule\",\n \"status\": null,\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Updated Rule\",\n \"lessThan\": 30.0,\n \"greatherThan\": 0.01,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Updated Rule\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 5000,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the rule. |\n| `name` | `string` | Name of the rule. |\n| `status` | `string` | Current status of the rule. |\n| `doId` | `string` | Identifier for Decision Object (optional). |\n| `priority` | `number` | Execution priority of the rule within the dimension. |\n| `trigger.condition.conditionType` | `number` | Type of condition logic (e.g., numerical range, expression). |\n| `trigger.condition.description` | `string` | Description of the condition being evaluated. |\n| `trigger.condition.lessThan` | `number` | Maximum value allowed for the condition. |\n| `trigger.condition.greatherThan` | `number` | Minimum value allowed for the condition. |\n| `trigger.condition.expression` | `string` | Expression used for evaluation, if applicable. |\n| `trigger.effect.description` | `string` | Description of the effect to be applied if condition is met. |\n| `trigger.effect.effectType` | `number` | Type of effect (e.g., accept, deny, pending). |\n| `trigger.effect.funcPath` | `string` | Optional path to a function to execute as an effect. |\n| `timeout` | `number` | Maximum time (ms) allowed for rule evaluation. |\n| `notification` | `boolean` | Whether a notification should be triggered if the rule is evaluated. |\n| `scoreInterval.accept` | `number` | Minimum score required to accept the rule. |\n| `scoreInterval.deny` | `number` | Maximum score allowed to deny the rule. |" + }, + "response": [] + }, + { + "name": "Delete Dimension Rule", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-OANE}}" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-OANE}}" + } + ], + "url": { + "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}", + "protocol": "https", + "host": [ + "api", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "{{accountName}}", + "authorization-dimensions", + "{{dimensionId}}", + "rules", + "{{ruleId}}" + ] + }, + "description": "This endpoint deletes a specific dimension rule.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n| `ruleId` | `string` | Yes | Identifier for the dimension rule. |\n\n---\n\n### Request Body\n\n``` json\n{}\n\n ```" + }, + "response": [] + }, + { + "name": "Accept Rule", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "VtexIdclientAutCookie_qastore", + "value": "{{authCookieValue}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-qastore}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-qastore}}", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"params\": {\n \"score\": 100,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "commercial-authorizations", + "{{orderAuthId}}", + "callback" + ] + }, + "description": "This endpoint accepts a dimension rule.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/commercial-authorizations/{{orderAuthId}}/callback`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `orderAuthId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"params\": {\n \"score\": 100,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| params | Object | Yes | Container for the parameters of the request. |\n| params.score | Integer | Yes | Score value to be assigned. Acceptance value depends on the rule configuration. In general, a `score` of `100` accepts the rule. |\n| params.dimensionId | String | Yes | Identifier of the dimension being evaluated. |\n| params.ruleId | String | Yes | Identifier of the rule associated with the dimension. |\n\n### Response body\n\n``` json\n{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"accepted\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0.0,\n \"marketPlacePaymentValue\": 0.0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.40,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"accepted\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier of the approval request. |\n| orderId | string | Identifier of the order linked to this approval process. |\n| workflowInstanceId | string | Identifier of the workflow instance. |\n| status | string | Current approval status (e.g., `accepted`). |\n| units | array | List of unit identifiers related to the approval request. |\n| callbackEndpoint | string | Callback URL for order authorization status updates. |\n| totalOrderValueDesiredBySeller | number | Total value of the order as expected by the seller. |\n| marketPlacePaymentValue | number | Value of the order payment in the marketplace. |\n| itemCollection | array of object | List of items in the order. |\n| itemCollection\\[\\].id | string | Unique identifier of the item in the approval process. |\n| itemCollection\\[\\].sku | string | SKU identifier of the item. |\n| itemCollection\\[\\].price | number | Item price. |\n| itemCollection\\[\\].totalSystemDiscount | number | Discount automatically applied by the system. |\n| itemCollection\\[\\].totalManualDiscount | number | Discount manually applied. |\n| itemCollection\\[\\].quantity | integer | Quantity of the item. |\n| itemCollection\\[\\].additionalInfo.commercialCondition | string | Commercial condition identifier. |\n| additionalInfo | object | Extra information related to the request. |\n| additionalInfo.userProfileId | string | Identifier of the user profile linked to this approval request. |\n| dimensionStatus | array of object | Approval status details per dimension. |\n| dimensionStatus\\[\\].id | string | Unique identifier of the dimension status record. |\n| dimensionStatus\\[\\].name | string | Dimension name. |\n| dimensionStatus\\[\\].unitId | string | Unit identifier related to this dimension. |\n| dimensionStatus\\[\\].userProfileId | string | User profile identifier related to this dimension. |\n| dimensionStatus\\[\\].status | string | Current status of the dimension (e.g., `accepted`). |\n| dimensionStatus\\[\\].score | integer | Score assigned to the dimension. |\n| dimensionStatus\\[\\].priority | integer | Priority of this dimension (lower = higher priority). |\n| dimensionStatus\\[\\].shouldSimulate | boolean | Indicates if this dimension should be simulated before application. |\n| dimensionStatus\\[\\].ruleCollection | array of object | Rules applied to this dimension. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].id | string | Unique identifier of the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].name | string | Rule name. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].status | string | Current status of the rule (e.g., `accepted`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].doId | string | Optional decision object identifier. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].score | integer | Score assigned to the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].priority | integer | Rule priority (lower = higher priority). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.condition | object | Condition that triggers the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.conditionType | integer | Type of condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.description | string | Human-readable description of the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.expression | string | Expression used to evaluate the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect | object | Effect applied when the condition is met. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.description | string | Description of the effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.effectType | integer | Type of effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].timeout | integer | Timeout (in ms) for rule evaluation. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].notification | boolean | Indicates if notifications are enabled for this rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval | object | Score thresholds for decision making. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.accept | integer | Minimum score for acceptance. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.deny | integer | Maximum score for denial. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData | object | Data related to authorization requirements. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.requireAllApprovals | boolean | If `true`, all authorizers must approve. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers | array of object | List of authorizers for the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].id | string | Identifier of the authorizer. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].type | string | Type of authorizer (e.g., `Unit`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].authorizationDate | string (iso 8601) | Date when authorization occurred. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserAuthorized | boolean | Whether the current user is authorized. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserNextAuthorizer | boolean | Whether the current user is the next required authorizer. |\n| dimensionStatus\\[\\].creationDate | string | Timestamp of when the dimension status was created. |\n| dimensionStatus\\[\\].creationVersion | string | Version of the system at creation time. |\n| dimensionStatus\\[\\].creationEnvironment | string | Environment in which the record was created (e.g., `stable`). |\n| dimensionStatus\\[\\].requireAllRulesAcceptance | boolean | If `true`, all rules must be accepted for approval. |\n| creationVersion | string | Version of the system at creation time. |\n| creationEnvironment | string | Environment in which the approval request was created (e.g., `stable`). |\n| userProfileId | string | Identifier of the user profile that created the approval request. |" + }, + "response": [ + { + "name": "200 OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "VtexIdclientAutCookie_qastore", + "value": "{{authCookieValue}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-qastore}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-qastore}}", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"params\": {\n \"score\": 100,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "commercial-authorizations", + "{{orderAuthId}}", + "callback" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [ + { + "expires": "Invalid Date", + "domain": "", + "path": "" + } + ], + "body": "{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"accepted\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0,\n \"marketPlacePaymentValue\": 0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.4,\n \"totalManualDiscount\": 0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"accepted\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"accepted\",\n \"doId\": null,\n \"score\": 100,\n \"authorizedEmails\": [],\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}" + } + ] + }, + { + "name": "Deny Rule", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "VtexIdclientAutCookie_qastore", + "value": "{{authCookieValue}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-qastore}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-qastore}}", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"params\": {\n \"score\": 0,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "commercial-authorizations", + "{{orderAuthId}}", + "callback" + ] + }, + "description": "This endpoint denies a dimension rule.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{account}}.myvtex.com/commercial-authorizations/{{orderAuthId}}/callback`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `orderAuthId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"params\": {\n \"score\": 0,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| params | Object | Yes | Container for the parameters of the request. |\n| params.score | Integer | Yes | Score value to be assigned. Denial value depends on the rule configuration. In general, a `score` of `0` denies the rule. |\n| params.dimensionId | String | Yes | Identifier of the dimension being evaluated. |\n| params.ruleId | String | Yes | Identifier of the rule associated with the dimension. |\n\n### Response Body\n\n``` json\n{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"denied\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0,\n \"marketPlacePaymentValue\": 0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.4,\n \"totalManualDiscount\": 0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier of the approval request. |\n| orderId | string | Identifier of the order linked to this approval process. |\n| workflowInstanceId | string | Identifier of the workflow instance. |\n| status | string | Current denial status (e.g., `denied`). |\n| units | array | List of unit identifiers related to the approval request. |\n| callbackEndpoint | string | Callback URL for order authorization status updates. |\n| totalOrderValueDesiredBySeller | number | Total value of the order as expected by the seller. |\n| marketPlacePaymentValue | number | Value of the order payment in the marketplace. |\n| itemCollection | array of object | List of items in the order. |\n| itemCollection\\[\\].id | string | Unique identifier of the item in the approval process. |\n| itemCollection\\[\\].sku | string | SKU identifier of the item. |\n| itemCollection\\[\\].price | number | Item price. |\n| itemCollection\\[\\].totalSystemDiscount | number | Discount automatically applied by the system. |\n| itemCollection\\[\\].totalManualDiscount | number | Discount manually applied. |\n| itemCollection\\[\\].quantity | integer | Quantity of the item. |\n| itemCollection\\[\\].additionalInfo.commercialCondition | string | Commercial condition identifier. |\n| additionalInfo | object | Extra information related to the request. |\n| additionalInfo.userProfileId | string | Identifier of the user profile linked to this approval request. |\n| dimensionStatus | array of object | Approval status details per dimension. |\n| dimensionStatus\\[\\].id | string | Unique identifier of the dimension status record. |\n| dimensionStatus\\[\\].name | string | Dimension name. |\n| dimensionStatus\\[\\].unitId | string | Unit identifier related to this dimension. |\n| dimensionStatus\\[\\].userProfileId | string | User profile identifier related to this dimension. |\n| dimensionStatus\\[\\].status | string | Current status of the dimension (e.g., `denied`). |\n| dimensionStatus\\[\\].score | integer | Score assigned to the dimension. |\n| dimensionStatus\\[\\].priority | integer | Priority of this dimension (lower = higher priority). |\n| dimensionStatus\\[\\].shouldSimulate | boolean | Indicates if this dimension should be simulated before application. |\n| dimensionStatus\\[\\].ruleCollection | array of object | Rules applied to this dimension. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].id | string | Unique identifier of the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].name | string | Rule name. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].status | string | Current status of the rule (e.g., `denied`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].doId | string | Optional decision object identifier. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].score | integer | Score assigned to the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].priority | integer | Rule priority (lower = higher priority). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.condition | object | Condition that triggers the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.conditionType | integer | Type of condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.description | string | Human-readable description of the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.expression | string | Expression used to evaluate the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect | object | Effect applied when the condition is met. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.description | string | Description of the effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.effectType | integer | Type of effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].timeout | integer | Timeout (in ms) for rule evaluation. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].notification | boolean | Indicates if notifications are enabled for this rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval | object | Score thresholds for decision making. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.accept | integer | Minimum score for acceptance. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.deny | integer | Maximum score for denial. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData | object | Data related to authorization requirements. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.requireAllApprovals | boolean | If `true`, all authorizers must approve. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers | array of object | List of authorizers for the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].id | string | Identifier of the authorizer. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].type | string | Type of authorizer (e.g., `Unit`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].authorizationDate | string (iso 8601) | Date when authorization occurred. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserAuthorized | boolean | Whether the current user is authorized. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserNextAuthorizer | boolean | Whether the current user is the next required authorizer. |\n| dimensionStatus\\[\\].creationDate | string | Timestamp of when the dimension status was created. |\n| dimensionStatus\\[\\].creationVersion | string | Version of the system at creation time. |\n| dimensionStatus\\[\\].creationEnvironment | string | Environment in which the record was created (e.g., `stable`). |\n| dimensionStatus\\[\\].requireAllRulesAcceptance | boolean | If `true`, all rules must be accepted for approval. |\n| creationVersion | string | Version of the system at creation time. |\n| creationEnvironment | string | Environment in which the approval request was created (e.g., `stable`). |\n| userProfileId | string | Identifier of the user profile that created the approval request. |" + }, + "response": [ + { + "name": "200 OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "VtexIdclientAutCookie_qastore", + "value": "{{authCookieValue}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey-qastore}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken-qastore}}", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"params\": {\n \"score\": 0,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "commercial-authorizations", + "{{orderAuthId}}", + "callback" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"denied\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0,\n \"marketPlacePaymentValue\": 0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.4,\n \"totalManualDiscount\": 0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"denied\",\n \"doId\": null,\n \"score\": 100,\n \"authorizedEmails\": [],\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}" + } + ] + } + ], + "description": "A condition–action pair inside a dimension that defines how the system evaluates and authorizes operations. \n \nEach rule includes a condition (`trigger.condition`) and an effect (`trigger.effect`), determining whether an action is approved, denied, or sent for manual approval.\n\nRules are also known as \"buying policies\" and are nested within dimensions (or \"buying policy groups\")." + }, + { + "name": "Order", + "item": [ + { + "name": "Place Order", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "VtexIdclientAutCookie_qastore", + "value": "{{authCookieValue}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": 2,\n \"quantity\": 2,\n \"seller\": \"1\",\n \"price\": 100,\n \"uniqueId\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n {\n \"id\": 8,\n \"quantity\": 1,\n \"seller\": \"1\",\n \"price\": 8500,\n \"uniqueId\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n }\n ],\n \"shippingData\": {{my_shippingData}},\n \"clientProfileData\": {{my_profileData}},\n \"paymentData\": {{my_paymentsDataString}},\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC2\",\n \"refId\": \"CC2\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"9b884ddc-2dbc-4443-8706-8c6a21dac219\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"home\"\n },\n \"fields\": [\n {\n \"name\": \"Desktop\",\n \"value\": \"DSK1\",\n \"refId\": \"b1d7a268-090a-4578-9bf9-22b4537851e8\"\n }\n ]\n }\n ]\n },\n \"openTextField\": {\n \"value\": \"ODP use cases\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/checkout/pub/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "checkout", + "pub", + "orders" + ] + }, + "description": "This endpoint creates a new order.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{account}}.myvtex.com/api/checkout/pub/orders`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n---\n\n### Request Body\n\n``` json\n{\n \"items\": [\n {\n \"id\": 2,\n \"quantity\": 2,\n \"seller\": \"1\",\n \"price\": 100,\n \"uniqueId\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n {\n \"id\": 8,\n \"quantity\": 1,\n \"seller\": \"1\",\n \"price\": 8500,\n \"uniqueId\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n }\n ],\n \"shippingData\": {{my_shippingData}},\n \"clientProfileData\": {{my_profileData}},\n \"paymentData\": {{my_paymentsDataString}},\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC2\",\n \"refId\": \"CC2\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"9b884ddc-2dbc-4443-8706-8c6a21dac219\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"home\"\n },\n \"fields\": [\n {\n \"name\": \"Desktop\",\n \"value\": \"DSK1\",\n \"refId\": \"b1d7a268-090a-4578-9bf9-22b4537851e8\"\n }\n ]\n }\n ]\n },\n \"openTextField\": {\n \"value\": \"ODP use cases\"\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| items | `array of objects` | Yes | List of items included in the order. |\n| items\\[\\].id | `number` | Yes | Identifier of the item. |\n| items\\[\\].quantity | `number` | Yes | Quantity of the item being ordered. |\n| items\\[\\].seller | `string` | Yes | Seller identifier for the item. |\n| items\\[\\].price | `number` | Yes | Price of the item. |\n| items\\[\\].uniqueId | `string` | Yes | Unique identifier of the item in the cart. |\n| shippingData | `object` | Yes | Shipping information for the order. |\n| clientProfileData | `object` | Yes | Customer profile information. |\n| paymentData | `object` | Yes | Payment information. |\n| customData | `object` | No | Custom fields and apps related to the order. |\n| customData.customApps | `array of objects` | No | Custom applications data. |\n| customData.customFields | `array of objects` | No | Custom fields linked to items, orders, or addresses. |\n| customData.customFields\\[\\].linkedEntity | `object` | Yes | Entity information that the custom field is linked to. |\n| customData.customFields\\[\\].linkedEntity.type | `string` | Yes | Type of entity the custom field is linked to (e.g., `item`, `order`). |\n| customData.customFields\\[\\].linkedEntity.id | `string` | No | Identifier of the linked entity (e.g., item `uniqueId`, address `home`). |\n| customData.customFields\\[\\].fields\\[\\] | `array of objects` | Yes | List of customFields. |\n| customData.customFields\\[\\].fields\\[\\].name | `string` | Yes | Name of the custom field (e.g., `costCenter`, `PO Number`). |\n| customData.customFields\\[\\].fields\\[\\].value | `string` | Yes | Value assigned to the custom field. |\n| customData.customFields\\[\\].fields\\[\\].refId | `string` | No | Optional reference identifier for the custom field. |\n| openTextField | `object` | No | Field containing free-text information. |\n| openTextField.value | `string` | No | Value of the free-text field (e.g., \"ODP use cases\"). |\n\n---\n\n### Response Body\n\n``` json\n{\n \"orderForm\": null,\n \"transactionData\": {\n \"merchantTransactions\": [\n {\n \"id\": \"RECORRENCIACHARLIE\",\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"paymentSystem\": \"47\",\n \"bin\": null,\n \"accountId\": null,\n \"tokenId\": null,\n \"value\": 105547,\n \"referenceValue\": 105547,\n \"giftCardRedemptionCode\": null,\n \"giftCardProvider\": null,\n \"giftCardId\": null\n }\n ]\n }\n ],\n \"receiverUri\": \"https://recorrenciacharlie.vtexpayments.com.br/split/1560176581020/payments\",\n \"gatewayCallbackTemplatePath\": \"/checkout/gatewayCallback/1560176581020/{messageCode}\"\n },\n \"orders\": [\n {\n \"orderId\": \"1560176581020-01\",\n \"orderGroup\": \"1560176581020\",\n \"state\": null,\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560176581020-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 105547,\n \"items\": [\n {\n \"uniqueId\": \"ABBF87D61CB3441E97FC2527A93432AA\",\n \"id\": \"1\",\n \"productId\": \"1\",\n \"productRefId\": \"\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:52:36Z\",\n \"tax\": 0,\n \"price\": 765,\n \"listPrice\": 765,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 765,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 765,\n \"total\": 765,\n \"sellingPrices\": [\n {\n \"value\": 765,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"8BEAE818E2AE4474905B4BEF306A5E77\",\n \"id\": \"2\",\n \"productId\": \"2\",\n \"productRefId\": \"\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:54:16Z\",\n \"tax\": 0,\n \"price\": 4282,\n \"listPrice\": 4282,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 4282,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 4282,\n \"total\": 4282,\n \"sellingPrices\": [\n {\n \"value\": 4282,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"F3E0DA124887476DBB0F2C7DC0B6FE2A\",\n \"id\": \"3\",\n \"productId\": \"3\",\n \"productRefId\": \"\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:57:30Z\",\n \"tax\": 0,\n \"price\": 1000,\n \"listPrice\": 1000,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 1000,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 100,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 1000,\n \"total\": 100000,\n \"sellingPrices\": [\n {\n \"value\": 1000,\n \"quantity\": 100\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n }\n ],\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE\",\n \"logo\": \"\",\n \"minimumOrderValue\": 0\n }\n ],\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 105047\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": 0\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 500\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"userautomated24.608800099331596@mailinator.com\",\n \"firstName\": \"Postman\",\n \"lastName\": \"Test\",\n \"document\": \"20275756343\",\n \"documentType\": \"cpf\",\n \"phone\": \"+552222222222\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": false,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [],\n \"teaser\": []\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0.0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"1\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 1,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 5,\n \"listPrice\": 5,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0.0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"2\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 2,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 495,\n \"listPrice\": 495,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0.0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"3\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"pickupPoints\": [\n {\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"id\": \"1_VTEX-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_BPS-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_RIOSUL-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n }\n ],\n \"contactInformation\": []\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"id\": null,\n \"paymentSystem\": \"47\",\n \"paymentSystemName\": \"Cash\",\n \"value\": 105547,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 105547,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": null,\n \"dueDate\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentOrigin\": null\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": null,\n \"commercialConditionData\": null,\n \"giftRegistryData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"saveUserData\": false,\n \"timeZone\": \"E. South America Standard Time\",\n \"currencyCode\": \"BRL\",\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \",\",\n \"currencyGroupSeparator\": \".\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": null,\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"3\",\n \"seller\": \"1\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"productId\": \"3\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"assemblyOptions\": []\n },\n {\n \"id\": \"2\",\n \"seller\": \"1\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"productId\": \"2\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.plano-da-ana\",\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n },\n {\n \"id\": \"1\",\n \"seller\": \"1\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"productId\": \"1\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.teste-nico\",\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.plano-gold\",\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.portunus\",\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.basic\",\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n }\n ]\n },\n \"taxData\": null,\n \"customData\": null,\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"5bb299d7a91c487faece472daed48b46@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:57:30.7718345Z\",\n \"lastChange\": \"2025-09-08T16:57:32.3020624Z\",\n \"timeZoneCreationDate\": \"2025-09-08T13:57:30.7718345\",\n \"timeZoneLastChange\": \"2025-09-08T13:57:32.3020624\",\n \"isCompleted\": false,\n \"hostName\": \"recorrenciacharlie\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:57:30.5217933Z\"\n }\n ],\n \"allowMultipleDeliveries\": true\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `orderForm` | `object` | Contains the complete orderform. |\n| `transactionData` | `object` | Encapsulates data related to the payment transaction. |\n| ↳ `merchantTransactions` | `array of objects` | A list of transactions grouped by merchant. |\n| ↳- `id` | `string` | The merchant's unique identifier. |\n| ↳- `transactionId` | `string` | The unique ID for the transaction. |\n| ↳- `merchantName` | `string` | The name of the merchant. |\n| ↳- `payments` | `array of objects` | Contains details about the payment methods used. |\n| ↳-- `paymentSystem` | `string` | The identifier for the payment system used (e.g., credit card, cash). |\n| ↳-- `bin` | `number` | Card BIN (Bank Identification Number). It's the first 6 to 8 digits on a payment card. |\n| ↳-- `accountId` | `string` | The account ID. |\n| ↳-- `value` | `number` | The total value of the payment in cents. |\n| ↳-- `referenceValue` | `number` | The original or base amount of a transaction or payment. |\n| ↳-- `giftCardRedemptionCode` | `string` | The unique alphanumeric code a customer enters to apply a gift card's value to a purchase. |\n| ↳-- `giftCardProvider` | `string` | The name of the company or entity that issued the gift card. |\n| ↳-- `giftCardId` | `string` | The unique internal identifier assigned to the gift card within the payment system after it has been used. |\n| ↳- `receiverUri` | `string` | The endpoint URL for the payment receiver. |\n| ↳- `gatewayCallbackTemplatePath` | `string` | The path template for the payment gateway's callback. |\n| `orders` | `array of objects` | A list of orders generated from the cart. |\n| ↳ `orderId` | `string` | The unique identifier for this specific order. |\n| ↳ `orderGroup` | `string` | An ID that groups multiple orders from the same cart. |\n| ↳ `state` | `string` | Represents the current status of the order in the fulfillment workflow (e.g., `handling`, `shipped`). |\n| ↳ `isCheckedIn` | `boolean` | A flag that indicates if the order has been checked in at a physical location, like a store or warehouse. |\n| ↳ `sellerOrderId` | `string` | The unique identifier for the order from the seller's internal system. |\n| ↳ `storeId` | `string` | The identifier for a specific physical store, often used for in-store pickup or local fulfillment. |\n| ↳ `checkedInPickupPointId` | `null` | The ID of the pickup point where an order was physically scanned or checked in upon arrival. |\n| ↳ `value` | `number` | The total value of the order in cents. |\n| ↳ `items` | `array of objects` | A list of all items included in the order. |\n| ↳- `uniqueId` | `string` | The item unique ID. |\n| ↳- `id` | `string` | The SKU ID of the item. |\n| ↳- `productId` | `string` | The primary, unique identifier for the product in the system's catalog. |\n| ↳- `productRefId` | `string` | An optional, external reference code for the product, often used for integrations with other systems like an ERP. |\n| ↳- `refId` | `string` | A reference ID for the specific SKU. |\n| ↳- `ean` | `string` | The EAN (European Article Number), which is the standardized barcode number used globally for retail products. |\n| ↳- `name` | `string` | The display name of the item. |\n| ↳- `skuName` | `string` | The display name for the specific SKU. |\n| ↳- `modalType` | `string` | Defines the type of modal to be used in the user interface, if any. |\n| ↳- `parentItemIndex` | `number` | The index of the parent item in the cart, used when this item is part of a bundle or kit. |\n| ↳- `parentAssemblyBinding` | `string` | Specifies how this item is bound to its parent assembly or bundle. |\n| ↳- `assemblies` | `array` | A list of customizations or components selected by the customer for an assembled product. |\n| ↳- `priceValidUntil` | `string` | A timestamp indicating the expiration date and time for the item's current price. |\n| ↳- `tax` | `number` | The total tax value applied to a single unit of this item, in cents. |\n| ↳- `price` | `number` | The base price for a single unit of the item before any promotions, in cents. |\n| ↳- `listPrice` | `number` | The original price of the item before discounts (often the \"was\" price), in cents. |\n| ↳- `manualPrice` | `number` | The price manually set by a store administrator, which overrides other price calculations. |\n| ↳- `manualPriceAppliedBy` | `number` | The ID of the user or system that applied a manual price. |\n| ↳- `sellingPrice` | `number` | The final price for which a single unit of the item is sold after all calculations, in cents. |\n| ↳- `rewardValue` | `number` | The value of loyalty points or rewards associated with purchasing this item. |\n| ↳- `isGift` | `boolean` | A flag indicating if the item is marked as a gift, which can trigger options like gift wrapping. |\n| ↳- `additionalInfo` | `object` | An object containing supplementary information about the product. |\n| ↳-- `dimension` | `object` | An object containing the physical dimensions (height, width, length) and weight of the item. |\n| ↳-- `brandName` | `string` | The brand name of the product. |\n| ↳-- `brandId` | `string` | The unique identifier for the product's brand. |\n| ↳-- `offeringInfo` | `null` | Additional information related to a selected service or offering for the item. |\n| ↳-- `offeringType` | `string` | The type of service or offering associated with the item. |\n| ↳-- `offeringTypeId` | `string` | The unique identifier for the type of service or offering. |\n| ↳- `preSaleDate` | `string` | The date and time when the item will be available for pre-sale, if applicable. |\n| ↳- `productCategoryIds` | `string` | A string containing the hierarchical path of category IDs this product belongs to. |\n| ↳- `productCategories` | `object` | An object that maps the product's category IDs to their corresponding names. |\n| ↳- `quantity` | `number` | The number of units of this item in the order. |\n| ↳- `seller` | `string` | The unique identifier for the seller that is fulfilling this specific item. |\n| ↳- `sellerChain` | `array` | A list of seller IDs involved in the sale, indicating the fulfillment chain or hierarchy. |\n| ↳- `imageUrl` | `string` | The complete URL for the item's primary display image. |\n| ↳- `detailUrl` | `string` | The relative URL path to the product's detail page on the storefront. |\n| ↳- `components` | `array` | A list of components that make up this item if it's a kit with fixed parts. |\n| ↳- `bundleItems` | `array` | A list of items included as part of this bundle, often used for customizable bundles. |\n| ↳- `attachments` | `array` | A list of attachments or services added to the item by the customer, like personalization. |\n| ↳- `attachmentOfferings` | `array` | A list of available services or attachments that can be added to the item, like subscriptions. |\n| ↳-- `name` | `string` | The unique name or identifier for the attachment offering. |\n| ↳-- `required` | `boolean` | A flag indicating whether this attachment is mandatory for purchasing the item. |\n| ↳-- `schema` | `object` | An object that defines the configurable options and rules for the attachment. |\n| ↳--- `vtex.subscription.key.frequency` | `object` | Defines the rules and available options for the subscription's frequency. |\n| ↳---- `maximumNumberOfCharacters` | `number` | Specifies the maximum character length allowed for the frequency value. |\n| ↳---- `domain` | `array` | A list of the predefined, valid values that a user can select for the subscription frequency. |\n| ↳- `offerings` | `array` | A list of services or special options selected by the customer for this item. |\n| ↳- `priceTags` | `array` | Contains pricing information from promotions and taxes that affect the final price. |\n| ↳- `availability` | `string` | Indicates the stock status of the item (e.g., 'available', 'unavailable'). |\n| ↳- `measurementUnit` | `string` | The unit of measure in which the item is sold (e.g., 'kg', 'un', 'm²'). |\n| ↳- `unitMultiplier` | `number` | A factor used to convert the sold unit into a standard base unit for inventory or pricing. |\n| ↳- `manufacturerCode` | `null` | The product's identification code as provided by the manufacturer. |\n| ↳- `priceDefinition` | `object` | An object detailing how the final selling price was calculated. |\n| ↳-- `calculatedSellingPrice` | `number` | The final price of a single unit after all rules and promotions have been applied. |\n| ↳-- `total` | `number` | The total price for the item line (calculated selling price × quantity). |\n| ↳-- `sellingPrices` | `array` | A list of price points based on quantity, used for tiered pricing. |\n| ↳--- `value` | `number` | The price per unit for the specified quantity tier. |\n| ↳--- `quantity` | `number` | The minimum quantity required to qualify for this price tier. |\n| ↳-- `reason` | `null` | A description of why the price was calculated in a certain way, often for manual overrides. |\n| ↳- `taxCode` | `string` | The fiscal or tax classification code for the product. |\n| ↳ `sellers` | `array of objects` | Information about the seller(s) of the items. |\n| ↳- `id` | `string` | The unique identifier for the seller. |\n| ↳- `name` | `string` | The legal or display name of the seller. |\n| ↳- `logo` | `string` | The URL for the seller's logo. |\n| ↳- `minimumOrderValue` | `number` | The minimum value required for an order from this seller, in cents. A value of `0` means no minimum. |\n| ↳ `totals` | `array of objects` | An array summarizing the different costs of the order. |\n| ↳- `id` | `string` | Identifier for the total (e.g., `Items`, `Shipping`). |\n| ↳- `name` | `string` | The display name for the total. |\n| ↳- `value` | `number` | The monetary value for that total category. |\n| ↳ `clientProfileData` | `object` | Contains the customer's personal information. |\n| ↳- `email` | `string` | The customer's email address. |\n| ↳- `firstName` | `string` | The customer's first name. |\n| ↳- `lastName` | `string` | The customer's last name. |\n| ↳- `document` | `string` | The customer's identification document number. |\n| ↳- `documentType` | `string` | The type of personal identification document provided (e.g., 'cpf' for Brazilian individuals). |\n| ↳- `phone` | `string` | The customer's phone number. |\n| ↳- `corporateName` | `string` | The legal name of the company, if the customer is a business. |\n| ↳- `tradeName` | `string` | The commercial or trade name of the company. |\n| ↳- `corporateDocument` | `string` | The company's official registration number (e.g., CNPJ in Brazil). |\n| ↳- `stateInscription` | `string` | The state tax registration number for a business. |\n| ↳- `corporatePhone` | `string` | The primary phone number for the business. |\n| ↳- `isCorporate` | `boolean` | A flag indicating whether the customer is a corporate (business) account. |\n| ↳- `profileCompleteOnLoading` | `boolean` | A flag indicating if the customer's profile data was fully loaded upon session start. |\n| ↳- `profileErrorOnLoading` | `string` | Contains error information if the profile failed to load completely. |\n| ↳- `customerClass` | `string` | A field to classify the customer into a specific group or tier. |\n| ↳ `ratesAndBenefitsData` | `object` | Contains data about promotions, discounts, and benefits applied to the order. |\n| ↳- `rateAndBenefitsIdentifiers` | `array` | A list of identifiers for the specific promotions or benefits applied to the cart. |\n| ↳- `teaser` | `array` | A list of promotional messages or \"teasers\" related to the applied benefits. |\n| ↳ `shippingData` | `object` | Contains all shipping and delivery information. |\n| ↳- `address` | `object` | Contains the detailed information for a specific shipping address. |\n| ↳-- `addressType` | `string` | The type of address, such as 'residential' or 'commercial'. |\n| ↳-- `receiverName` | `string` | The full name of the person designated to receive the shipment. |\n| ↳-- `addressId` | `string` | The unique identifier for this address in the system. |\n| ↳-- `isDisposable` | `boolean` | A flag indicating if the address is temporary and should not be saved to the user's profile. |\n| ↳-- `postalCode` | `string` | The postal or ZIP code for the address. |\n| ↳-- `city` | `string` | The city of the address. |\n| ↳-- `state` | `string` | The state or province abbreviation. |\n| ↳-- `country` | `string` | The three-letter ISO country code. |\n| ↳-- `street` | `string` | The name of the street. |\n| ↳-- `number` | `string` | The street number of the building or house. |\n| ↳-- `neighborhood` | `string` | The neighborhood or district. |\n| ↳-- `complement` | `string` | Additional address details, such as an apartment number or building name. |\n| ↳-- `reference` | `string` | A reference point or landmark to help locate the address. |\n| ↳-- `geoCoordinates` | `array` | A list containing the geographic coordinates \\[longitude, latitude\\] for the address. |\n| ↳ `logisticsInfo` | `array of objects` | Logistics details for each item or group of items. |\n| ↳- `itemIndex` | `number` | The index of the item in the main `items` array that this logistics information applies to. |\n| ↳- `selectedSla` | `string` | The ID of the chosen shipping method. |\n| ↳- `selectedDeliveryChannel` | `string` | The chosen delivery channel. |\n| ↳- `addressId` | `string` | The ID of the address associated with this logistics entry. |\n| ↳- `slas` | `array of objects` | A list of all available shipping methods (SLAs) for this item. |\n| ↳-- `id` | `string` | The unique identifier for the shipping method. |\n| ↳-- `deliveryChannel` | `string` | The channel used for this SLA. |\n| ↳-- `name` | `string` | The display name of the shipping method (e.g., 'Normal', 'Express'). |\n| ↳-- `deliveryIds` | `array of objects` | A list of details about the courier, warehouse, and dock involved in this delivery. |\n| ↳--- `courierId` | `string` | The ID of the courier or carrier responsible for the delivery. |\n| ↳--- `warehouseId` | `string` | The ID of the warehouse where the item is sourced from. |\n| ↳--- `dockId` | `string` | The ID of the shipping dock where the item will be dispatched. |\n| ↳--- `courierName` | `string` | The display name of the courier. |\n| ↳--- `quantity` | `number` | The number of items in the shipment for this delivery leg. |\n| ↳--- `kitItemDetails` | `array` | A list containing details for each component item if the product is a kit or bundle. |\n| ↳-- `shippingEstimate` | `string` | The estimated delivery time, usually in business days (e.g., '3bd'). |\n| ↳-- `shippingEstimateDate` | `string` | The specific date the shipment is estimated to be delivered. A `null` value indicates a date was not provided. |\n| ↳-- `lockTTL` | `string` | \"Time to Live\" for the shipping quote, indicating how long the price is guaranteed. |\n| ↳-- `availableDeliveryWindows` | `array` | A list of available time slots for scheduled delivery. An empty array indicates none are offered. |\n| ↳-- `deliveryWindow` | `string` | The specific delivery window selected by the customer from the available options. |\n| ↳--- `price` | `number` | The cost of this shipping method, in cents. |\n| ↳--- `listPrice` | `number` | The original price of the shipping method before any promotions, in cents. |\n| ↳--- `tax` | `number` | The tax amount applied to the shipping cost, in cents. |\n| ↳--- `pickupStoreInfo` | `object` | Information about the pickup point, if applicable for the SLA. |\n| ↳---- `isPickupStore` | `boolean` | A flag that is `true` if this SLA is for a pickup point. |\n| ↳---- `friendlyName` | `string` | The public or display name of the pickup store (e.g., \"Main Street Store\"). |\n| ↳---- `address` | `string` | An object containing the full address of the pickup location. |\n| ↳---- `additionalInfo` | `string` | Extra instructions for the pickup (e.g., \"Go to the 2nd floor customer service desk\"). |\n| ↳---- `dockId` | `string` | The identifier for the specific dock or area where packages are handled at the pickup location. |\n| ↳--- `pickupPointId` | `string` | The unique identifier for the pickup point. |\n| ↳--- `pickupDistance` | `number` | The distance from the shipping address to the pickup point, usually in kilometers. |\n| ↳--- `transitTime` | `string` | The estimated time the package will spend in transit. |\n| ↳-- `shipsTo` | `array` | A list of country codes that this item can be shipped to. |\n| ↳-- `itemId` | `string` | The ID of the item this logistics information refers to. |\n| ↳-- `deliveryChannels` | `array of objects` | A list of available delivery channels for the item. |\n| ↳--- `id` | `string` | The identifier for the delivery channel (e.g., 'delivery', 'pickup-in-point'). |\n| ↳-- `selectedAddresses` | `array of objects` | A list of the shipping addresses selected for the order. |\n| ↳--- `addressType` | `string` | The type of address, such as 'residential' or 'commercial'. |\n| ↳--- `receiverName` | `string` | The full name of the person designated to receive the shipment. |\n| ↳--- `addressId` | `string` | The unique identifier for this address in the system. |\n| ↳--- `isDisposable` | `boolean` | A flag indicating if the address is temporary and should not be saved to the user's profile. |\n| ↳--- `postalCode` | `string` | The postal or ZIP code for the address. |\n| ↳--- `city` | `string` | The city of the address. |\n| ↳--- `state` | `string` | The state or province abbreviation. |\n| ↳--- `country` | `string` | The three-letter ISO country code. |\n| ↳--- `street` | `string` | The name of the street. |\n| ↳--- `number` | `string` | The street number of the building or house. |\n| ↳--- `neighborhood` | `string` | The neighborhood or district. |\n| ↳--- `complement` | `string` | Additional address details, such as an apartment number or building name. |\n| ↳--- `reference` | `string` | A reference point or landmark to help locate the address. |\n| ↳--- `geoCoordinates` | `array` | A list containing the geographic coordinates \\[longitude, latitude\\] for the address. |\n| ↳-- `availableAddresses` | `array` | A list of all addresses saved to the customer's profile that are available for this shipment. |\n| ↳--- `addressType` | `string` | The type of address, such as 'residential' or 'commercial'. |\n| ↳--- `receiverName` | `string` | The full name of the person designated to receive shipments at this address. |\n| ↳--- `addressId` | `string` | The unique identifier for this address in the system. |\n| ↳--- `isDisposable` | `boolean` | A flag indicating if the address is temporary and was not saved to the user's profile. |\n| ↳--- `postalCode` | `string` | The postal or ZIP code for the address. |\n| ↳--- `city` | `string` | The city of the address. |\n| ↳--- `state` | `string` | The state or province abbreviation. |\n| ↳--- `country` | `string` | The three-letter ISO country code. |\n| ↳--- `street` | `string` | The name of the street. |\n| ↳--- `number` | `string` | The street number of the building or house. |\n| ↳--- `neighborhood` | `string` | The neighborhood or district. |\n| ↳--- `complement` | `string` | Additional address details, such as an apartment number or building name. |\n| ↳--- `reference` | `string` | A reference point or landmark to help locate the address. |\n| ↳--- `geoCoordinates` | `array` | A list containing the geographic coordinates \\[longitude, latitude\\] for the address. |\n| ↳-- `pickupPoints` | `array of objects` | A list of available pickup points (stores or lockers) for the current order. |\n| ↳--- `friendlyName` | `string` | The public display name of the pickup point location. |\n| ↳--- `address` | `object` | An object containing the full address of the pickup point. |\n| ↳---- `addressType` | `string` | The type of address, which is 'pickup' for these locations. |\n| ↳---- `receiverName` | `null` | The full name of the person designated to receive the shipment. It is often `null` for pickup point addresses. |\n| ↳---- `addressId` | `string` | The unique identifier for the pickup point's address. |\n| ↳---- `isDisposable` | `boolean` | Indicates if the address is temporary for this transaction. |\n| ↳---- `postalCode` | `string` | The postal code of the pickup point. |\n| ↳---- `city` | `string` | The city where the pickup point is located. |\n| ↳---- `state` | `string` | The state where the pickup point is located. |\n| ↳---- `country` | `string` | The country where the pickup point is located. |\n| ↳---- `street` | `string` | The street name of the pickup point. |\n| ↳---- `number` | `string` | The street number of the pickup point. |\n| ↳---- `neighborhood` | `string` | The neighborhood of the pickup point. |\n| ↳---- `geoCoordinates` | `array` | The geographic coordinates \\[longitude, latitude\\] of the pickup point. |\n| ↳--- `additionalInfo` | `string` | Extra instructions for the customer regarding pickup. |\n| ↳--- `id` | `string` | The unique identifier for the pickup point itself. |\n| ↳--- `isActive` | `null` | A flag to indicate if the pickup point is currently operational. |\n| ↳--- `businessHours` | `array of objects` | A list of objects defining the opening and closing times for each day of the week. |\n| ↳---- `DayOfWeek` | `number` | The day of the week, typically represented as a number (e.g., 0 for Sunday, 1 for Monday). |\n| ↳---- `OpeningTime` | `string` | The time the location opens on that day, in HH:MM:SS format. |\n| ↳---- `ClosingTime` | `string` | The time the location closes on that day, in HH:MM:SS format. |\n| ↳ `contactInformation` | `array` | A list of contact details, which is empty in this case. |\n| ↳ `paymentData` | `object` | An object containing all data related to the payment of the order. |\n| ↳-- `giftCards` | `array` | A list of gift cards used in the payment. |\n| ↳-- `transactions` | `array of objects` | A list of payment transactions made for the order. |\n| ↳--- `isActive` | `boolean` | A flag indicating if the transaction is currently active. |\n| ↳--- `transactionId` | `string` | The unique identifier for this payment transaction. |\n| ↳--- `merchantName` | `string` | The name of the merchant associated with this transaction. |\n| ↳--- `payments` | `array of objects` | A list of individual payments that make up the transaction. |\n| ↳---- `id` | `string` | The unique identifier for this specific payment attempt. |\n| ↳---- `paymentSystem` | `string` | The numeric ID of the payment method used (e.g., '47' for Cash). |\n| ↳---- `paymentSystemName` | `string` | The display name of the payment method used. |\n| ↳---- `value` | `number` | The monetary value of this payment, in cents. |\n| ↳---- `installments` | `number` | The number of installments for the payment. |\n| ↳---- `connectorResponses` | `object` | Contains raw responses from the payment gateway or connector. |\n| ↳---- `referenceValue` | `number` | The original or base value of the payment before any adjustments, in cents. |\n| ↳---- `cardHolder` | `string` | The name of the cardholder, if a credit/debit card was used. |\n| ↳---- `cardNumber` | `string` | The masked card number. |\n| ↳---- `firstDigits` | `string` | The first few digits (BIN) of the card number. |\n| ↳---- `lastDigits` | `string` | The last four digits of the card number. |\n| ↳---- `cvv2` | `string` | The Card Verification Value (security code). |\n| ↳---- `expireMonth` | `string` | The card's expiration month. |\n| ↳---- `expireYear` | `string` | The card's expiration year. |\n| ↳---- `url` | `string` | A URL for redirection, if required by the payment method (e.g., for 3D Secure). |\n| ↳---- `koinUrl` | `string` | A redirection URL for the Koin \"Buy Now, Pay Later\" payment service. |\n| ↳---- `tid` | `string` | The Transaction ID provided by the payment acquirer. |\n| ↳---- `redemptionCode` | `string` | The code entered by the customer to redeem a gift card or voucher for this payment. |\n| ↳---- `giftCardId` | `string` | The unique internal identifier for the gift card used in this payment. |\n| ↳---- `giftCardProvider` | `string` | The name of the company or service that issued the gift card. |\n| ↳---- `giftCardAsDiscount` | `string` | A flag indicating if the gift card's value was applied as a discount instead of a direct payment method. |\n| ↳---- `group` | `string` | A name used to group multiple payments together (e.g., 'creditCard', 'bankSlip'). |\n| ↳---- `dueDate` | `string` | The due date for the payment, relevant for invoices or bank slips. |\n| ↳---- `accountId` | `string` | The unique identifier for the customer's account with the payment provider. |\n| ↳---- `parentAccountId` | `string` | The identifier for a parent or master account, used in cases of sub-accounts or corporate accounts. |\n| ↳---- `bankIssuedInvoiceIdentificationNumber` | `string` | The identification number for a bank-issued invoice or slip. |\n| ↳---- `bankIssuedInvoiceBarCodeNumber` | `string` | The full barcode number for a bank slip. |\n| ↳---- `billingAddress` | `string` | An object containing the billing address associated with the payment. |\n| ↳---- `paymentOrigin` | `string` | Indicates the origin of the payment. |\n| ↳--- `sharedTransaction` | `boolean` | A flag indicating if this transaction is shared across multiple sellers. |\n| ↳ `clientPreferencesData` | `object` | Contains data about the client's preferences, such as opting in for newsletters. |\n| ↳ `commercialConditionData` | `null` | Data related to special commercial conditions or contracts for the customer. |\n| ↳ `giftRegistryData` | `null` | Contains information if the order is part of a gift registry or wish list. |\n| ↳ `marketingData` | `null` | Contains marketing-related data, such as UTM parameters, coupons, or campaign identifiers. |\n| ↳ `storePreferencesData` | `object` | Contains settings and preferences specific to the storefront, like currency and timezone. |\n| ↳- `countryCode` | `string` | The three-letter ISO code for the country the store operates in. |\n| ↳- `saveUserData` | `boolean` | A flag indicating if the user's data should be saved for future purchases. |\n| ↳- `timeZone` | `string` | The timezone of the store. |\n| ↳- `currencyCode` | `string` | The three-letter code for the store's currency (e.g., `BRL`). |\n| ↳- `currencyLocale` | `number` | The locale ID used for formatting the currency. |\n| ↳- `currencySymbol` | `string` | The symbol for the store's currency (e.g., `R$`). |\n| ↳- `currencyFormatInfo` | `object` | An object detailing how to format currency values for display. |\n| ↳-- `currencyDecimalDigits` | `number` | The number of digits to show after the decimal separator. |\n| ↳--- `currencyDecimalSeparator` | `string` | The character used as the decimal separator (e.g., `,`). |\n| ↳--- `currencyGroupSeparator` | `string` | The character used for separating groups of thousands (e.g., `.`). |\n| ↳--- `currencyGroupSize` | `number` | The number of digits in each group before a separator. |\n| ↳--- `startsWithCurrencySymbol` | `boolean` | A flag indicating if the currency symbol is placed before the value. |\n| ↳- `openTextField` | `string` | A field for the customer to add open-ended comments or observations about the order. |\n| ↳- `invoiceData` | `object` | Contains the necessary information for generating a fiscal invoice. |\n| ↳- `itemMetadata` | `object` | Contains additional backend metadata about the items in the cart. |\n| ↳-- `items` | `array of objects` | A list of metadata objects for each item in the cart. |\n| ↳--- `id` | `string` | The item's SKU ID. |\n| ↳--- `seller` | `string` | The unique identifier for the seller of the item. |\n| ↳--- `name` | `string` | The product name. |\n| ↳--- `skuName` | `string` | The name of the specific SKU. |\n| ↳--- `imageUrl` | `string` | The URL for the item's image. |\n| ↳--- `detailUrl` | `string` | The relative URL to the product's detail page. |\n| ↳--- `assemblyOptions` | `array` | A list of available assembly options, like subscriptions or customizations. |\n| ↳--- `id` | `string` | The unique ID for the assembly option. |\n| ↳--- `name` | `string` | The display name of the assembly option. |\n| ↳--- `required` | `boolean` | A flag indicating if selecting this option is mandatory. |\n| ↳--- `inputValues` | `object` | Defines the schema for the user's input for this option. |\n| ↳--- `composition` | `string` | Details about the components if this option adds items to the cart. |\n| ↳ `taxData` | `string` | Contains detailed tax information for the order, especially for B2B or international sales. |\n| ↳ `customData` | `object` | A field for custom applications to attach arbitrary data to the order form. |\n| ↳ `hooksData` | `object` | Contains data related to external hooks or integrations that have interacted with the order. |\n| ↳ `changeData` | `object` | Contains information about changes made to an order after it was placed. |\n| ↳ `subscriptionData` | `object` | Contains details if the order is part of a subscription, including frequency and renewal information. |\n| ↳ `merchantContextData` | `object` | Data provided by the merchant's external systems for context. |\n| ↳ `salesChannel` | `string` | The ID of the sales channel (or trade policy) through which the order was placed. |\n| ↳ `followUpEmail` | `string` | A unique email address used for post-purchase communication for this specific order. |\n| ↳ `creationDate` | `string` | The exact date and time the order was created, in UTC (Coordinated Universal Time). |\n| ↳ `lastChange` | `string` | The date and time of the last modification to the order, in UTC. |\n| ↳ `timeZoneCreationDate` | `string` | The creation date and time of the order, adjusted to the store's local timezone. |\n| ↳ `timeZoneLastChange` | `string` | The last modification date and time, adjusted to the store's local timezone. |\n| ↳ `isCompleted` | `boolean` | A flag that becomes `true` when the customer successfully completes the checkout process. |\n| ↳ `hostName` | `string` | The hostname of the store where the order was created. |\n| ↳ `merchantName` | `null` | The name of the merchant account. |\n| `userType` | `string` | The type of user who placed the order. An empty string usually means a regular customer. |\n| ↳ `roundingError` | `number` | Any rounding difference that occurred during total calculations, in cents. |\n| ↳ `allowEdition` | `boolean` | A flag indicating if the order can be edited after being placed. |\n| ↳ `allowCancellation` | `boolean` | A flag indicating if the order can be canceled. |\n| ↳ `isUserDataVisible` | `boolean` | A flag indicating if the user's personal data should be visible. |\n| ↳ `allowChangeSeller` | `boolean` | A flag indicating if the seller responsible for an item can be changed. |\n| ↳ `orderFormCreationDate` | `string` | The timestamp when the order form (the cart session) was initially created, in UTC. |\n| `allowMultipleDeliveries` | `boolean` | Flag indicating if the order can be shipped to multiple addresses. |" + }, + "response": [ + { + "name": "200 OK", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "VtexIdclientAutCookie_qastore", + "value": "{{authCookieValue}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": 2,\n \"quantity\": 2,\n \"seller\": \"1\",\n \"price\": 100,\n \"uniqueId\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n {\n \"id\": 8,\n \"quantity\": 1,\n \"seller\": \"1\",\n \"price\": 8500,\n \"uniqueId\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n }\n ],\n \"shippingData\": {{my_shippingData}},\n \"clientProfileData\": {{my_profileData}},\n \"paymentData\": {{my_paymentsDataString}},\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC2\",\n \"refId\": \"CC2\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"9b884ddc-2dbc-4443-8706-8c6a21dac219\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"home\"\n },\n \"fields\": [\n {\n \"name\": \"Desktop\",\n \"value\": \"DSK1\",\n \"refId\": \"b1d7a268-090a-4578-9bf9-22b4537851e8\"\n }\n ]\n }\n ]\n },\n \"openTextField\": {\n \"value\": \"ODP use cases\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/checkout/pub/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "checkout", + "pub", + "orders" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"orderForm\": null,\n \"transactionData\": {\n \"merchantTransactions\": [\n {\n \"id\": \"RECORRENCIACHARLIE\",\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"paymentSystem\": \"47\",\n \"bin\": null,\n \"accountId\": null,\n \"tokenId\": null,\n \"value\": 105547,\n \"referenceValue\": 105547,\n \"giftCardRedemptionCode\": null,\n \"giftCardProvider\": null,\n \"giftCardId\": null\n }\n ]\n }\n ],\n \"receiverUri\": \"https://recorrenciacharlie.vtexpayments.com.br/split/1560176581020/payments\",\n \"gatewayCallbackTemplatePath\": \"/checkout/gatewayCallback/1560176581020/{messageCode}\"\n },\n \"orders\": [\n {\n \"orderId\": \"1560176581020-01\",\n \"orderGroup\": \"1560176581020\",\n \"state\": null,\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560176581020-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 105547,\n \"items\": [\n {\n \"uniqueId\": \"ABBF87D61CB3441E97FC2527A93432AA\",\n \"id\": \"1\",\n \"productId\": \"1\",\n \"productRefId\": \"\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:52:36Z\",\n \"tax\": 0,\n \"price\": 765,\n \"listPrice\": 765,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 765,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 765,\n \"total\": 765,\n \"sellingPrices\": [\n {\n \"value\": 765,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"8BEAE818E2AE4474905B4BEF306A5E77\",\n \"id\": \"2\",\n \"productId\": \"2\",\n \"productRefId\": \"\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:54:16Z\",\n \"tax\": 0,\n \"price\": 4282,\n \"listPrice\": 4282,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 4282,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 4282,\n \"total\": 4282,\n \"sellingPrices\": [\n {\n \"value\": 4282,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"F3E0DA124887476DBB0F2C7DC0B6FE2A\",\n \"id\": \"3\",\n \"productId\": \"3\",\n \"productRefId\": \"\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:57:30Z\",\n \"tax\": 0,\n \"price\": 1000,\n \"listPrice\": 1000,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 1000,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 100,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 1000,\n \"total\": 100000,\n \"sellingPrices\": [\n {\n \"value\": 1000,\n \"quantity\": 100\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n }\n ],\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE\",\n \"logo\": \"\",\n \"minimumOrderValue\": 0\n }\n ],\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 105047\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": 0\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 500\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"userautomated24.608800099331596@mailinator.com\",\n \"firstName\": \"Postman\",\n \"lastName\": \"Test\",\n \"document\": \"20275756343\",\n \"documentType\": \"cpf\",\n \"phone\": \"+552222222222\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": false,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [],\n \"teaser\": []\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"1\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 1,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 5,\n \"listPrice\": 5,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"2\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 2,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 495,\n \"listPrice\": 495,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"3\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"pickupPoints\": [\n {\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"id\": \"1_VTEX-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_BPS-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_RIOSUL-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n }\n ],\n \"contactInformation\": []\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"id\": null,\n \"paymentSystem\": \"47\",\n \"paymentSystemName\": \"Cash\",\n \"value\": 105547,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 105547,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": null,\n \"dueDate\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentOrigin\": null\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": null,\n \"commercialConditionData\": null,\n \"giftRegistryData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"saveUserData\": false,\n \"timeZone\": \"E. South America Standard Time\",\n \"currencyCode\": \"BRL\",\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \",\",\n \"currencyGroupSeparator\": \".\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": null,\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"3\",\n \"seller\": \"1\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"productId\": \"3\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"assemblyOptions\": []\n },\n {\n \"id\": \"2\",\n \"seller\": \"1\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"productId\": \"2\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.plano-da-ana\",\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n },\n {\n \"id\": \"1\",\n \"seller\": \"1\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"productId\": \"1\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.teste-nico\",\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.plano-gold\",\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.portunus\",\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.basic\",\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n }\n ]\n },\n \"taxData\": null,\n \"customData\": null,\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"5bb299d7a91c487faece472daed48b46@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:57:30.7718345Z\",\n \"lastChange\": \"2025-09-08T16:57:32.3020624Z\",\n \"timeZoneCreationDate\": \"2025-09-08T13:57:30.7718345\",\n \"timeZoneLastChange\": \"2025-09-08T13:57:32.3020624\",\n \"isCompleted\": false,\n \"hostName\": \"recorrenciacharlie\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:57:30.5217933Z\"\n }\n ],\n \"allowMultipleDeliveries\": true\n}" + } + ] + }, + { + "name": "Get Order Cancellation Feedback", + "request": { + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{appKey}}" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{appToken}}" + } + ], + "url": { + "raw": "{{baseUrl}}/api/order-system/orders/{{orderId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "order-system", + "orders", + "{{orderId}}" + ] + }, + "description": "This endpoint retrieves the details in the `cancellationData` field of the order when a buying policy causes an automatic rejection of an order.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}/api/order-system/orders/{{orderId}}?an={{account}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `orderId` | `string` | Yes | Order identifier. |\n\n---\n\n### Response\n\n``` json\n{\n \"id\": \"b5a68673-4298-4412-8b41-626c247a2482\",\n \"orderId\": \"1540031666098-01\",\n \"workflowInstanceId\": \"65858b2e-5a80-4331-a2ac-6d36b6a8d642\",\n \"status\": \"accepted\",\n \"units\": [],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1540031666098-01/callback?an=recorrenciacharlie\",\n \"totalOrderValueDesiredBySeller\": 0.0,\n \"marketPlacePaymentValue\": 0.0,\n \"itemCollection\": [\n {\n \"id\": \"7f159283-3365-4e8d-ad73-1987c53996f5\",\n \"sku\": \"1\",\n \"price\": 7.65,\n \"totalSystemDiscount\": 0.0,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n },\n {\n \"id\": \"4110a466-c040-4a96-bce5-eff7ed0668e1\",\n \"sku\": \"2\",\n \"price\": 42.82,\n \"totalSystemDiscount\": 0.0,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n },\n {\n \"id\": \"95eb1ced-3493-499c-bebc-e656946707c4\",\n \"sku\": \"3\",\n \"price\": 10.0,\n \"totalSystemDiscount\": 0.0,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"e18ac822-9a2e-4357-be4c-c7a95892c9e2\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"3ad21b0b-597e-4871-9ce9-9862e67012e7\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - Dynamic Rule - vtexcommercebeta\",\n \"unitId\": null,\n \"status\": \"accepted\",\n \"score\": 100.0,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"6dcfddf7-e152-473f-bf8c-8e2c2da783bb\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"ignored\",\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Deny\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 100000\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Deny\",\n \"effectType\": 1,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n },\n {\n \"id\": \"7b5bfcc9-2441-4910-8312-8aa22227d91f\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"ignored\",\n \"doId\": null,\n \"priority\": 2,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Do Effect\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 50000\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Create Do Effect\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n },\n {\n \"id\": \"825896b7-4df0-4d5e-aec0-7e43bcb5451a\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"accepted\",\n \"doId\": null,\n \"score\": 100.0,\n \"authorizedEmails\": [],\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Approve\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 0\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Approve\",\n \"effectType\": 0,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-05-21T20:35:22.8943023Z\",\n \"creationVersion\": \"2.0.10-beta.1\",\n \"creationEnvironment\": \"beta\"\n },\n {\n \"id\": \"f2dcc0e0-ee6e-4537-921b-8c63a7ad41fd\",\n \"name\": \"Dimension Monitoring - Dimension with Unit - vtexcommercebeta\",\n \"unitId\": \"1\",\n \"status\": \"accepted\",\n \"score\": 100.0,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"2de4445c-a801-4d0d-b311-490868323eae\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"ignored\",\n \"doId\": null,\n \"authorizedEmails\": [],\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Deny\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 100000\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Deny\",\n \"effectType\": 1,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-11T17:53:49.2675344Z\",\n \"creationVersion\": \"2.0.17-beta\",\n \"creationEnvironment\": \"beta\"\n }\n ],\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the order authorization. |\n| `orderId` | `string` | Order identifier in the commerce platform. |\n| `workflowInstanceId` | `string` | Workflow execution instance identifier. |\n| `status` | `string` | Final status of the evaluation (e.g., `accepted`, `denied`). |\n| `units` | `array` | Units involved in the decision, if applicable. |\n| `callbackEndpoint` | `string` | URL for the system to notify the evaluation result. |\n| `totalOrderValueDesiredBySeller` | `number` | Total order value expected by the seller. |\n| `marketPlacePaymentValue` | `number` | Payment value processed by the marketplace. |\n| `itemCollection` | `array of objects` | List of items evaluated in the order. |\n| `itemCollection[].id` | `string` | Unique identifier of the item. |\n| `itemCollection[].sku` | `string` | SKU identifier. |\n| `itemCollection[].price` | `number` | Price of the item. |\n| `itemCollection[].totalSystemDiscount` | `number` | Discount applied by the system. |\n| `itemCollection[].totalManualDiscount` | `number` | Discount manually applied. |\n| `itemCollection[].quantity` | `number` | Quantity of the item. |\n| `itemCollection[].additionalInfo.commercialCondition` | `string` | Commercial condition identifier. |\n| `additionalInfo.userProfileId` | `string` | Identifier of the user profile associated with the order. |\n| `dimensionStatus` | `array of objects` | List of evaluated dimensions with respective results. |\n| `dimensionStatus[].id` | `string` | Unique identifier of the dimension. |\n| `dimensionStatus[].name` | `string` | Name of the dimension. |\n| `dimensionStatus[].unitId` | `string` | Organizational unit associated, if applicable. |\n| `dimensionStatus[].status` | `string` | Result of the dimension evaluation (`accepted`, `denied`, etc.). |\n| `dimensionStatus[].score` | `number` | Final score of the evaluation. |\n| `dimensionStatus[].priority` | `number` | Priority of the dimension. |\n| `dimensionStatus[].shouldSimulate` | `boolean` | Whether the dimension was simulated. |\n| `dimensionStatus[].ruleCollection` | `array of objects` | Rules evaluated within the dimension. |\n| `dimensionStatus[].creationDate` | `string` | ISO timestamp when the dimension was created. |\n| `dimensionStatus[].creationVersion` | `string` | System version when the dimension was created. |\n| `dimensionStatus[].creationEnvironment` | `string` | Environment of origin (`beta`, `stable`, etc.). |\n| `creationVersion` | `string` | Version of the authorization system. |\n| `creationEnvironment` | `string` | Execution environment (`stable`, `beta`, etc.). |" + }, + "response": [] + }, + { + "name": "Send Order Payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{{my_payload}}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.vtexpayments.com.br/api/pub/transactions/{{my_transactionId}}/payments", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexpayments", + "com", + "br" + ], + "path": [ + "api", + "pub", + "transactions", + "{{my_transactionId}}", + "payments" + ] + }, + "description": "This endpoint process an orders payment.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{account}}.vtexpayments.com.br/api/pub/transactions/{{my_transactionId}}/payments`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Parameters\n\n| Parameters | Type | Required | Description |\n| --- | --- | --- | --- |\n| my_transactionId | `string` | Yes | Order transaction identifier. |\n\n---\n\n### Request Body\n\n``` json\n{{my_payload}}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| paymentData | `object` | Yes | Payment information. |\n\n\n### Response body\n\n``` json\n{\n \"id\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"referenceKey\": \"656517\",\n \"interactions\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/interactions\"\n },\n \"settlements\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/settlements\"\n },\n \"payments\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/payments\"\n },\n \"refunds\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/refunds\"\n },\n \"cancellations\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/cancellations\"\n },\n \"capabilities\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/capabilities\"\n },\n \"timeoutStatus\": 1,\n \"totalRefunds\": 0.0,\n \"status\": \"Finished\",\n \"value\": 3159,\n \"receiverUri\": null,\n \"startDate\": \"2025-09-08T16:46:44\",\n \"authorizationToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"authorizationDate\": \"2025-09-08T16:46:45\",\n \"commitmentToken\": \"3372C829621C4004B94B180C4FA4577E\",\n \"commitmentDate\": \"2025-09-08T16:46:57\",\n \"refundingToken\": null,\n \"refundingDate\": null,\n \"cancelationToken\": null,\n \"cancelationDate\": null,\n \"fields\": [\n {\n \"name\": \"owner\",\n \"value\": \"vtex-service::checkout::stable\"\n },\n {\n \"name\": \"conditions\",\n \"value\": \"[{\\\"id\\\":\\\"1\\\",\\\"value\\\":33.99}]\"\n },\n {\n \"name\": \"postbackStatusUrl\",\n \"value\": \"https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1560170656517/notifications/transaction-status?an=b2bfaststoredev\"\n },\n {\n \"name\": \"currencyCode\",\n \"value\": \"USD\"\n },\n {\n \"name\": \"shopperInteraction\",\n \"value\": \"ecommerce\"\n },\n {\n \"name\": \"lastTransitionDate\",\n \"value\": \"9/8/2025 4:46:56 PM\"\n },\n {\n \"name\": \"TotalTimeSpentInTransitionsUntilThisTransition\",\n \"value\": \"16667.4862\"\n },\n {\n \"name\": \"channel\",\n \"value\": \"B2BFASTSTOREDEV\"\n },\n {\n \"name\": \"salesChannel\",\n \"value\": \"1\"\n },\n {\n \"name\": \"orderGroup\",\n \"value\": \"1560170656517\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"parentMerchant\",\n \"value\": \"13cfb648-f0a2-4e8f-818e-e3e9c7538b0d\"\n },\n {\n \"name\": \"orderId\",\n \"value\": \"2C4BF3F0A5C34B20A229AAC8262732CE\"\n },\n {\n \"name\": \"ip\",\n \"value\": \"3.229.80.75\"\n },\n {\n \"name\": \"userAgent\",\n \"value\": \"PostmanRuntime/7.39.0\"\n },\n {\n \"name\": \"acceptHeader\",\n \"value\": \"*/*\"\n },\n {\n \"name\": \"cart\",\n \"value\": \"{\\\"items\\\":[{\\\"id\\\":\\\"88\\\",\\\"name\\\":\\\"Combination Spanner Set Storage\\\",\\\"value\\\":3399,\\\"quantity\\\":1,\\\"priceTags\\\":[{\\\"name\\\":\\\"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\\\",\\\"value\\\":-3.40,\\\"isPercentual\\\":false}],\\\"components\\\":null,\\\"commission\\\":0.0,\\\"freightCommission\\\":0.0,\\\"sellerChain\\\":null,\\\"shippingDiscount\\\":0,\\\"discount\\\":-340,\\\"refId\\\":\\\"88\\\",\\\"productId\\\":\\\"56\\\",\\\"sellingPrice\\\":30.59,\\\"sellerId\\\":\\\"1\\\",\\\"dockId\\\":\\\"1\\\",\\\"categoryId\\\":\\\"1\\\",\\\"categoryName\\\":\\\"Category\\\",\\\"deliveryChannel\\\":\\\"delivery\\\",\\\"deliveryType\\\":\\\"Entrega Soberana\\\",\\\"deliverySlaInMinutes\\\":1440,\\\"deliveryWindow\\\":null,\\\"tax\\\":0,\\\"freight\\\":100}],\\\"sellers\\\":[{\\\"id\\\":\\\"1\\\",\\\"name\\\":\\\"VTEX\\\",\\\"documentType\\\":\\\"CNPJ\\\",\\\"document\\\":null}],\\\"freight\\\":100,\\\"shippingdate\\\":null,\\\"shippingestimated\\\":\\\"1bd\\\",\\\"orderUrl\\\":\\\"http://b2bfaststoredev.vtexcommercestable.com.br/admin/checkout/#/orders?q=1560170656517\\\",\\\"tax\\\":0,\\\"isGiftRegistry\\\":null,\\\"giftRegistryDescription\\\":null,\\\"giftRegistryId\\\":null,\\\"isPickupStore\\\":null,\\\"isCallCenter\\\":null}\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"postPurchaseOperationMode\",\n \"value\": \"Total\"\n },\n {\n \"name\": \"retainPartialSettlements\",\n \"value\": \"False\"\n },\n {\n \"name\": \"nativeSplitEnabled\",\n \"value\": \"False\"\n },\n {\n \"name\": \"clientProfileData\",\n \"value\": \"{\\\"email\\\":null,\\\"firstName\\\":\\\"Frederic\\\",\\\"lastName\\\":\\\"Kessler\\\",\\\"document\\\":\\\"22736794/000199\\\",\\\"phone\\\":\\\"3834600495\\\",\\\"corporateName\\\":null,\\\"tradeName\\\":null,\\\"corporateDocument\\\":null,\\\"stateInscription\\\":null,\\\"postalCode\\\":\\\"22250-040\\\",\\\"address\\\":{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null},\\\"gender\\\":null,\\\"birthDate\\\":null,\\\"createdDate\\\":\\\"2025-08-19T12:55:37.8475373Z\\\",\\\"corporatePhone\\\":null,\\\"isCorporate\\\":false,\\\"documentType\\\":\\\"CNPJ\\\",\\\"id\\\":\\\"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\\\"}\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"shopperInteraction\": \"ecommerce\",\n \"ipAddress\": \"3.229.80.75\",\n \"sessionId\": null,\n \"macId\": null,\n \"vtexFingerprint\": null,\n \"chargeback\": null,\n \"whiteSignature\": null,\n \"owner\": \"vtex-service::checkout::stable\",\n \"orderId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"userAgent\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"acceptHeader\": \"*/*\",\n \"antifraudTid\": null,\n \"antifraudResponse\": null,\n \"antifraudReference\": null,\n \"antifraudAffiliationId\": null,\n \"channel\": \"B2BFASTSTOREDEV\",\n \"salesChannel\": \"1\",\n \"urn\": null,\n \"softDescriptor\": null,\n \"markedForRecurrence\": false,\n \"buyer\": null\n}\n ```\n\n\n| Field | Type | Description |\n| :--- | :--- | :--- |\n| `id` | `string` | The unique identifier for the transaction object itself. |\n| `transactionId` | `string` | The primary identifier for the payment transaction. |\n| `referenceKey` | `string` | An external reference key, often from an Order Management System (OMS). |\n| `interactions` | `object` | Contains the API endpoint for transaction interactions. |\n| ↳--- `href` | `string` | The relative URL to access the interaction details. |\n| `settlements` | `object` | Contains the API endpoint for transaction settlements. |\n| `payments` | `object` | Contains the API endpoint for the payments within the transaction. |\n| `refunds` | `object` | Contains the API endpoint for refunds associated with the transaction. |\n| `cancellations` | `object` | Contains the API endpoint for cancellations. |\n| `capabilities` | `object` | Contains the API endpoint to view available transaction capabilities. |\n| `timeoutStatus` | `number` | A status code indicating if the transaction is timed out. |\n| `totalRefunds` | `number` | The total value that has been refunded for this transaction. |\n| `status` | `string` | The current status of the transaction (e.g., 'Finished', 'Authorized'). |\n| `value` | `number` | The total value of the transaction, in cents. |\n| `receiverUri` | `null` | The endpoint URL for the payment receiver. |\n| `startDate` | `string` | The timestamp when the transaction was initiated. |\n| `authorizationToken` | `string` | A token received from the payment gateway upon successful authorization. |\n| `authorizationDate` | `string` | The timestamp when the payment was authorized. |\n| `commitmentToken` | `string` | A token confirming the commitment or capture of the funds. |\n| `commitmentDate` | `string` | The timestamp when the funds were committed or captured. |\n| `fields` | `array` | A list of key-value pairs containing miscellaneous data about the transaction. |\n| ↳- `name` | `string` | The name of the data field (e.g., 'currencyCode', 'cart', 'clientProfileData'). |\n| ↳- `value` | `string` | The value of the data field. |\n| `currencyCode` | `string` | The three-letter ISO currency code for the transaction (e.g., `USD`). |\n| `shopperInteraction` | `string` | The type of interaction through which the transaction was made. |\n| `ipAddress` | `string` | The IP address of the shopper at the time of the transaction. |\n| `owner` | `string` | The service or application that created the transaction. |\n| `orderId` | `string` | The identifier for the order associated with this transaction. |\n| `userAgent` | `string` | The user agent string of the shopper's browser or client. |\n| `acceptHeader` | `string` | The Accept header from the shopper's HTTP request. |\n| `channel` | `string` | The name of the store or channel where the transaction occurred. |\n| `salesChannel` | `string` | The ID of the sales channel (trade policy) used for the transaction. |\n| `softDescriptor` | `null` | The text that appears on the customer's credit card statement. |\n| `markedForRecurrence` | `boolean` | A flag indicating if this transaction is part of a recurring payment schedule. |\n| `buyer` | `object` | An object containing information about the buyer. |" + }, + "response": [ + { + "name": "200 OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{{my_payload}}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.vtexpayments.com.br/api/pub/transactions/{{my_transactionId}}/payments", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexpayments", + "com", + "br" + ], + "path": [ + "api", + "pub", + "transactions", + "{{my_transactionId}}", + "payments" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"id\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"referenceKey\": \"656517\",\n \"interactions\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/interactions\"\n },\n \"settlements\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/settlements\"\n },\n \"payments\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/payments\"\n },\n \"refunds\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/refunds\"\n },\n \"cancellations\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/cancellations\"\n },\n \"capabilities\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/capabilities\"\n },\n \"timeoutStatus\": 1,\n \"totalRefunds\": 0,\n \"status\": \"Finished\",\n \"value\": 3159,\n \"receiverUri\": null,\n \"startDate\": \"2025-09-08T16:46:44\",\n \"authorizationToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"authorizationDate\": \"2025-09-08T16:46:45\",\n \"commitmentToken\": \"3372C829621C4004B94B180C4FA4577E\",\n \"commitmentDate\": \"2025-09-08T16:46:57\",\n \"refundingToken\": null,\n \"refundingDate\": null,\n \"cancelationToken\": null,\n \"cancelationDate\": null,\n \"fields\": [\n {\n \"name\": \"owner\",\n \"value\": \"vtex-service::checkout::stable\"\n },\n {\n \"name\": \"conditions\",\n \"value\": \"[{\\\"id\\\":\\\"1\\\",\\\"value\\\":33.99}]\"\n },\n {\n \"name\": \"postbackStatusUrl\",\n \"value\": \"https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1560170656517/notifications/transaction-status?an=b2bfaststoredev\"\n },\n {\n \"name\": \"currencyCode\",\n \"value\": \"USD\"\n },\n {\n \"name\": \"shopperInteraction\",\n \"value\": \"ecommerce\"\n },\n {\n \"name\": \"lastTransitionDate\",\n \"value\": \"9/8/2025 4:46:56 PM\"\n },\n {\n \"name\": \"TotalTimeSpentInTransitionsUntilThisTransition\",\n \"value\": \"16667.4862\"\n },\n {\n \"name\": \"channel\",\n \"value\": \"B2BFASTSTOREDEV\"\n },\n {\n \"name\": \"salesChannel\",\n \"value\": \"1\"\n },\n {\n \"name\": \"orderGroup\",\n \"value\": \"1560170656517\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"parentMerchant\",\n \"value\": \"13cfb648-f0a2-4e8f-818e-e3e9c7538b0d\"\n },\n {\n \"name\": \"orderId\",\n \"value\": \"2C4BF3F0A5C34B20A229AAC8262732CE\"\n },\n {\n \"name\": \"ip\",\n \"value\": \"3.229.80.75\"\n },\n {\n \"name\": \"userAgent\",\n \"value\": \"PostmanRuntime/7.39.0\"\n },\n {\n \"name\": \"acceptHeader\",\n \"value\": \"*/*\"\n },\n {\n \"name\": \"cart\",\n \"value\": \"{\\\"items\\\":[{\\\"id\\\":\\\"88\\\",\\\"name\\\":\\\"Combination Spanner Set Storage\\\",\\\"value\\\":3399,\\\"quantity\\\":1,\\\"priceTags\\\":[{\\\"name\\\":\\\"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\\\",\\\"value\\\":-3.40,\\\"isPercentual\\\":false}],\\\"components\\\":null,\\\"commission\\\":0.0,\\\"freightCommission\\\":0.0,\\\"sellerChain\\\":null,\\\"shippingDiscount\\\":0,\\\"discount\\\":-340,\\\"refId\\\":\\\"88\\\",\\\"productId\\\":\\\"56\\\",\\\"sellingPrice\\\":30.59,\\\"sellerId\\\":\\\"1\\\",\\\"dockId\\\":\\\"1\\\",\\\"categoryId\\\":\\\"1\\\",\\\"categoryName\\\":\\\"Category\\\",\\\"deliveryChannel\\\":\\\"delivery\\\",\\\"deliveryType\\\":\\\"Entrega Soberana\\\",\\\"deliverySlaInMinutes\\\":1440,\\\"deliveryWindow\\\":null,\\\"tax\\\":0,\\\"freight\\\":100}],\\\"sellers\\\":[{\\\"id\\\":\\\"1\\\",\\\"name\\\":\\\"VTEX\\\",\\\"documentType\\\":\\\"CNPJ\\\",\\\"document\\\":null}],\\\"freight\\\":100,\\\"shippingdate\\\":null,\\\"shippingestimated\\\":\\\"1bd\\\",\\\"orderUrl\\\":\\\"http://b2bfaststoredev.vtexcommercestable.com.br/admin/checkout/#/orders?q=1560170656517\\\",\\\"tax\\\":0,\\\"isGiftRegistry\\\":null,\\\"giftRegistryDescription\\\":null,\\\"giftRegistryId\\\":null,\\\"isPickupStore\\\":null,\\\"isCallCenter\\\":null}\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"postPurchaseOperationMode\",\n \"value\": \"Total\"\n },\n {\n \"name\": \"retainPartialSettlements\",\n \"value\": \"False\"\n },\n {\n \"name\": \"nativeSplitEnabled\",\n \"value\": \"False\"\n },\n {\n \"name\": \"clientProfileData\",\n \"value\": \"{\\\"email\\\":null,\\\"firstName\\\":\\\"Frederic\\\",\\\"lastName\\\":\\\"Kessler\\\",\\\"document\\\":\\\"22736794/000199\\\",\\\"phone\\\":\\\"3834600495\\\",\\\"corporateName\\\":null,\\\"tradeName\\\":null,\\\"corporateDocument\\\":null,\\\"stateInscription\\\":null,\\\"postalCode\\\":\\\"22250-040\\\",\\\"address\\\":{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null},\\\"gender\\\":null,\\\"birthDate\\\":null,\\\"createdDate\\\":\\\"2025-08-19T12:55:37.8475373Z\\\",\\\"corporatePhone\\\":null,\\\"isCorporate\\\":false,\\\"documentType\\\":\\\"CNPJ\\\",\\\"id\\\":\\\"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\\\"}\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"shopperInteraction\": \"ecommerce\",\n \"ipAddress\": \"3.229.80.75\",\n \"sessionId\": null,\n \"macId\": null,\n \"vtexFingerprint\": null,\n \"chargeback\": null,\n \"whiteSignature\": null,\n \"owner\": \"vtex-service::checkout::stable\",\n \"orderId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"userAgent\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"acceptHeader\": \"*/*\",\n \"antifraudTid\": null,\n \"antifraudResponse\": null,\n \"antifraudReference\": null,\n \"antifraudAffiliationId\": null,\n \"channel\": \"B2BFASTSTOREDEV\",\n \"salesChannel\": \"1\",\n \"urn\": null,\n \"softDescriptor\": null,\n \"markedForRecurrence\": false,\n \"buyer\": null\n}" + } + ] + }, + { + "name": "Get Order Group", + "request": { + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/order-system/orders/order-group/{{my_orderGroup}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "order-system", + "orders", + "order-group", + "{{my_orderGroup}}" + ] + }, + "description": "This endpoint retrieves the details of an order group.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/order-system/orders/order-group/{{my_orderGroup}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `my_orderGroup` | `string` | Yes | Order group identifier. |\n\n---\n\n### Response body\n\n``` json\n[\n {\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"VTEX\",\n \"logo\": \"\",\n \"subSellerId\": \"1\",\n \"fulfillmentEndpoint\": \"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=b2bfaststoredev\"\n }\n ],\n \"receiptData\": {\n \"ReceiptCollection\": [\n {\n \"ReceiptType\": \"authorizePayment\",\n \"Date\": \"2025-09-08T16:46:45.3342331Z\",\n \"ReceiptToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": null\n },\n {\n \"ReceiptType\": \"settlePayment\",\n \"Date\": \"2025-09-08T16:46:56.8172171Z\",\n \"ReceiptToken\": \"4C45295FB5184611B88A3EE754C988EA\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017115Z\",\n \"ReceiptToken\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017154Z\",\n \"ReceiptToken\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n }\n ]\n },\n \"sequence\": \"656517\",\n \"marketPlaceOrderId\": \"\",\n \"origin\": 0,\n \"items\": [\n {\n \"sellerSku\": \"88\",\n \"priceTable\": null,\n \"priceValidUntil\": \"2026-09-08T16:46:40Z\",\n \"callCenterOperator\": null,\n \"commission\": 0,\n \"freightCommission\": 0,\n \"taxCode\": \"1\",\n \"catalogProvider\": \"vrn:vtex.catalog-api-proxy:-:b2bfaststoredev:master:/proxy/authenticated/catalog/pvt/sku/stockkeepingunitbyid/88\",\n \"bundleItems\": [],\n \"components\": [],\n \"costPrice\": null,\n \"lockId\": null,\n \"uniqueId\": \"E0C828E7E81E4466AE92C1CBA6D872E0\",\n \"id\": \"88\",\n \"productId\": \"56\",\n \"productRefId\": \"88\",\n \"refId\": \"88\",\n \"ean\": null,\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"tax\": 0,\n \"customTax\": 0,\n \"price\": 3399,\n \"listPrice\": 3399,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 3059,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": {\n \"cubicweight\": 1.0,\n \"height\": 10.0,\n \"length\": 10.0,\n \"weight\": 10.0,\n \"width\": 10.0\n },\n \"brandName\": \"Precision Pro\",\n \"brandId\": \"2000001\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null,\n \"categoriesIds\": \"/1/\",\n \"productClusterId\": \"137\",\n \"commercialConditionId\": \"1\"\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Category\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [\n {\n \"name\": \"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\",\n \"value\": -340,\n \"rawValue\": -3.40,\n \"isPercentual\": false,\n \"identifier\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"owner\": \"b2bfaststoredev\"\n }\n ],\n \"availability\": \"available\",\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 3059,\n \"total\": 3059,\n \"sellingPrices\": [\n {\n \"value\": 3059,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n }\n }\n ],\n \"giftRegistryData\": null,\n \"contextData\": {\n \"loggedIn\": false,\n \"hasAccessToOrderFormEnabledByLicenseManager\": false,\n \"userAgent\": \"PostmanRuntime/7.39.0\",\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"recaptchaScore\": null\n },\n \"marketPlaceOrderGroup\": null,\n \"marketplaceServicesEndpoint\": null,\n \"orderFormId\": \"2a7b348c-e023-4613-ac02-d3575deab1a1\",\n \"affiliateId\": \"\",\n \"status\": \"\",\n \"callCenterOperator\": \"\",\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"creationVersion\": \"2.346.5.0\",\n \"creationEnvironment\": \"STABLE\",\n \"lastChangeVersion\": \"1.169.2.0\",\n \"workflowInstanceId\": \"c75c182e-eb4a-49e4-ad34-bbd38095f18c\",\n \"workflowInstanceGroupId\": null,\n \"marketplacePaymentValue\": null,\n \"marketplacePaymentReferenceValue\": null,\n \"marketplace\": null,\n \"orderId\": \"1560170656517-01\",\n \"orderGroup\": \"1560170656517\",\n \"state\": \"invoiced\",\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560170656517-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 3159,\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 3399\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": -340\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 100\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"johnson.kozey@yahoo.com\",\n \"firstName\": \"Frederic\",\n \"lastName\": \"Kessler\",\n \"document\": \"22736794/000199\",\n \"documentType\": \"CNPJ\",\n \"phone\": \"3834600495\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": true,\n \"profileErrorOnLoading\": false,\n \"customerClass\": null,\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"isProspect\": false\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [\n {\n \"id\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"name\": \"Pagamento a vista\",\n \"featured\": false,\n \"description\": null,\n \"matchedParameters\": {\n \"product@CatalogSystem\": \"54|exclusive\",\n \"paymentMethodId\": \"17\"\n },\n \"additionalInfo\": null\n }\n ]\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Entrega Soberana\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"slas\": [\n {\n \"id\": \"Entrega Soberana\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Entrega Soberana\",\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"shippingEstimate\": \"1bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 100,\n \"listPrice\": 100,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\"\n }\n ],\n \"shipsTo\": [\n \"USA\",\n \"BRA\"\n ],\n \"itemId\": \"88\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ],\n \"price\": 100,\n \"listPrice\": 100,\n \"shippingEstimate\": \"1bd\",\n \"dockEstimate\": \"0bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"deliveryCompany\": null,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\",\n \"sellingPrice\": 100,\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"deliveryWindow\": null,\n \"pickupPointId\": null,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupDistance\": null\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"trackingHints\": [],\n \"pickupPoints\": [],\n \"contactInformation\": [\n {\n \"id\": \"3b93a926fea84c62ae309882a03e909b\",\n \"firstName\": \"Marla\",\n \"lastName\": \"Singer\"\n },\n {\n \"id\": \"fdace46db89346dc8493aa693a5962dc\",\n \"firstName\": \"Robert\",\n \"lastName\": \"Paulson\"\n }\n ],\n \"contactsInfo\": [\n {\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"contacts\": [\n \"fdace46db89346dc8493aa693a5962dc\",\n \"3b93a926fea84c62ae309882a03e909b\"\n ],\n \"receiveWindows\": []\n }\n ],\n \"isFOB\": null\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"merchantName\": \"B2BFASTSTOREDEV\",\n \"payments\": [\n {\n \"id\": \"4CB7873069554734969679E47505DD43\",\n \"paymentSystem\": \"17\",\n \"paymentSystemName\": \"Promissory\",\n \"value\": 3159,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 3159,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": \"promissory\",\n \"dueDate\": null,\n \"paymentOrigin\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentDetails\": []\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": {\n \"locale\": \"pt-BR\",\n \"optinNewsLetter\": false,\n \"savePersonalData\": false,\n \"savePaymentData\": false\n },\n \"commercialConditionData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"USA\",\n \"timeZone\": \"Eastern Standard Time\",\n \"currencyCode\": \"USD\",\n \"currencyLocale\": 1033,\n \"currencySymbol\": \"$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \".\",\n \"currencyGroupSeparator\": \",\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": {\n \"address\": null,\n \"settleInvoices\": [\n \"1757350014\"\n ],\n \"invoices\": {\n \"1757350014\": {\n \"type\": \"Output\",\n \"invoiceNumber\": \"1757350014\"\n }\n }\n },\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"88\",\n \"seller\": \"1\",\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"productId\": \"56\",\n \"refId\": \"88\",\n \"ean\": null,\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"assemblyOptions\": []\n }\n ]\n },\n \"taxData\": null,\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"order\",\n \"id\": null\n },\n \"fields\": [\n {\n \"name\": \"poNumber\",\n \"value\": \"PO1\",\n \"refId\": \"PO1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"E0C828E7E81E4466AE92C1CBA6D872E0\"\n },\n \"fields\": [\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n }\n ]\n },\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"purchaseAgentData\": {\n \"purchaseAgents\": [\n {\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"versionId\": \"\",\n \"persona\": \"BUYER\",\n \"unitId\": \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\"\n }\n ]\n },\n \"budgetData\": {\n \"unitAllocations\": {\n \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\": [\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c3d4-966b-7519-8cdc-0867f99581c4\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -410354\n }\n },\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c267-1c3c-70ef-9fdf-5572fd08e70e\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -415282\n }\n }\n ]\n }\n },\n \"authorizationPolicyData\": {\n \"status\": \"accepted\",\n \"deniedPolicies\": [],\n \"pendingPolicies\": []\n },\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"9e2d3530482e49f8bd0e8e9d97ee2f36@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:46:42.0195859Z\",\n \"lastChange\": \"2025-09-08T16:46:58.1025748Z\",\n \"timeZoneCreationDate\": \"2025-09-08T12:46:42.0195859\",\n \"timeZoneLastChange\": \"2025-09-08T12:46:58.1025748\",\n \"isCompleted\": true,\n \"hostName\": \"b2bfaststoredev\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:46:40.1383799Z\",\n \"marketplaceRequestedCancellationWindow\": null\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `sellers`| `array` | Sellers linked to the order.||| ↳ `sellers[]` | `object` | A seller entry. | |\n| ↳ ↳ `sellers[].id` | `string` | Seller identifier. | |\n| ↳ ↳ `sellers[].name` | `string` | Seller display name. | |\n| ↳ ↳ `sellers[].logo` | `string` | URL for seller logo (may be empty). | |\n| ↳ ↳ `sellers[].subSellerId` | `string` | Sub‑seller identifier (if applicable). | |\n| ↳ ↳ `sellers[].fulfillmentEndpoint` | `string` | Fulfillment API endpoint URL. | |\n| `receiptData` | `object` | Receipts related to payment lifecycle. | |\n| ↳ `receiptData.ReceiptCollection` | `array` | Collection of receipt entries. | |\n| ↳ ↳ `receiptData.ReceiptCollection[]` | `object` | A receipt event. | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].ReceiptType` | `string` | Receipt type (e.g., `authorizePayment`, `settlePayment`, `budgetConfirmation`). | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].Date` | `string` | Event timestamp (UTC). | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].ReceiptToken` | `string` | Unique receipt token/ID. | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].Source` | `string` | Source of the receipt event. | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].InvoiceNumber` | `string` | Related invoice number, if any. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].TransactionId` | `string` | Related transaction ID. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].MerchantName` | `string ` | Merchant name, if present. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].SellerOrderId` | `string` | Seller order ID, if present. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].ValueAsInt` | `number` | Value associated with the event (cents). |\n| `sequence` | `string` | Order sequence number. | |\n| `marketPlaceOrderId` | `string` | Marketplace order ID (may be empty). | |\n| `origin` | `number` | Origin code for the order. | |\n| `items` | `array` | Line items in the order. | |\n| ↳ `items[]` | `object` | An item (SKU) in the order. | |\n| ↳ ↳ `items[].sellerSku` | `string` | Seller’s SKU code. | |\n| ↳ ↳ `items[].priceTable` | `string ` | Price table identifier, if used. |\n| ↳ ↳ `items[].priceValidUntil` | `string` | Price validity timestamp (UTC). | |\n| ↳ ↳ `items[].callCenterOperator` | `string` | Operator who applied changes, if any. |\n| ↳ ↳ `items[].commission` | `number` | Commission amount (cents). | |\n| ↳ ↳ `items[].freightCommission` | `number` | Freight commission amount (cents). | |\n| ↳ ↳ `items[].taxCode` | `string` | Tax code for the item. | |\n| ↳ ↳ `items[].catalogProvider` | `string` | Catalog provider reference (URN/URL). | |\n| ↳ ↳ `items[].bundleItems` | `array` | Bundle components (if SKU is a bundle). | |\n| ↳ ↳ `items[].components` | `array` | Assembly components (if applicable). | |\n| ↳ ↳ `items[].costPrice` | `number` | Cost price (cents), if known. |\n| ↳ ↳ `items[].lockId` | `string` | Lock identifier for pricing/availability. |\n| ↳ ↳ `items[].uniqueId` | `string` | Unique identifier for this line item. | |\n| ↳ ↳ `items[].id` | `string` | SKU ID. | |\n| ↳ ↳ `items[].productId` | `string` | Product ID. | |\n| ↳ ↳ `items[].productRefId` | `string` | Product reference code. | |\n| ↳ ↳ `items[].refId` | `string` | SKU reference code. | |\n| ↳ ↳ `items[].ean` | `string` | EAN barcode, if any. |\n| ↳ ↳ `items[].name` | `string` | Product name. | |\n| ↳ ↳ `items[].skuName` | `string` | SKU name/variant. | |\n| ↳ ↳ `items[].modalType` | `string ` | Presentation/modal type, if any. |\n| ↳ ↳ `items[].parentItemIndex` | `number` | Parent line index (if child of a kit). |\n| ↳ ↳ `items[].parentAssemblyBinding` | `string` | Parent assembly binding, if any. |\n| ↳ ↳ `items[].assemblies` | `array` | Assembly selections. | |\n| ↳ ↳ `items[].tax` | `number` | Tax amount (cents) for the item. | |\n| ↳ ↳ `items[].customTax` | `number` | Additional/custom tax (cents). | |\n| ↳ ↳ `items[].price` | `number` | Base price (cents). | |\n| ↳ ↳ `items[].listPrice` | `number` | List price (cents). | |\n| ↳ ↳ `items[].manualPrice` | `number` | Manually overridden price (cents). |\n| ↳ ↳ `items[].manualPriceAppliedBy` | `string` | User who applied manual price. |\n| ↳ ↳ `items[].sellingPrice` | `number` | Final selling price (cents). | |\n| ↳ ↳ `items[].rewardValue` | `number` | Reward/loyalty value (cents). | |\n| ↳ ↳ `items[].isGift` | `boolean` | Indicates if the item is a gift. | |\n| ↳ ↳ `items[].additionalInfo` | `object` | Extra metadata about the item. | |\n| ↳ ↳ ↳ `items[].additionalInfo.dimension` | `object` | Physical dimensions/weight. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.cubicweight` | `number` | Cubic weight. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.height` | `number` | Height. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.length` | `number` | Length. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.weight` | `number` | Weight. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.width` | `number` | Width. | |\n| ↳ ↳ ↳ `items[].additionalInfo.brandName` | `string` | Brand name. | |\n| ↳ ↳ ↳ `items[].additionalInfo.brandId` | `string` | Brand identifier. | |\n| ↳ ↳ ↳ `items[].additionalInfo.offeringInfo` | `string | null` | Offering info, if used. |\n| ↳ ↳ ↳ `items[].additionalInfo.offeringType` | `string | null` | Offering type. |\n| ↳ ↳ ↳ `items[].additionalInfo.offeringTypeId` | `string | null` | Offering type ID. |\n| ↳ ↳ ↳ `items[].additionalInfo.categoriesIds` | `string` | Category path IDs (e.g., `\"/1/\"`). | |\n| ↳ ↳ ↳ `items[].additionalInfo.productClusterId` | `string` | Product cluster identifier. | |\n| ↳ ↳ ↳ `items[].additionalInfo.commercialConditionId` | `string` | Commercial condition ID. | |\n| ↳ ↳ `items[].preSaleDate` | `string` | Pre‑sale availability date, if set. |\n| ↳ ↳ `items[].productCategoryIds` | `string` | Category path IDs for the product. | |\n| ↳ ↳ `items[].productCategories` | `object` | Map of categoryId → category name. | |\n| ↳ ↳ `items[].quantity` | `number` | Quantity ordered. | |\n| ↳ ↳ `items[].seller` | `string` | Seller ID for this line. | |\n| ↳ ↳ `items[].sellerChain` | `array` | Seller chain involved in fulfillment. | |\n| ↳ ↳ `items[].imageUrl` | `string` | SKU image URL. | |\n| ↳ ↳ `items[].detailUrl` | `string` | Product detail page path. | |\n| ↳ ↳ `items[].attachments` | `array` | Attached customization info. | |\n| ↳ ↳ `items[].attachmentOfferings` | `array` | Available attachment options. | |\n| ↳ ↳ `items[].offerings` | `array` | Additional offerings for the item. | |\n| ↳ ↳ `items[].priceTags` | `array` | Discounts/surcharges applied. | |\n| ↳ ↳ ↳ `items[].priceTags[]` | `object` | A price tag record. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].name` | `string` | Price tag name. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].value` | `number` | Value in cents (negatives = discount). | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].rawValue` | `number` | Value in currency units (e.g., dollars). | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].isPercentual` | `boolean` | Whether the tag is a percentage. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].identifier` | `string` | Identifier for the rule/benefit. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].owner` | `string` | Owner account of the tag. | |\n| ↳ ↳ `items[].availability` | `string` | Stock status (e.g., `available`). | |\n| ↳ ↳ `items[].measurementUnit` | `string` | Unit of measure (e.g., `un`). | |\n| ↳ ↳ `items[].unitMultiplier` | `number` | Multiplier for unit conversions. | |\n| ↳ ↳ `items[].manufacturerCode` | `string` | Manufacturer code, if any. |\n| ↳ ↳ `items[].priceDefinition` | `object` | Price breakdown used to compute totals. | |\n| ↳ ↳ ↳ `items[].priceDefinition.calculatedSellingPrice` | `number` | Computed selling price (cents). | |\n| ↳ ↳ ↳ `items[].priceDefinition.total` | `number` | Total amount considered (cents). | |\n| ↳ ↳ ↳ `items[].priceDefinition.sellingPrices` | `array` | Tiered selling price components. | |\n| ↳ ↳ ↳ ↳ `items[].priceDefinition.sellingPrices[]` | `object` | A selling price tier. | |\n| ↳ ↳ ↳ ↳ ↳ `items[].priceDefinition.sellingPrices[].value` | `number` | Price value (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `items[].priceDefinition.sellingPrices[].quantity` | `number` | Quantity covered by the tier. | |\n| ↳ ↳ ↳ `items[].priceDefinition.reason` | `string` | Reason or rule used, if any. |\n| `giftRegistryData` | `object` | Gift registry data, when present. |\n| `contextData` | `object` | Context of the checkout/session. | |\n| ↳ `contextData.loggedIn` | `boolean` | Whether user was authenticated. | |\n| ↳ `contextData.hasAccessToOrderFormEnabledByLicenseManager` | `boolean` | License‑based access flag. | |\n| ↳ `contextData.userAgent` | `string` | Client user agent. | |\n| ↳ `contextData.userId` | `string` | User ID (UUID). | |\n| ↳ `contextData.recaptchaScore` | `number` | reCAPTCHA score, if evaluated. |\n| `marketPlaceOrderGroup` | `string` | Marketplace order group ID. |\n| `marketplaceServicesEndpoint` | `string` | Endpoint for marketplace services. |\n| `orderFormId` | `string` | Order form identifier (UUID). | |\n| `affiliateId` | `string` | Affiliate identifier, if any. | |\n| `status` | `string` | Order status label (may be empty). | |\n| `callCenterOperator` | `string` | Operator code/name (may be empty). | |\n| `userProfileId` | `string` | User profile ID (UUID). | |\n| `creationVersion` | `string` | Platform version at creation. | |\n| `creationEnvironment` | `string` | Environment at creation (e.g., `STABLE`). | |\n| `lastChangeVersion` | `string` | Platform version at last change. | |\n| `workflowInstanceId` | `string` | Workflow instance ID. | |\n| `workflowInstanceGroupId` | `string` | Workflow group ID, if any. |\n| `marketplacePaymentValue` | `number` | Marketplace payment value (cents). |\n| `marketplacePaymentReferenceValue` | `number` | Marketplace reference value (cents). |\n| `marketplace` | `object` | Marketplace metadata. |\n| `orderId` | `string` | Order identifier. | |\n| `orderGroup` | `string` | Logical order group identifier. | |\n| `state` | `string` | Order state (e.g., `invoiced`). | |\n| `isCheckedIn` | `boolean` | Indicates in‑store check‑in. | |\n| `sellerOrderId` | `string` | Seller’s order ID. | |\n| `storeId` | `string` | Store identifier, if any. |\n| `checkedInPickupPointId` | `string` | Pickup point ID, if checked in. |\n| `value` | `number` | Grand total value (cents). | |\n| `totals` | `array` | Aggregated totals by category. | |\n| ↳ `totals[]` | `object` | A total line. | |\n| ↳ ↳ `totals[].id` | `string` | Total code (e.g., `Items`, `Discounts`). | |\n| ↳ ↳ `totals[].name` | `string` | Human‑readable name. | |\n| ↳ ↳ `totals[].value` | `number` | Amount in cents (discounts negative). | |\n| `clientProfileData` | `object` | Shopper profile details. | |\n| ↳ `clientProfileData.email` | `string` | Email address. | |\n| ↳ `clientProfileData.firstName` | `string` | First name. | |\n| ↳ `clientProfileData.lastName` | `string` | Last name. | |\n| ↳ `clientProfileData.document` | `string` | Tax/document number. | |\n| ↳ `clientProfileData.documentType` | `string` | Document type (e.g., `CNPJ`). | |\n| ↳ `clientProfileData.phone` | `string` | Phone number. | |\n| ↳ `clientProfileData.corporateName` | `string` | Corporate legal name. |\n| ↳ `clientProfileData.tradeName` | `string` | Corporate trade name. |\n| ↳ `clientProfileData.corporateDocument` | `string` | Corporate document number. |\n| ↳ `clientProfileData.stateInscription` | `string` | State registration. |\n| ↳ `clientProfileData.corporatePhone` | `string` | Corporate phone. |\n| ↳ `clientProfileData.isCorporate` | `boolean` | Corporate account flag. | |\n| ↳ `clientProfileData.profileCompleteOnLoading` | `boolean` | Profile loaded as complete. | |\n| ↳ `clientProfileData.profileErrorOnLoading` | `boolean` | Error while loading profile. | |\n| ↳ `clientProfileData.customerClass` | `string` | Customer segmentation/class. |\n| ↳ `clientProfileData.userProfileId` | `string` | Profile ID (UUID). | |\n| ↳ `clientProfileData.isProspect` | `boolean` | Prospect flag. | |\n| `ratesAndBenefitsData` | `object` | Promotions and benefits applied. | |\n| ↳ `ratesAndBenefitsData.rateAndBenefitsIdentifiers` | `array` | Identifiers of applied benefits. | |\n| ↳ ↳ `...[]` | `object` | A benefit rule. | |\n| ↳ ↳ ↳ `id` | `string` | Benefit identifier (UUID). | |\n| ↳ ↳ ↳ `name` | `string` | Rule/promotion name. | |\n| ↳ ↳ ↳ `featured` | `boolean` | Featured promotion flag. | |\n| ↳ ↳ ↳ `description` | `string` | Description, if any. |\n| ↳ ↳ ↳ `matchedParameters` | `object` | Parameters that matched the rule. | |\n| ↳ ↳ ↳ ↳ `matchedParameters[\"product@CatalogSystem\"]` | `string` | Product/category match token. | |\n| ↳ ↳ ↳ ↳ `matchedParameters.paymentMethodId` | `string` | Payment method ID used. | |\n| ↳ ↳ ↳ `additionalInfo` | `string` | Extra info. |\n| `shippingData` | `object` | Shipping addresses, logistics, and contacts. | |\n| ↳ `shippingData.address` | `object` | Chosen shipping address. | |\n| ↳ ↳ `shippingData.address.addressType` | `string` | Address type (e.g., `residential`). | |\n| ↳ ↳ `shippingData.address.receiverName` | `string` | Recipient name. | |\n| ↳ ↳ `shippingData.address.addressId` | `string` | Address ID. | |\n| ↳ ↳ `shippingData.address.isDisposable` | `boolean` | Temporary/one‑time address flag. | |\n| ↳ ↳ `shippingData.address.postalCode` | `string` | Postal/ZIP code. | |\n| ↳ ↳ `shippingData.address.city` | `string` | City. | |\n| ↳ ↳ `shippingData.address.state` | `string` | State/region code. | |\n| ↳ ↳ `shippingData.address.country` | `string` | Country code (ISO‑3). | |\n| ↳ ↳ `shippingData.address.street` | `string` | Street. | |\n| ↳ ↳ `shippingData.address.number` | `string` | Street number. | |\n| ↳ ↳ `shippingData.address.neighborhood` | `string` | Neighborhood/district. | |\n| ↳ ↳ `shippingData.address.complement` | `string` | Address complement. | |\n| ↳ ↳ `shippingData.address.reference` | `string` | Reference/landmark. |\n| ↳ ↳ `shippingData.address.geoCoordinates` | `array` | `[longitude, latitude]`. | |\n| ↳ `shippingData.logisticsInfo` | `array` | Logistics data per item. | |\n| ↳ ↳ `...[]` | `object` | Logistics record for an item index. | |\n| ↳ ↳ ↳ `itemIndex` | `number` | Item index in `items`. | |\n| ↳ ↳ ↳ `selectedSla` | `string` | Selected SLA ID/name. | |\n| ↳ ↳ ↳ `selectedDeliveryChannel` | `string` | Delivery channel (e.g., `delivery`). | |\n| ↳ ↳ ↳ `addressId` | `string` | Address used for this SLA. | |\n| ↳ ↳ ↳ `slas` | `array` | Available SLAs. | |\n| ↳ ↳ ↳ ↳ `slas[]` | `object` | An SLA option. | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | SLA identifier. | |\n| ↳ ↳ ↳ ↳ ↳ `deliveryChannel` | `string` | Channel (delivery/pickup). | |\n| ↳ ↳ ↳ ↳ ↳ `name` | `string` | SLA name. | |\n| ↳ ↳ ↳ ↳ ↳ `deliveryIds` | `array` | Carrier/warehouse legs. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ `deliveryIds[]` | `object` | A delivery leg. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `courierId` | `string` | Carrier ID. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `warehouseId` | `string` | Warehouse ID. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `dockId` | `string` | Dock ID. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `courierName` | `string` | Carrier name. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `quantity` | `number` | Quantity moved in this leg. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `kitItemDetails` | `array` | Kit leg details, if any. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `accountCarrierName` | `string` | Account that owns the carrier. | |\n| ↳ ↳ ↳ ↳ ↳ `shippingEstimate` | `string` | Time estimate (e.g., `1bd`). | |\n| ↳ ↳ ↳ ↳ ↳ `shippingEstimateDate` | `string` | Estimated delivery date (UTC). | |\n| ↳ ↳ ↳ ↳ ↳ `lockTTL` | `string` | Lock TTL (e.g., `10d`). | |\n| ↳ ↳ ↳ ↳ ↳ `availableDeliveryWindows` | `array` | Available scheduling windows. | |\n| ↳ ↳ ↳ ↳ ↳ `deliveryWindow` | `object | null` | Selected window, if any. |\n| ↳ ↳ ↳ ↳ ↳ `price` | `number` | Freight price (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `listPrice` | `number` | Freight list price (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `tax` | `number` | Freight tax (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `pickupStoreInfo` | `object` | Pickup store info (if pickup). | |\n| ↳ ↳ ↳ ↳ ↳ ↳ `isPickupStore` | `boolean` | Indicates pickup store. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ `friendlyName` | `string` | Store name. |\n| ↳ ↳ ↳ ↳ ↳ ↳ `address` | `object` | Store address, if known. |\n| ↳ ↳ ↳ ↳ ↳ ↳ `additionalInfo` | `string` | Extra info. |\n| ↳ ↳ ↳ ↳ ↳ ↳ `dockId` | `string` | Store dock ID. |\n| ↳ ↳ ↳ ↳ ↳ `pickupPointId` | `string` | Pickup point identifier. |\n| ↳ ↳ ↳ ↳ ↳ `pickupDistance` | `number` | Distance to pickup point. | |\n| ↳ ↳ ↳ ↳ ↳ `polygonName` | `string` | SLA polygon name. | |\n| ↳ ↳ ↳ ↳ ↳ `transitTime` | `string` | Transit time string (e.g., `1bd`). | |\n| ↳ ↳ ↳ `shipsTo` | `array` | Countries the SLA ships to. | |\n| ↳ ↳ ↳ `itemId` | `string` | SKU ID for this logistics record. | |\n| ↳ ↳ ↳ `deliveryChannels` | `array` | Available delivery channels. | |\n| ↳ ↳ ↳ ↳ `deliveryChannels[]` | `object` | Delivery channel entry. | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | Channel ID (e.g., `delivery`). | |\n| ↳ ↳ ↳ `price` | `number` | Selected SLA price (cents). | |\n| ↳ ↳ ↳ `listPrice` | `number` | Selected SLA list price (cents). | |\n| ↳ ↳ ↳ `shippingEstimate` | `string` | Selected SLA estimate. | |\n| ↳ ↳ ↳ `dockEstimate` | `string` | Dock processing estimate. | |\n| ↳ ↳ ↳ `shippingEstimateDate` | `string` | Estimated date (UTC). | |\n| ↳ ↳ ↳ `lockTTL` | `string` | Lock TTL for this selection. | |\n| ↳ ↳ ↳ `deliveryCompany` | `string` | Carrier company name, if known. |\n| ↳ ↳ ↳ `polygonName` | `string` | Polygon name. | |\n| ↳ ↳ ↳ `transitTime` | `string` | Transit time. | |\n| ↳ ↳ ↳ `sellingPrice` | `number` | Selected SLA selling price (cents). | |\n| ↳ ↳ ↳ `deliveryIds` | `array` | Selected legs (same schema as above). | |\n| ↳ ↳ ↳ `deliveryWindow` | `object` | Selected delivery window. |\n| ↳ ↳ ↳ `pickupPointId` | `string` | Selected pickup point. |\n| ↳ ↳ ↳ `pickupStoreInfo` | `object` | Selected pickup store info. | |\n| ↳ ↳ ↳ `pickupDistance` | `number` | Distance to pickup point. |\n| ↳ `shippingData.selectedAddresses` | `array` | Addresses selected during checkout. | |\n| ↳ `shippingData.availableAddresses` | `array` | Addresses available to the user. | |\n| ↳ `shippingData.trackingHints` | `array` | Tracking hints from carriers. | |\n| ↳ `shippingData.pickupPoints` | `array` | Available pickup points. | |\n| ↳ `shippingData.contactInformation` | `array` | People related to delivery. | |\n| ↳ ↳ `...[]` | `object` | A contact. | |\n| ↳ ↳ ↳ `id` | `string` | Contact ID. | |\n| ↳ ↳ ↳ `firstName` | `string` | First name. | |\n| ↳ ↳ ↳ `lastName` | `string` | Last name. | |\n| ↳ `shippingData.contactsInfo` | `array` | Address‑to‑contacts mappings. | |\n| ↳ ↳ `...[]` | `object` | A mapping entry. | |\n| ↳ ↳ ↳ `addressId` | `string` | Address ID. | |\n| ↳ ↳ ↳ `contacts` | `array` | Contact IDs. | |\n| ↳ ↳ ↳ `receiveWindows` | `array` | Preferred receiving windows. | |\n| ↳ `shippingData.isFOB` | `boolean` | Free‑On‑Board flag. |\n| `paymentData` | `object` | Payment instruments and transactions. | |\n| ↳ `paymentData.giftCards` | `array` | Gift cards used (if any). | |\n| ↳ `paymentData.transactions` | `array` | Transactions created for the order. | |\n| ↳ ↳ `...[]` | `object` | A transaction. | |\n| ↳ ↳ ↳ `isActive` | `boolean` | Whether the transaction is active. | |\n| ↳ ↳ ↳ `transactionId` | `string` | Transaction ID. | |\n| ↳ ↳ ↳ `merchantName` | `string` | Merchant name. | |\n| ↳ ↳ ↳ `payments` | `array` | Payments within the transaction. | |\n| ↳ ↳ ↳ ↳ `payments[]` | `object` | A payment record. | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | Payment ID. | |\n| ↳ ↳ ↳ ↳ ↳ `paymentSystem` | `string` | Payment system ID. | |\n| ↳ ↳ ↳ ↳ ↳ `paymentSystemName` | `string` | Payment system display name. | |\n| ↳ ↳ ↳ ↳ ↳ `value` | `number` | Amount charged (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `installments` | `number` | Number of installments. | |\n| ↳ ↳ ↳ ↳ ↳ `connectorResponses` | `object` | Raw gateway responses. | |\n| ↳ ↳ ↳ ↳ ↳ `referenceValue` | `number` | Reference value (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `cardHolder` | `string` | Cardholder name. |\n| ↳ ↳ ↳ ↳ ↳ `cardNumber` | `string` | Masked card number. |\n| ↳ ↳ ↳ ↳ ↳ `firstDigits` | `string` | BIN (first digits), if available. |\n| ↳ ↳ ↳ ↳ ↳ `lastDigits` | `string` | Last digits, if available. |\n| ↳ ↳ ↳ ↳ ↳ `cvv2` | `string` | CVV2 (never stored in production). |\n| ↳ ↳ ↳ ↳ ↳ `expireMonth` | `string` | Expiration month. |\n| ↳ ↳ ↳ ↳ ↳ `expireYear` | `string` | Expiration year. |\n| ↳ ↳ ↳ ↳ ↳ `url` | `string` | Payment URL, if any. |\n| ↳ ↳ ↳ ↳ ↳ `koinUrl` | `string` | Koin URL, if any. |\n| ↳ ↳ ↳ ↳ ↳ `tid` | `string` | Transaction TID. |\n| ↳ ↳ ↳ ↳ ↳ `redemptionCode` | `string` | Gift card redemption code. |\n| ↳ ↳ ↳ ↳ ↳ `giftCardId` | `string` | Gift card ID. |\n| ↳ ↳ ↳ ↳ ↳ `giftCardProvider` | `string` | Gift card provider. |\n| ↳ ↳ ↳ ↳ ↳ `giftCardAsDiscount` | `boolean` | Whether gift card acts as discount. |\n| ↳ ↳ ↳ ↳ ↳ `group` | `string` | Payment group (e.g., `promissory`). | |\n| ↳ ↳ ↳ ↳ ↳ `dueDate` | `string` | Due date for payment, if any. |\n| ↳ ↳ ↳ ↳ ↳ `paymentOrigin` | `string` | Origin channel of the payment. |\n| ↳ ↳ ↳ ↳ ↳ `accountId` | `string` | Gateway account ID. |\n| ↳ ↳ ↳ ↳ ↳ `parentAccountId` | `string` | Parent account ID. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceIdentificationNumber` | `string` | Bank boleto ID. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceIdentificationNumberFormatted` | `string` | Formatted boleto ID. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceBarCodeNumber` | `string` | Bank barcode number. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceBarCodeType` | `string` | Barcode type. |\n| ↳ ↳ ↳ ↳ ↳ `billingAddress` | `object` | Billing address. |\n| ↳ ↳ ↳ ↳ ↳ `paymentDetails` | `array` | Extra details, if any. | |\n| ↳ ↳ ↳ `sharedTransaction` | `boolean` | Whether transaction is shared. | |\n| `clientPreferencesData` | `object` | Shopper preferences. | |\n| ↳ `clientPreferencesData.locale` | `string` | Locale (e.g., `pt-BR`). | |\n| ↳ `clientPreferencesData.optinNewsLetter` | `boolean` | Newsletter opt‑in. | |\n| ↳ `clientPreferencesData.savePersonalData` | `boolean` | Save personal data preference. | |\n| ↳ `clientPreferencesData.savePaymentData` | `boolean` | Save payment data preference. | |\n| `commercialConditionData` | `object` | Applied commercial conditions. |\n| `marketingData` | `object` | Marketing/campaign data. |\n| `storePreferencesData` | `object` | Store localization and currency settings. | |\n| ↳ `storePreferencesData.countryCode` | `string` | Country code. | |\n| ↳ `storePreferencesData.timeZone` | `string` | Store time zone name. | |\n| ↳ `storePreferencesData.currencyCode` | `string` | Currency code (ISO‑4217). | |\n| ↳ `storePreferencesData.currencyLocale` | `number` | Windows/LCID locale code. | |\n| ↳ `storePreferencesData.currencySymbol` | `string` | Currency symbol. | |\n| ↳ `storePreferencesData.currencyFormatInfo` | `object` | Currency formatting rules. | |\n| ↳ ↳ `...currencyDecimalDigits` | `number` | Number of decimal digits. | |\n| ↳ ↳ `...currencyDecimalSeparator` | `string` | Decimal separator. | |\n| ↳ ↳ `...currencyGroupSeparator` | `string` | Thousands separator. | |\n| ↳ ↳ `...currencyGroupSize` | `number` | Grouping size. | |\n| ↳ ↳ `...startsWithCurrencySymbol` | `boolean` | Whether symbol prefixes value. | |\n| `openTextField` | `object` | Free‑form text fields. |\n| `invoiceData` | `object` | Invoice information. | |\n| ↳ `invoiceData.address` | `object` | Invoice address, if provided. |\n| ↳ `invoiceData.settleInvoices` | `array` | Invoice numbers to settle. | |\n| ↳ `invoiceData.invoices` | `object` | Map invoiceNumber → invoice object. | |\n| ↳ ↳ `invoiceData.invoices[\"1757350014\"]` | `object` | Example invoice entry. | |\n| ↳ ↳ ↳ `type` | `string` | Invoice type (e.g., `Output`). | |\n| ↳ ↳ ↳ `invoiceNumber` | `string` | Invoice number. | |\n| `itemMetadata` | `object` | Metadata for items in the order. | |\n| ↳ `itemMetadata.items` | `array` | Items metadata list. | |\n| ↳ ↳ `...[]` | `object` | Metadata for one SKU. | |\n| ↳ ↳ ↳ `id` | `string` | SKU ID. | |\n| ↳ ↳ ↳ `seller` | `string` | Seller ID. | |\n| ↳ ↳ ↳ `name` | `string` | Product name. | |\n| ↳ ↳ ↳ `skuName` | `string` | SKU name. | |\n| ↳ ↳ ↳ `productId` | `string` | Product ID. | |\n| ↳ ↳ ↳ `refId` | `string` | Reference ID. | |\n| ↳ ↳ ↳ `ean` | `string` | EAN code. |\n| ↳ ↳ ↳ `imageUrl` | `string` | Image URL. | |\n| ↳ ↳ ↳ `detailUrl` | `string` | PDP URL path. | |\n| ↳ ↳ ↳ `assemblyOptions` | `array` | Assembly options (if any). | |\n| `taxData` | `object` | Tax breakdown (when available). |\n| `customData` | `object` | Custom app/field data. | |\n| ↳ `customData.customApps` | `array` | Custom apps payloads. | |\n| ↳ `customData.customFields` | `array` | Custom fields at order/item scope. | |\n| ↳ ↳ `...[]` | `object` | A group of custom fields scoped to an entity. | |\n| ↳ ↳ ↳ `linkedEntity` | `object` | Entity this group attaches to. | |\n| ↳ ↳ ↳ ↳ `type` | `string` | Entity type (e.g., `order`, `item`). | |\n| ↳ ↳ ↳ ↳ `id` | `string` | Entity ID (e.g., item uniqueId). |\n| ↳ ↳ ↳ `fields` | `array` | Name/value pairs. | |\n| ↳ ↳ ↳ ↳ `fields[]` | `object` | A custom field. | |\n| ↳ ↳ ↳ ↳ ↳ `name` | `string` | Field name. | |\n| ↳ ↳ ↳ ↳ ↳ `value` | `string` | Field value. | |\n| ↳ ↳ ↳ ↳ ↳ `refId` | `string` | Reference identifier. | |\n| `hooksData` | `object` | Webhook processing data. |\n| `changeData` | `object` | Change feed information. |\n| `subscriptionData` | `object` | Subscription linkage. |\n| `merchantContextData` | `objectnull` | Merchant‑specific context. |\n| `purchaseAgentData` | `object` | Purchase agent (B2B) metadata. | |\n| ↳ `purchaseAgentData.purchaseAgents` | `array` | Agents associated to the order. | |\n| ↳ ↳ `...[]` | `object` | A purchase agent record. | |\n| ↳ ↳ ↳ `userId` | `string` | Agent user ID. | |\n| ↳ ↳ ↳ `versionId` | `string` | Version identifier. | |\n| ↳ ↳ ↳ `persona` | `string` | Persona (e.g., `BUYER`). | |\n| ↳ ↳ ↳ `unitId` | `string` | Organizational unit ID. | |\n| `budgetData` | `object` | Budget reservations/allocations. | |\n| ↳ `budgetData.unitAllocations` | `object` | Map unitId → allocations array. | |\n| ↳ ↳ `budgetData.unitAllocations[unitId]` | `array` | Allocations for a unit. | |\n| ↳ ↳ ↳ `...[]` | `object` | A budget allocation/reservation. | |\n| ↳ ↳ ↳ ↳ `budgetId` | `string` | Budget ID. | |\n| ↳ ↳ ↳ ↳ `allocationId` | `string` | Allocation ID. | |\n| ↳ ↳ ↳ ↳ `linkedEntity` | `object` | What this allocation links to. | |\n| ↳ ↳ ↳ ↳ ↳ `type` | `string` | Linked type (e.g., `poNumber`). | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | Linked ID (e.g., `PO1`). | |\n| ↳ ↳ ↳ ↳ `reservationId` | `string` | Reservation ID. | |\n| ↳ ↳ ↳ ↳ `reservedAmount` | `number` | Amount reserved (cents). | |\n| ↳ ↳ ↳ ↳ `budgetBalance` | `object` | Budget balance snapshot. | |\n| ↳ ↳ ↳ ↳ ↳ `amount` | `number` | Budget amount (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `totalUtilized` | `number` | Total utilized (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `remaining` | `number` | Remaining amount (cents, may be negative). | |\n| ↳ ↳ ↳ ↳ `allocationBalance` | `object` | Allocation balance snapshot. | |\n| ↳ ↳ ↳ ↳ ↳ `amount` | `number` | Allocation amount (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `totalUtilized` | `number` | Total utilized (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `remaining` | `number` | Remaining amount (cents, may be negative). | |\n| `authorizationPolicyData` | `object` | Result of authorization policies. | |\n| ↳ `authorizationPolicyData.status` | `string` | Overall status (e.g., `accepted`). | |\n| ↳ `authorizationPolicyData.deniedPolicies` | `array` | Policies that denied (none here). | |\n| ↳ `authorizationPolicyData.pendingPolicies` | `array` | Policies pending (none here). | |\n| `salesChannel` | `string` | Sales channel identifier. | |\n| `followUpEmail` | `string` | Follow‑up email address (system). | |\n| `creationDate` | `string` | Order creation timestamp (UTC). | |\n| `lastChange` | `string` | Last update timestamp (UTC). | |\n| `timeZoneCreationDate` | `string` | Creation timestamp in store time zone. | |\n| `timeZoneLastChange` | `string` | Last change timestamp in store time zone. | |\n| `isCompleted` | `boolean` | Whether the order is completed. | |\n| `hostName` | `string` | Store account/hostname. | |\n| `merchantName` | `string` | Merchant name, if any. |\n| `userType` | `string` | User type label. | |\n| `roundingError` | `number` | Rounding adjustment (cents). | |\n| `allowEdition` | `boolean` | Whether order can be edited. | |\n| `allowCancellation` | `boolean` | Whether order can be canceled. | |\n| `isUserDataVisible` | `boolean` | Whether PII is visible in context. | |\n| `allowChangeSeller` | `boolean` | Whether seller can be changed. | |\n| `orderFormCreationDate` | `string` | Order form creation timestamp (UTC). | |\n| `marketplaceRequestedCancellationWindow` | `object` | Cancellation window requested by marketplace. |\n" + }, + "response": [ + { + "name": "200 OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/order-system/orders/order-group/{{my_orderGroup}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "order-system", + "orders", + "order-group", + "{{my_orderGroup}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [ + { + "expires": "Invalid Date", + "domain": "", + "path": "" + } + ], + "body": "[\n {\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"VTEX\",\n \"logo\": \"\",\n \"subSellerId\": \"1\",\n \"fulfillmentEndpoint\": \"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=b2bfaststoredev\"\n }\n ],\n \"receiptData\": {\n \"ReceiptCollection\": [\n {\n \"ReceiptType\": \"authorizePayment\",\n \"Date\": \"2025-09-08T16:46:45.3342331Z\",\n \"ReceiptToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": null\n },\n {\n \"ReceiptType\": \"settlePayment\",\n \"Date\": \"2025-09-08T16:46:56.8172171Z\",\n \"ReceiptToken\": \"4C45295FB5184611B88A3EE754C988EA\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017115Z\",\n \"ReceiptToken\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017154Z\",\n \"ReceiptToken\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n }\n ]\n },\n \"sequence\": \"656517\",\n \"marketPlaceOrderId\": \"\",\n \"origin\": 0,\n \"items\": [\n {\n \"sellerSku\": \"88\",\n \"priceTable\": null,\n \"priceValidUntil\": \"2026-09-08T16:46:40Z\",\n \"callCenterOperator\": null,\n \"commission\": 0,\n \"freightCommission\": 0,\n \"taxCode\": \"1\",\n \"catalogProvider\": \"vrn:vtex.catalog-api-proxy:-:b2bfaststoredev:master:/proxy/authenticated/catalog/pvt/sku/stockkeepingunitbyid/88\",\n \"bundleItems\": [],\n \"components\": [],\n \"costPrice\": null,\n \"lockId\": null,\n \"uniqueId\": \"E0C828E7E81E4466AE92C1CBA6D872E0\",\n \"id\": \"88\",\n \"productId\": \"56\",\n \"productRefId\": \"88\",\n \"refId\": \"88\",\n \"ean\": null,\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"tax\": 0,\n \"customTax\": 0,\n \"price\": 3399,\n \"listPrice\": 3399,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 3059,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": {\n \"cubicweight\": 1.0,\n \"height\": 10.0,\n \"length\": 10.0,\n \"weight\": 10.0,\n \"width\": 10.0\n },\n \"brandName\": \"Precision Pro\",\n \"brandId\": \"2000001\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null,\n \"categoriesIds\": \"/1/\",\n \"productClusterId\": \"137\",\n \"commercialConditionId\": \"1\"\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Category\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [\n {\n \"name\": \"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\",\n \"value\": -340,\n \"rawValue\": -3.40,\n \"isPercentual\": false,\n \"identifier\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"owner\": \"b2bfaststoredev\"\n }\n ],\n \"availability\": \"available\",\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 3059,\n \"total\": 3059,\n \"sellingPrices\": [\n {\n \"value\": 3059,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n }\n }\n ],\n \"giftRegistryData\": null,\n \"contextData\": {\n \"loggedIn\": false,\n \"hasAccessToOrderFormEnabledByLicenseManager\": false,\n \"userAgent\": \"PostmanRuntime/7.39.0\",\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"recaptchaScore\": null\n },\n \"marketPlaceOrderGroup\": null,\n \"marketplaceServicesEndpoint\": null,\n \"orderFormId\": \"2a7b348c-e023-4613-ac02-d3575deab1a1\",\n \"affiliateId\": \"\",\n \"status\": \"\",\n \"callCenterOperator\": \"\",\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"creationVersion\": \"2.346.5.0\",\n \"creationEnvironment\": \"STABLE\",\n \"lastChangeVersion\": \"1.169.2.0\",\n \"workflowInstanceId\": \"c75c182e-eb4a-49e4-ad34-bbd38095f18c\",\n \"workflowInstanceGroupId\": null,\n \"marketplacePaymentValue\": null,\n \"marketplacePaymentReferenceValue\": null,\n \"marketplace\": null,\n \"orderId\": \"1560170656517-01\",\n \"orderGroup\": \"1560170656517\",\n \"state\": \"invoiced\",\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560170656517-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 3159,\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 3399\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": -340\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 100\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"johnson.kozey@yahoo.com\",\n \"firstName\": \"Frederic\",\n \"lastName\": \"Kessler\",\n \"document\": \"22736794/000199\",\n \"documentType\": \"CNPJ\",\n \"phone\": \"3834600495\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": true,\n \"profileErrorOnLoading\": false,\n \"customerClass\": null,\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"isProspect\": false\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [\n {\n \"id\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"name\": \"Pagamento a vista\",\n \"featured\": false,\n \"description\": null,\n \"matchedParameters\": {\n \"product@CatalogSystem\": \"54|exclusive\",\n \"paymentMethodId\": \"17\"\n },\n \"additionalInfo\": null\n }\n ]\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Entrega Soberana\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"slas\": [\n {\n \"id\": \"Entrega Soberana\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Entrega Soberana\",\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"shippingEstimate\": \"1bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 100,\n \"listPrice\": 100,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\"\n }\n ],\n \"shipsTo\": [\n \"USA\",\n \"BRA\"\n ],\n \"itemId\": \"88\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ],\n \"price\": 100,\n \"listPrice\": 100,\n \"shippingEstimate\": \"1bd\",\n \"dockEstimate\": \"0bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"deliveryCompany\": null,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\",\n \"sellingPrice\": 100,\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"deliveryWindow\": null,\n \"pickupPointId\": null,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupDistance\": null\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"trackingHints\": [],\n \"pickupPoints\": [],\n \"contactInformation\": [\n {\n \"id\": \"3b93a926fea84c62ae309882a03e909b\",\n \"firstName\": \"Marla\",\n \"lastName\": \"Singer\"\n },\n {\n \"id\": \"fdace46db89346dc8493aa693a5962dc\",\n \"firstName\": \"Robert\",\n \"lastName\": \"Paulson\"\n }\n ],\n \"contactsInfo\": [\n {\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"contacts\": [\n \"fdace46db89346dc8493aa693a5962dc\",\n \"3b93a926fea84c62ae309882a03e909b\"\n ],\n \"receiveWindows\": []\n }\n ],\n \"isFOB\": null\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"merchantName\": \"B2BFASTSTOREDEV\",\n \"payments\": [\n {\n \"id\": \"4CB7873069554734969679E47505DD43\",\n \"paymentSystem\": \"17\",\n \"paymentSystemName\": \"Promissory\",\n \"value\": 3159,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 3159,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": \"promissory\",\n \"dueDate\": null,\n \"paymentOrigin\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentDetails\": []\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": {\n \"locale\": \"pt-BR\",\n \"optinNewsLetter\": false,\n \"savePersonalData\": false,\n \"savePaymentData\": false\n },\n \"commercialConditionData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"USA\",\n \"timeZone\": \"Eastern Standard Time\",\n \"currencyCode\": \"USD\",\n \"currencyLocale\": 1033,\n \"currencySymbol\": \"$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \".\",\n \"currencyGroupSeparator\": \",\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": {\n \"address\": null,\n \"settleInvoices\": [\n \"1757350014\"\n ],\n \"invoices\": {\n \"1757350014\": {\n \"type\": \"Output\",\n \"invoiceNumber\": \"1757350014\"\n }\n }\n },\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"88\",\n \"seller\": \"1\",\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"productId\": \"56\",\n \"refId\": \"88\",\n \"ean\": null,\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"assemblyOptions\": []\n }\n ]\n },\n \"taxData\": null,\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"order\",\n \"id\": null\n },\n \"fields\": [\n {\n \"name\": \"poNumber\",\n \"value\": \"PO1\",\n \"refId\": \"PO1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"E0C828E7E81E4466AE92C1CBA6D872E0\"\n },\n \"fields\": [\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n }\n ]\n },\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"purchaseAgentData\": {\n \"purchaseAgents\": [\n {\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"versionId\": \"\",\n \"persona\": \"BUYER\",\n \"unitId\": \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\"\n }\n ]\n },\n \"budgetData\": {\n \"unitAllocations\": {\n \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\": [\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c3d4-966b-7519-8cdc-0867f99581c4\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -410354\n }\n },\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c267-1c3c-70ef-9fdf-5572fd08e70e\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -415282\n }\n }\n ]\n }\n },\n \"authorizationPolicyData\": {\n \"status\": \"accepted\",\n \"deniedPolicies\": [],\n \"pendingPolicies\": []\n },\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"9e2d3530482e49f8bd0e8e9d97ee2f36@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:46:42.0195859Z\",\n \"lastChange\": \"2025-09-08T16:46:58.1025748Z\",\n \"timeZoneCreationDate\": \"2025-09-08T12:46:42.0195859\",\n \"timeZoneLastChange\": \"2025-09-08T12:46:58.1025748\",\n \"isCompleted\": true,\n \"hostName\": \"b2bfaststoredev\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:46:40.1383799Z\",\n \"marketplaceRequestedCancellationWindow\": null\n }\n]\n" + } + ] + } + ], + "description": "The following endpoints allow interaction with client orders. They enable placing an order, processing its payment, and retrieving order information." + } + ], + "description": "The Buying Policies system supports dynamic rules that merchants can configure to suit their specific authorization processes. It provides a mechanism for users to register custom rule expressions, offering greater flexibility and extensibility.\n\nThe approval process is hierarchical and sequential:\n\n- Starts at the org unit where the order is placed.\n \n- Moves up one org unit level at a time, only after all policies at the current level are approved.\n \n- At each level, policies are applied in the order of their creation (from oldest to newest)." + }, + { + "name": "Auxiliar APIs", + "item": [ + { + "name": "List Payment Systems", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/payments/pvt/payment-systems/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "payments", + "pvt", + "payment-systems", + "" + ] + }, + "description": "**Official Doc:** [VTEX Payments Gateway API](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/merchants/payment-systems)\n\nThis endpoint retrieves a list of payment systems available for the merchant account.\n\n---\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/payments/pvt/payment-systems/\n\n ```\n\n**Headers:**\n\n- `X-VTEX-API-AppKey`: Your VTEX App Key\n \n- `X-VTEX-API-AppToken`: Your VTEX App Token\n \n\nNo request body is required.\n\n---\n\n### Response\n\n**Status:** `200 OK`\n\n**Content-Type:** `application/json`\n\nReturns an array of payment system objects:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | number | The ID of the payment system. |\n| `name` | string | The name of the payment system. |\n| `requiresDocument` | boolean | Whether a document is required. |\n| `implementation` | string | Implementation details. |\n| `connectorImplementation` | string | Connector implementation. |\n| `antifraudConnectorImplementation` | string | Antifraud connector implementation. |\n| `groupName` | string | Group name of the payment system. |\n| `redirect` | boolean | Whether redirection is allowed. |\n| `isCustom` | boolean | Whether it is a custom payment system. |\n| `isSelfAuthorized` | boolean | Whether it is self-authorized. |\n| `requiresAuthentication` | boolean | Whether authentication is required. |\n| `allowInstallments` | boolean | Whether installments are allowed. |\n| `allowBinExclusion` | boolean | Whether bin exclusion is allowed. |\n| `allowMultiple` | boolean | Whether multiple payments are allowed. |\n| `allowIssuer` | boolean | Whether issuer is allowed. |\n| `allowCountry` | boolean | Whether country is allowed. |\n| `allowCommercialPolicy` | boolean | Whether commercial policy is allowed. |\n| `allowCommercialCondition` | boolean | Whether commercial condition is allowed. |\n| `allowPeriod` | boolean | Whether period is allowed. |\n| `isAvailable` | boolean | Whether the payment system is available. |\n| `description` | string | Description of the payment system. |\n| `supportRecurrence` | boolean | Whether recurrence is supported. |\n| `validator` | object | Validation details. |\n| `appDependencies` | array | List of application dependencies. |\n| `displayDocument` | boolean | Whether document display is allowed. |\n| `dueDate` | string | Due date of the payment system. |\n| `allowNotification` | boolean | Whether notifications are allowed. |\n| `affiliationId` | string | Affiliation ID. |\n| `availablePayments` | null | Available payments. |\n| `dueDateMinutes` | number | Due date in minutes. |\n\n---\n\n### Example Response\n\n``` json\n[\n {\n \"id\": 1,\n \"name\": \"Credit Card\",\n \"requiresDocument\": true,\n \"implementation\": \"gateway-impl\",\n \"connectorImplementation\": \"connector-impl\",\n \"antifraudConnectorImplementation\": \"antifraud-impl\",\n \"groupName\": \"credit-card\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": true,\n \"allowInstallments\": true,\n \"allowBinExclusion\": true,\n \"allowMultiple\": true,\n \"allowIssuer\": true,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": \"Standard Credit Card\",\n \"supportRecurrence\": true,\n \"validator\": {},\n \"appDependencies\": [],\n \"displayDocument\": true,\n \"dueDate\": \"2025-12-31T23:59:59Z\",\n \"allowNotification\": true,\n \"affiliationId\": \"aff-123\",\n \"availablePayments\": null,\n \"dueDateMinutes\": 1440\n }\n]\n\n ```" + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/payments/pvt/payment-systems/", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "payments", + "pvt", + "payment-systems", + "" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "388836" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Tue, 25 Mar 2025 13:32:40 GMT" + }, + { + "key": "Cache-Control", + "value": "no-store" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "payment-v1.2.1" + }, + { + "key": "x-vtex-operation-id", + "value": "4d975107-b64c-4df5-a4fb-36ce624752c7" + }, + { + "key": "X-XSS-Protection", + "value": "1; mode=block" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=86400; includeSubDomains" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 ec2ee70d2f42be931ebbd09be1528d7e.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "HmBRHEi0xqLQtMqsKHNwHyKBZdJKQJooC-oIf4yM0JPLojMjt9CMsQ==" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": 1,\n \"name\": \"American Express\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Amex\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^3[47][0-9]{13}$\",\n \"mask\": \"9999 999999 99999\",\n \"cardCodeMask\": \"9999\",\n \"cardCodeRegex\": \"^[0-9]{4}$\",\n \"weights\": [\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 2,\n \"name\": \"Visa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Visa\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^4[0-9]{15}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 3,\n \"name\": \"Diners\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Diners\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^3(0[0-5]|[68][0-9])[0-9]{11}$\",\n \"mask\": \"9999 999999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 4,\n \"name\": \"Mastercard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Mastercard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\\\d{4,10})|((502121)\\\\d{4,10})|((589916)\\\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\\\d{4,10})\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 5,\n \"name\": \"Discover\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Discover\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(6011|65[0-9]{2})[0-9]{12}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 6,\n \"name\": \"Boleto Bancário\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.BankIssuedInvoicePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 7,\n \"name\": \"Aura\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Aura\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^50[0-9]{17}$\",\n \"mask\": \"9999999999999999999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 8,\n \"name\": \"Hipercard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Hipercard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^606282|^3841(?:[0|4|6]{1})0\",\n \"mask\": \"9999999999999999999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 1,\n 1,\n 1\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 9,\n \"name\": \"Elo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Elo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(50(67(0[78]|1[5789]|2[012456789]|3[01234569]|4[0-7]|53|7[4-8])|9(0(0[0-9]|1[34]|2[0-7]|3[0359]|4[01235678]|5[01235789]|6[0-9]|7[01346789]|8[01234789]|9[123479])|1(0[34568]|4[6-9]|5[1-8]|8[356789])|2(2[0-2]|5[78]|6[1-9]|7[0-9]|8[01235678]|90)|357|4(0[7-9]|1[0-9]|2[0-2]|31|5[7-9]|6[0-6]|84)|55[01]|636|7(2[2-9]|6[5-9])))|4(0117[89]|3(1274|8935)|5(1416|7(393|63[12])))|6(27780|36368|5(0(0(3[12356789]|4[0-7]|7[78])|4(0[6-9]|1[0234]|2[2-9]|3[045789]|8[5-9]|9[0-9])|5(0[012346789]|1[0-9]|2[0-9]|3[0178]|5[2-9]|6[0-6]|7[7-9]|8[0-8]|9[1-8])|72[0-7]|9(0[1-9]|1[0-9]|2[0128]|3[89]|4[6-9]|5[0145]|6[235678]|71))|16(5[2-9]|6[0-9]|7[01456789])|50(0[0-9]|1[02345678]|36|5[1267]))))\\\\d{0,13}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 10,\n \"name\": \"Visa Electron\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.VisaElectron\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^4[0-9]{15}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 12,\n \"name\": \"PayPal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"payPal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 13,\n \"name\": \"Bcash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.PagamentoDigital.PagamentoDigitalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bcash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 14,\n \"name\": \"Banricompras\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Banricompras\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(6396|5304\\\\s{0,1}1)\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 15,\n \"name\": \"Evolucard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EvolucardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"evolucard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 16,\n \"name\": \"Vale\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.GiftCard.VtexGiftCard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"giftCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 17,\n \"name\": \"Promissory\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.PromissoryPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"promissory\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 18,\n \"name\": \"Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 19,\n \"name\": \"Débito Online\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.GenericDebitCard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 20,\n \"name\": \"Alignet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AlignetPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"alignet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 21,\n \"name\": \"JCB\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.JCB\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(35[0-9]{3}|2131|1800)[0-9]{11}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 22,\n \"name\": \"Débito Itau\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Itau\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 23,\n \"name\": \"Débito Bradesco\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Bradesco\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 24,\n \"name\": \"Débito Banco do Brasil\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.BancoDoBrasil\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 25,\n \"name\": \"Débito Banrisul\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Banrisul\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 26,\n \"name\": \"PagSeguro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagSeguroPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pagSeguro\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 27,\n \"name\": \"Débito Hsbc\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Hsbc\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 28,\n \"name\": \"Peela\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Peela\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"peela\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 29,\n \"name\": \"Private Label\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.PrivateLabelPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"9999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 30,\n \"name\": \"Webpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WebpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"webpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 31,\n \"name\": \"CoBranded\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.CoBrandedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"9999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 32,\n \"name\": \"PayClub\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayClubPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"payClub\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 33,\n \"name\": \"Cabal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Cabal\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^((627170)|(650272)|(650087)|(589657)|(603522)|(604((20[1-9])|(2[1-9][0-9])|(3[0-9]{2})|(400))))\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 34,\n \"name\": \"Nativa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Nativa\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^487017[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 35,\n \"name\": \"Naranja\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Naranja\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^589562[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 36,\n \"name\": \"Nevada\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Nevada\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^504363[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 37,\n \"name\": \"Shopping\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Shopping\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^603488[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 38,\n \"name\": \"Safetypay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SafetypayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"safetypay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 39,\n \"name\": \"Maestro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.Maestro\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\\\d{4,10})|((502121)\\\\d{4,10})|((589916)\\\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\\\d{4,10})\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 40,\n \"name\": \"Koin Pós-Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.KoinBankIssueInvoicePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"boletoKoinPosPago\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 41,\n \"name\": \"PagoEfectivo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.PagoEfectivoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagoEfectivo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 42,\n \"name\": \"Stelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SteloPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Stelo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 43,\n \"name\": \"PagosWeb\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagosWebPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagosWeb\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 44,\n \"name\": \"Venda Direta Debito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DebitDirectSalePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitDirectSale\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 45,\n \"name\": \"Venda Direta Credito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditDirectSalePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditDirectSale\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 46,\n \"name\": \"FichaDeposito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.FichaDepositoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 47,\n \"name\": \"Cash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.CashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"cash\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 48,\n \"name\": \"Credz\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.CredzPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(((636760)|(637032))\\\\d{0,10})$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 49,\n \"name\": \"PayPalPlus\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.PayPalPlus.PayPalPlusPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalPlus\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 50,\n \"name\": \"Rede Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RedePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RedePay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 51,\n \"name\": \"Lotérica\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.LotteryCashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"lottery\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 52,\n \"name\": \"Adyen\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AdyenHostedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"adyenHosted\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 53,\n \"name\": \"Itau Shopline\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.ItauShopLine.ItauShoplinePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ItauShopline\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 55,\n \"name\": \"OneBuy\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.IFramePayments.OneBuyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"OneBuy\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 56,\n \"name\": \"PaymentHub\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaymentHubPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PaymentHub\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 57,\n \"name\": \"TodoPago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TodoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TodoPago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 59,\n \"name\": \"PagosNet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagosNetPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagosNet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 60,\n \"name\": \"MeoWallet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MeoWalletPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MeoWallet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 64,\n \"name\": \"Customer Credit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.CreditControlPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditControl\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 65,\n \"name\": \"Mastercard Debit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.MastercardDebit\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^(502275|528745|(5045|5061|5062|5063|5064|5105|5111|5112|5117|5118|5122|5160|5161|5164|5165|5166|5174|5177|5188|5201|5204|5206|5235|5236|5240|5247|5256|5261|5263|5264|5280|5284|5285|5290|5295|5301|5306|5312|5324|5336|5339|5343|5349|5359|5367|5370|5379|5380|5384|5389|5399|5439|5452|5453|5457|5463|5496|5502|5508|5510|5512|5513|5514|5515|5534|5538|5541|5544|5546|5549|5559|5575|5576|5578|5579)[0-9]{2}|558426|559471|588772|589617|528733|549180|517562|551792|553771|553777)[0-9]{0,10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 66,\n \"name\": \"MultiBanco\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.MultiBancoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"multibanco\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 67,\n \"name\": \"PayMee\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayMeePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"payMee\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 68,\n \"name\": \"Livelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LiveloPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Livelo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 69,\n \"name\": \"Apple Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.ApplePay.ApplePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ApplePay\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 70,\n \"name\": \"MOLPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MOLPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MOLPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 71,\n \"name\": \"IPay88\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IPay88Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"IPay88\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 72,\n \"name\": \"PicPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PicPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"picPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 73,\n \"name\": \"Bitcoin\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CryptoCurrencyPayments.BitcoinPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bitcoin\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 74,\n \"name\": \"FutPag\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FutPagPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"futPag\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 75,\n \"name\": \"iBuy\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IBuyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"iBuy\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 76,\n \"name\": \"MobilPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MobilPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"mobilPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 77,\n \"name\": \"LayAway\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.LayAwayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"layaway\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 78,\n \"name\": \"PinCash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PinCashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pincash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 79,\n \"name\": \"Pago Fácil\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.PagoFacilPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 80,\n \"name\": \"Cobro Express\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.CobroExpressPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 81,\n \"name\": \"Rapipago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.RapipagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 82,\n \"name\": \"Multicaja\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MulticajaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Multicaja\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 83,\n \"name\": \"Baloto\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.BalotoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 84,\n \"name\": \"Efecty\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.EfectyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 86,\n \"name\": \"LevPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LevPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"levpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 87,\n \"name\": \"PagoLivre\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoLivrePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pagoLivre\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 88,\n \"name\": \"Pagomio\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagomioPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pagomio\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 89,\n \"name\": \"PlaceToPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PlaceToPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"placeToPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 90,\n \"name\": \"Losango\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LosangoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"losango\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 91,\n \"name\": \"SPEI\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SpeiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SPEI\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 92,\n \"name\": \"PayUTeFia\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayUTeFiaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayUTeFia\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 93,\n \"name\": \"BoletoFlex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoFlexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoFlex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 94,\n \"name\": \"SpinPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SpinPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SpinPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 95,\n \"name\": \"AmeDigital\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AmeDigitalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"AmeDigital\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 96,\n \"name\": \"PagSmile\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagSmilePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagSmile\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 97,\n \"name\": \"Affirm\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AffirmPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Affirm\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 98,\n \"name\": \"BACS Direct Debit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.BacsDirectDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 99,\n \"name\": \"VirtusPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtusPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtusPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 100,\n \"name\": \"Alelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.Alelo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"foodCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^((((401178)|(401179)|(431274)|(438935)|(451416)|(457393)|(457631)|(457632)|(504175)|(506699)|(627780)|(636297)|(636368))\\\\d{0,10})|((4576)|(4011)|(5067)|(6500)|(6504)|(6505)|(6507)|(6509)|(6516)|(6550))\\\\d{0,12}|(509)\\\\d{0,13})$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 101,\n \"name\": \"Wipei\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WipeiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Wipei\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 102,\n \"name\": \"Addi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AddiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Addi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 103,\n \"name\": \"OXXO\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.OxxoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 104,\n \"name\": \"Lendico\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LendicoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Lendico\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 105,\n \"name\": \"Satispay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SatispayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Satispay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 106,\n \"name\": \"Klarna\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlarnaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klarna\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 107,\n \"name\": \"Samsung Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.SamsungPay.SamsungPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SamsungPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 108,\n \"name\": \"ItauCrediario\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ItauCrediarioPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ItauCrediario\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 109,\n \"name\": \"Paylands\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaylandsPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Paylands\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 110,\n \"name\": \"FlowFinance\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FlowFinancePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"FlowFinance\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 111,\n \"name\": \"WompiCo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiCoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiCo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 112,\n \"name\": \"55Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FiveFivePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"55Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 113,\n \"name\": \"Cartão de débito virtual Caixa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.VirtualDebitElo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"virtualDebitElo\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^(506722(8|9)|(509023|509105|509030)\\\\d)\\\\d{9}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 114,\n \"name\": \"Siman\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SimanPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Siman\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 115,\n \"name\": \"Finago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FinagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Finago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 116,\n \"name\": \"UnDosTres\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.UnDosTresPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"UnDosTres\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 117,\n \"name\": \"SweetPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SweetPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SweetPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 118,\n \"name\": \"SisteCredito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SisteCreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SisteCredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 119,\n \"name\": \"Aplazame\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AplazamePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Aplazame\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 120,\n \"name\": \"Serfinsa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SerfinsaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Serfinsa\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 121,\n \"name\": \"Parcelex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ParcelexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Parcelex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 122,\n \"name\": \"SumasPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SumasPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SumasPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 123,\n \"name\": \"Chek\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ChekPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Chek\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 124,\n \"name\": \"Klarna Pay Now\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlarnaPayNowPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klarna Pay Now\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 125,\n \"name\": \"Pix\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PixPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"instantPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 126,\n \"name\": \"MercadoPagoWallet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoWalletPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPagoWallet\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 127,\n \"name\": \"MercadoPagoPro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoProPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPagoPro\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 128,\n \"name\": \"Surtidora Departamental\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SurtidoraDepartamentalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SurtidoraDepartamental\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 129,\n \"name\": \"Ideal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IdealPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ideal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 130,\n \"name\": \"PuntosColombia\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PuntosColombiaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PuntosColombia\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 131,\n \"name\": \"Paguelofacil\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaguelofacilPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Paguelofacil\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 132,\n \"name\": \"KahshPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KahshPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"KahshPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 133,\n \"name\": \"DigitalRiver\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DigitalRiverPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DigitalRiver\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 134,\n \"name\": \"VisaconPuntos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VisaconPuntosPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VisaconPuntos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 135,\n \"name\": \"ETPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ETPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ETPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 136,\n \"name\": \"TuyaPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TuyaPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TuyaPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 137,\n \"name\": \"Transbank Oneclick\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TransbankOneclickPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TransbankOneclick\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 138,\n \"name\": \"PagDividido\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.WalletPayments.PagDivididoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagDividido\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 139,\n \"name\": \"BraintreePayPal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreePaypalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BraintreePayPal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 140,\n \"name\": \"BrainTreePayPalDebito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BrainTreePayPalDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BrainTreePayPalDebit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 141,\n \"name\": \"BoletoParceladoKoin\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoParceladoKoinPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoParceladoKoin\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 142,\n \"name\": \"MBWay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MBWayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MBWay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 143,\n \"name\": \"Worldpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Worldpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 144,\n \"name\": \"AmazonPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AmazonPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"AmazonPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 145,\n \"name\": \"RazorPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RazorPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RazorPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 146,\n \"name\": \"Tinkoff\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TinkoffPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Tinkoff\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 147,\n \"name\": \"BomPraCredito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BomPraCreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BomPraCredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 148,\n \"name\": \"Lyra\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LyraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Lyra\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 149,\n \"name\": \"Aeropay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AeropayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Aeropay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 150,\n \"name\": \"Bizum\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BizumPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bizum\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 151,\n \"name\": \"Borica\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoricaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Borica\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 152,\n \"name\": \"PayPalCP\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalCPPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalCP\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 153,\n \"name\": \"Splitit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SplititPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Splitit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 154,\n \"name\": \"NetPayCheckout\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NetPayCheckoutPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"NetPayCheckout\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 155,\n \"name\": \"Payware\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaywarePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Payware\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 156,\n \"name\": \"MercadoPagoOff\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoOffPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPagoOff\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 157,\n \"name\": \"QPayPro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QPayProPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"QPayPro\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 158,\n \"name\": \"Points FAC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PointsFACPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Points FAC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 159,\n \"name\": \"3DSFAC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FAC3DSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"3DSFAC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 160,\n \"name\": \"BitfyBr\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BitfyBrPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BitfyBr\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 161,\n \"name\": \"Stripe\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.StripePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Stripe\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 162,\n \"name\": \"Blik\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BlikPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Blik\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 163,\n \"name\": \"Scalapay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ScalapayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Scalapay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 164,\n \"name\": \"PayU Redirect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayURedirectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayURedirect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 165,\n \"name\": \"Mollie\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MolliePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Mollie\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 166,\n \"name\": \"SmartUcf\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SmartUcfPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SmartUcf\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 167,\n \"name\": \"Cashback\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CashbackPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cashback\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 168,\n \"name\": \"Mobbex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MobbexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Mobbex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 169,\n \"name\": \"Google Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GooglePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Google Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 170,\n \"name\": \"Sequra\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SequraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Sequra\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 171,\n \"name\": \"Bamboo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BambooPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bamboo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 172,\n \"name\": \"Pagaleve\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 173,\n \"name\": \"Quatro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QuatroPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Quatro\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 174,\n \"name\": \"Aplazo Payment\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AplazoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"aplazo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 175,\n \"name\": \"Nelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NeloPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nelo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 176,\n \"name\": \"aCuotaz\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ACuotazPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"aCuotaz\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 177,\n \"name\": \"GOcuotas\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GOcuotasPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"GOcuotas\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 178,\n \"name\": \"Nubank\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NubankPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nubank\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 179,\n \"name\": \"Zaincash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZaincashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zaincash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 180,\n \"name\": \"Mach\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MachPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Mach\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 181,\n \"name\": \"Slightpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SlightpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"slightpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 182,\n \"name\": \"OsowEFT\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.OsowEFTPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"OsowEFT\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 183,\n \"name\": \"CardConnect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CardConnectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CardConnect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 184,\n \"name\": \"Switch HyperPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SwitchHyperPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Switch HyperPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 185,\n \"name\": \"Servicredito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ServicreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Servicredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 186,\n \"name\": \"Plata Ya Crédito (PYC)\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PlataYaCreditoPYCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Plata Ya Crédito (PYC)\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 187,\n \"name\": \"Modo Payment\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ModoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Modo Payment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 188,\n \"name\": \"Qicard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QicardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Qicard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 189,\n \"name\": \"Pinelabs\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PinelabsPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pinelabs\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 190,\n \"name\": \"Cetelem\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CetelemPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cetelem\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 191,\n \"name\": \"Angeloni\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AngeloniPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Angeloni\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 192,\n \"name\": \"BoletoParceladoParcelaSim\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoParceladoParcelaSimPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoParceladoParcelaSim\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 193,\n \"name\": \"Shieldgate-MX\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ShieldgateMXPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Shieldgate-MX\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 194,\n \"name\": \"Klap\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlapPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klap\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 195,\n \"name\": \"ZIP\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZIPPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ZIP\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 196,\n \"name\": \"Astropay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AstropayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Astropay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 197,\n \"name\": \"Cencosud Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CencosudPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cencosud Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 198,\n \"name\": \"Pagaleve Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagaleveTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve Transparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 199,\n \"name\": \"Bancolombia Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancolombiaTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bancolombia Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 601,\n \"name\": \"CardPromissory\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.CardPromissoryPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"cardPromissory\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 701,\n \"name\": \"PSE\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PSEPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PSE\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [\n \"vtexlatam.banks-for-pse@2.x\"\n ],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 702,\n \"name\": \"DMPag\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DMPagPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DMPag\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 703,\n \"name\": \"NANOPLAZOS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NANOPLAZOSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"NANOPLAZOS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 704,\n \"name\": \"StripeConnect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.StripeConnectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"StripeConnect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 705,\n \"name\": \"Nequi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NequiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nequi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 706,\n \"name\": \"Daviplata\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DaviplataPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Daviplata\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 707,\n \"name\": \"Provu\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ProvuPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Provu\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 708,\n \"name\": \"Mercado Credito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoCreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoCredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 709,\n \"name\": \"Ventipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VentipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ventipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 710,\n \"name\": \"Recaudo Efectivo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RecaudoEfectivoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RecaudoEfectivo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 711,\n \"name\": \"Payválida\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayválidaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Payválida\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 712,\n \"name\": \"Pagaleve Pix A Vista\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixAVistaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagalevePixAVista\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 713,\n \"name\": \"Pagaleve Pix A Vista Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixAVistaTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagalevePixAVistaTransparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 714,\n \"name\": \"Brilla\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BrillaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Brilla\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 715,\n \"name\": \"Alma\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AlmaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Alma\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 716,\n \"name\": \"Chargeafter\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ChargeafterPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Chargeafter\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 717,\n \"name\": \"Credito Bodesa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoBodesaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CreditoBodesa\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 718,\n \"name\": \"Flywire\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FlywirePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Flywire\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 719,\n \"name\": \"Paga con Rappi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagaconRappiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagaconRappi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 720,\n \"name\": \"MazdaSantander\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MazdaSantanderPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MazdaSantander\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 721,\n \"name\": \"carnê banQi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.carnebanQiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"carnebanQi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 722,\n \"name\": \"Credit Key\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditKeyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CreditKey\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 723,\n \"name\": \"Wepay4u\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Wepay4uPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Wepay4u\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 724,\n \"name\": \"VirtusPay Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtusPayTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtusPayTransparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 725,\n \"name\": \"Drip\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DripPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Drip\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 726,\n \"name\": \"Wompi - Nequi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiNequiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiNequi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 727,\n \"name\": \"Wompi - PSE\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiPSEPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiPSE\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 728,\n \"name\": \"Wompi - Corresponsales\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiCorresponsalesPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiCorresponsales\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 729,\n \"name\": \"Epay Credit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayCreditPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayCredit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 730,\n \"name\": \"Epay Debit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayDebit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 731,\n \"name\": \"Epay CAT\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayCATPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayCAT\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 732,\n \"name\": \"Epay GC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayGCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayGC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 733,\n \"name\": \"Epay Puntos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayPuntosPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayPuntos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 734,\n \"name\": \"Epay Prepay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayPrepayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayPrepay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 735,\n \"name\": \"Epay Redirect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayRedirectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayRedirect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 736,\n \"name\": \"worldline SIPS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.worldlineSIPSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"worldlineSIPS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 737,\n \"name\": \"TiendaCrypto API Commerce\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TiendaCryptoAPICommercePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TiendaCryptoAPICommerce\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 738,\n \"name\": \"Cartão de Crédito por SIBS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CartaoDeCreditoPorSIBSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CartaoDeCreditoPorSIBS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 739,\n \"name\": \"bancolombia-bnpl\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancolombiaBnplPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BancolombiaBnpl\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 740,\n \"name\": \"Delego\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DelegoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Delego\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 741,\n \"name\": \"Bancolombia Collect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancolombiaCollectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BancolombiaCollect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 742,\n \"name\": \"PayPalCheckout\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalCheckoutPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalCheckout\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 743,\n \"name\": \"PayPalRT\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalRTPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalRT\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 744,\n \"name\": \"PayPalOXXO\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalOXXOPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalOXXO\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 745,\n \"name\": \"dimo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DimoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"dimo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 746,\n \"name\": \"RetryPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RetryPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RetryPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 747,\n \"name\": \"Convênios Clamed\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ConveniosClamedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ConveniosClamed\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 748,\n \"name\": \"Qhantuy\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QhantuyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Qhantuy\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 749,\n \"name\": \"Personal Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PersonalCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PersonalCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 750,\n \"name\": \"FCamara - Iniciador de pagamentos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FCamaraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"FCamara - Iniciador de pagamentos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 751,\n \"name\": \"MoreTyme\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MoreTymePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MoreTyme\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 752,\n \"name\": \"DeunaNow\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DeunaNowPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DeunaNow\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 753,\n \"name\": \"P24\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.P24Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"P24\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 754,\n \"name\": \"Jet card / RCS Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.JetCardRCSCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"JetCardRCSCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 755,\n \"name\": \"Elo Débito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.DebitElo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^(40117[8-9]|438935|451416|457393|45763[1-2]|50672[0-24-9]|50673[0-24-6]|50674[4-7]|506753|50677[57]|50900[0-3]|509023|509030|50906[57-9]|509073|50908[1-3]|50909[13]|50910[4-5]|50914[7-9]|50915[1-26-8]|50918[37-8]|50922[02]|509274|509288|50955[0-1]|509636|50972[4-57]|627780|65003[1-258]|65004[026]|650069|65007[0178]|65048[7-9]|65049[12459]|650508|650525|65052[7-9]|650530|65056[2-37-9]|65057[01]|65058[46]|65059[1257]|650907|650938|65094[8-9]|650951|65096[7-9]|650970|651653|65165[7-8]|65166[58]|65167[013468]|651688|65500[138]|65501[568]|65503[6-8]|506748|509049|50907[256]|50908[56]|50909[4-6]|5091[123]\\\\d|50914[0-5]|509150|509159|5091[67]\\\\d|50918[0-2]|50918[45]|50919\\\\d|5092[01]\\\\d|509221|509223|50922[4-9]|5092[34]\\\\d|50925[0-6]|50950[7-9]|5095[1-4]\\\\d|50955[2-9]|5095[6-9]\\\\d|5096[0-2]\\\\d|50963[0-5]|50963[7-9]|5096[4-9]\\\\d|5097[01]\\\\d|50972[01]|50973[013-9]|5097[45]\\\\d|50976[0-4]|65003[3679]|65004[13-57]|650062|65007[2-69]|65008[01]|65057[2-6]|650585|65095[2369]|65096[01]|65097[23]|65097[4-8]|65165[45]|65166[1349]|651672|65168[0-79]|65169\\\\d|65170[1-4]|65500[24]|655010|65501[47]|655039|65504\\\\d|655050)\\\\d{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 756,\n \"name\": \"lamarinamx\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LamarinamxPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"lamarinamx\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 757,\n \"name\": \"Kaiowa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KaiowaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Kaiowa\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 758,\n \"name\": \"Sured\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SuredPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Sured\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 759,\n \"name\": \"Pix com Open Finance\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PixCOpenFinancePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pix com Open Finance\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 760,\n \"name\": \"GingaPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GingaPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"GingaPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 761,\n \"name\": \"Online Banking Poland\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.OnlineBankingPolandPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Online Banking Poland\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 762,\n \"name\": \"kushki - Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KushkiTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"kushki - Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 763,\n \"name\": \"Buy Now Pay Later Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BuyNowPayLaterMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Buy Now Pay Later Mercado Pago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 764,\n \"name\": \"CoppelPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CoppelPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CoppelPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 765,\n \"name\": \"Paycash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaycashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Paycash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 766,\n \"name\": \"MSC Payment\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MSCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MSC Payment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 767,\n \"name\": \"99Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments._99PayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"99Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 768,\n \"name\": \"Windcave\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WindcavePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Windcave\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 769,\n \"name\": \"Boleto Parcelado Multiloja\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoParceladoMultilojaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoParceladoMultiloja\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 770,\n \"name\": \"Inswitch\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.InswitchPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Inswitch\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 771,\n \"name\": \"Easypay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EasypayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Easypay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 772,\n \"name\": \"WorldlineMercadoPago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldlineMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WorldlineMercadoPago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 773,\n \"name\": \"WorldlinePayPal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldlinePayPalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WorldlinePayPal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 774,\n \"name\": \"Worldline Global Collect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldlineGlobalCollectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WorldlineGlobalCollect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 775,\n \"name\": \"2C2P\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments._2C2PPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"2C2P\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 776,\n \"name\": \"APM_PagoEfectivo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.APM_PagoEfectivoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"APM_PagoEfectivo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 777,\n \"name\": \"Kushki - Cash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KushkiCashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Kushki - Cash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 778,\n \"name\": \"Bash Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BashPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bash Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 779,\n \"name\": \"Stitch\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.StitchPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Stitch\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 780,\n \"name\": \"Bank Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BankTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bank Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 781,\n \"name\": \"PayPalBCDC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalBCDCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalBCDC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 782,\n \"name\": \"Cencopay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CencopayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cencopay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 783,\n \"name\": \"Cencopay Saldo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CencopaySaldoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cencopay Saldo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 784,\n \"name\": \"DiDi Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DiDiPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DiDi Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 785,\n \"name\": \"Nexi XPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NexiXPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nexi XPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 786,\n \"name\": \"Fintoc\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FintocPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Fintoc\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 787,\n \"name\": \"Kushki - Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KushkiCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Kushki - Card\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 788,\n \"name\": \"Zenkipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZenkipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zenkipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 789,\n \"name\": \"Cartes Bancaires (CB)\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.CartesBancaires\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^[0-9]{16}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 790,\n \"name\": \"Yuno Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Card\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 791,\n \"name\": \"Yuno Bank Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoBankTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Bank Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 792,\n \"name\": \"Yuno Buy Now Pay Later\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoBuyNowPayLaterPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Buy Now Pay Later\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 793,\n \"name\": \"Yuno Payment Link\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoPaymentLinkPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Payment Link\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 794,\n \"name\": \"Yuno Ticket\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoTicketPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Ticket\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 795,\n \"name\": \"Yuno Wallet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoWalletPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Wallet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 796,\n \"name\": \"Braintree-ApplePay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreeApplePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Braintree-ApplePay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 797,\n \"name\": \"PayPalACDC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalACDCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalACDC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 798,\n \"name\": \"ITP\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ITPPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ITP\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 799,\n \"name\": \"BNPL\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BNPLPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BNPL\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 800,\n \"name\": \"Woovi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WooviPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Woovi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 801,\n \"name\": \"Braintree-GooglePay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreeGooglePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Braintree-GooglePay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 802,\n \"name\": \"Braintree-Venmo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreeVenmoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Braintree-Venmo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 803,\n \"name\": \"Dapp\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DappPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Dapp\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 804,\n \"name\": \"Guatapay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GuatapayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Guatapay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 805,\n \"name\": \"TarjetaEstilos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TarjetaEstilosPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TarjetaEstilos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 806,\n \"name\": \"Powerpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PowerpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Powerpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 807,\n \"name\": \"Culqi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CulqiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Culqi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 808,\n \"name\": \"Voucher\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.VoucherPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"(50671500|50905500|50905700|50905800|50905900|50906000|50906100|50906300|50925902|50926400|50928400|50928500|50929100|50935700|50942200|50946300)[0-9]{8}|1(0(0(0(0([0-9])|[1-9][0-9]{7})|[1-9][0-9]{8})|[1-9][0-9]{9})|[1-9][0-9]{10})|9(9(9(9(9([0-9])|[0-8][0-9]{7})|[0-8][0-9]{8})|[0-8][0-9]{9})|[0-8][0-9]{10})|[2-8][0-9]{11}\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 809,\n \"name\": \"Carrefour\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CarrefourPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Carrefour\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 810,\n \"name\": \"CredSystem\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CredSystemPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CredSystem\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 811,\n \"name\": \"DMCard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DMCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DMCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 812,\n \"name\": \"Belvo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BelvoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Belvo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 813,\n \"name\": \"Zapper\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZapperPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zapper\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 814,\n \"name\": \"Ebucks\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EbucksPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ebucks\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 815,\n \"name\": \"Discovery Miles\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DiscoveryMilesPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Discovery Miles\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 816,\n \"name\": \"Zenkipay - Pay with Crypto\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZenkipayCryptoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zenkipay - Pay with Crypto\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 817,\n \"name\": \"Masterpass\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MasterpassPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Masterpass\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 818,\n \"name\": \"Snapscan\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SnapscanPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Snapscan\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 819,\n \"name\": \"DirectDebit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DirectDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DirectDebitPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 820,\n \"name\": \"VirtualIBAN\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtualIBANPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtualIBANPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 821,\n \"name\": \"UniversoFlex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.UniversoFlexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"UniversoFlexPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 822,\n \"name\": \"SantanderConsumer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SantanderConsumerPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SantanderConsumerPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 823,\n \"name\": \"dimoFinancing\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DimoFinancingPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"dimoFinancing\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 824,\n \"name\": \"Ceibo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CeiboPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ceibo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 825,\n \"name\": \"Woovi Parcelado\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WooviParceladoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Woovi Parcelado\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 826,\n \"name\": \"ArgonPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ArgonPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ArgonPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 827,\n \"name\": \"Crypto\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CryptoCurrencyPayments.CryptoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Crypto\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 828,\n \"name\": \"A2A\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.A2APayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"A2A\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 829,\n \"name\": \"Tino\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TinoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Tino\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 830,\n \"name\": \"izipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IzipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"izipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 831,\n \"name\": \"Clip\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ClipPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Clip\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 832,\n \"name\": \"Banese\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BanesePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Banese\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 833,\n \"name\": \"BrasilCard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BrasilCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BrasilCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 834,\n \"name\": \"Bancontact\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancontactPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bancontact\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 835,\n \"name\": \"OrkestaPay Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.OrkestaPayCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"OrkestaPay Card\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 836,\n \"name\": \"Cuotealo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CuotealoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cuotealo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 837,\n \"name\": \"PagoClasico\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoClasicoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagoClasico\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 838,\n \"name\": \"Credito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 839,\n \"name\": \"C2P\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.C2PPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"C2P\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 840,\n \"name\": \"P2C\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.P2CPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"P2C\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 841,\n \"name\": \"Credito Inmediato\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoInmediatoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito Inmediato\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 842,\n \"name\": \"Zelle\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZellePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zelle\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 843,\n \"name\": \"MagaluPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MagaluPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MagaluPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 844,\n \"name\": \"Geru\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GeruPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Geru\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 845,\n \"name\": \"Credito Mendels\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoMendelsPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito Mendels\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 846,\n \"name\": \"Conekta\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ConektaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Conekta\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 847,\n \"name\": \"Pagaleve Pix Mensal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixMensalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve Pix Mensal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 848,\n \"name\": \"Pagaleve Pix Mensal Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixMensalTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve Pix Mensal Transparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 849,\n \"name\": \"Plata Difiere\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PlataDifierePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Plata Difiere\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 850,\n \"name\": \"Directo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DirectoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Directo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 851,\n \"name\": \"Transfero Checkout\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TransferoCheckoutPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Transfero Checkout\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 852,\n \"name\": \"PayWay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayWayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayWay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 853,\n \"name\": \"Ideal V3\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IdealV3Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ideal V3\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 854,\n \"name\": \"PayZen\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayZenPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayZen\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 855,\n \"name\": \"AddiMarketplace\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AddiMarketplacePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"AddiMarketplace\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 856,\n \"name\": \"ProntoPaga\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ProntoPagaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ProntoPaga\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 857,\n \"name\": \"VirtualPOS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtualPOSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtualPOS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 858,\n \"name\": \"Pago por QR BAZ\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoporQRBAZPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pago por QR BAZ\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 859,\n \"name\": \"Pago referenciado BAZ\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoreferenciadoBAZPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pago referenciado BAZ\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 860,\n \"name\": \"Pago Deeplink BAZ\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoDeeplinkBAZPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pago Deeplink BAZ\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 861,\n \"name\": \"Apipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ApipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Apipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 862,\n \"name\": \"Scalapay Pay in 3\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ScalapayPayIn3Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Scalapay Pay in 3\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 863,\n \"name\": \"Scalapay Pay in 4\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ScalapayPayIn4Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Scalapay Pay in 4\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 864,\n \"name\": \"Blix\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BlixPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Blix\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 865,\n \"name\": \"Niubiz\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NiubizPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Niubiz\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 866,\n \"name\": \"Klarna Pay Later\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlarnaPayLaterPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klarna Pay Later\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 867,\n \"name\": \"facilypay_3x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay3xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_3x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 868,\n \"name\": \"facilypay_4x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay4xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_4x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 869,\n \"name\": \"facilypay_10x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay10xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_10x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 870,\n \"name\": \"facilypay_12x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay12xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_12x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 871,\n \"name\": \"PidekyEscala\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PidekyEscalaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PidekyEscala\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 872,\n \"name\": \"Spin MX\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SpinMXPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Spin MX\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 873,\n \"name\": \"FGTS - Quality Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FGTSQualityPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"FGTS - Quality Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 874,\n \"name\": \"Bancontact Mobile\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancontactMobilePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bancontact Mobile\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 875,\n \"name\": \"Yape Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YapeMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yape Mercado Pago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 876,\n \"name\": \"Red Servi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RedServiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Red Servi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 877,\n \"name\": \"Punto Red\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PuntoRedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Punto Red\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 878,\n \"name\": \"Gana\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GanaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Gana\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 879,\n \"name\": \"Pix Parcelado by PayMee\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PixParceladobyPayMeePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pix Parcelado by PayMee\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 880,\n \"name\": \"Flex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FlexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Flex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 881,\n \"name\": \"Fiserv\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FiservPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Fiserv\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 882,\n \"name\": \"Visa Click To Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VisaClickToPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Visa Click To Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 883,\n \"name\": \"Azteca\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AztecaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Azteca\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 884,\n \"name\": \"CrediPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CrediPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CrediPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 885,\n \"name\": \"Epay Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Epay Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 886,\n \"name\": \"Nave QR\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NaveQRPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nave QR\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 887,\n \"name\": \"BCI\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BCIPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BCI\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 888,\n \"name\": \"SEPA\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SEPAPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SEPA\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 889,\n \"name\": \"CoDi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CoDiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CoDi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 890,\n \"name\": \"TipTopPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TipTopPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TipTopPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 891,\n \"name\": \"RedPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RedPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RedPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 892,\n \"name\": \"Baccredomatic\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BaccredomaticPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Baccredomatic\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 893,\n \"name\": \"Creditea\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CrediteaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Creditea\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 894,\n \"name\": \"Findomestic\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FindomesticPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Findomestic\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 895,\n \"name\": \"Novaera\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NovaeraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Novaera\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 896,\n \"name\": \"Ecart Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EcartPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ecart Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 897,\n \"name\": \"Credito Leather Lovers\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoLeatherLoversPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito Leather Lovers\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 898,\n \"name\": \"Fintoc Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FintocMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Fintoc Mercado Pago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 899,\n \"name\": \"EpaycoTransparent\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpaycoTransparentPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpaycoTransparent\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 900,\n \"name\": \"WH Google Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.WalletHubPayments.WHGooglePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WH Google Pay\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 901,\n \"name\": \"WH Apple Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.WalletHubPayments.WHApplePay.WHApplePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WH Apple Pay\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 1000,\n \"name\": \"EpaycoRedirect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpaycoRedirectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpaycoRedirect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 1001,\n \"name\": \"PaypalACDCV2\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaypalACDCV2Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PaypalACDCV2\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 1002,\n \"name\": \"Carnet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CarnetPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Carnet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 201,\n \"name\": \"Dinheiro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.PromissoryPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"custom201PaymentGroup\",\n \"redirect\": false,\n \"isCustom\": true,\n \"isSelfAuthorized\": true,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": \"Pague no dinheiro\",\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-04T13:32:40.6778434Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n }\n]" + } + ] + }, + { + "name": "List Collections", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/catalog_system/pvt/collection/search", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "catalog_system", + "pvt", + "collection", + "search" + ] + }, + "description": "**Official Documentation**: [VTEX Catalog API - GET /api/catalog_system/pvt/collection/search](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/collection/search?endpoint=get-/api/catalog_system/pvt/collection/search)\n\nThis API endpoint allows retrieving catalog collection data from a VTEX account.\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/catalog_system/pvt/collection/search\n\n ```\n\n### Response\n\nA successful response returns a JSON object containing pagination information and an array of catalog collection items.\n\n#### Example Response\n\n``` json\n{\n \"paging\": {\n \"page\": 0,\n \"perPage\": 0,\n \"total\": 0,\n \"pages\": 0,\n \"limit\": 0\n },\n \"items\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"searchable\": true,\n \"highlight\": true,\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"totalSku\": 0,\n \"totalProducts\": 0,\n \"type\": \"\",\n \"lastModifiedBy\": null\n }\n ]\n}\n\n ```\n\n### Fields Description\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `paging.page` | number | Current page number. |\n| `paging.perPage` | number | Number of items per page. |\n| `paging.total` | number | Total number of items available. |\n| `paging.pages` | number | Total number of pages available. |\n| `paging.limit` | number | Maximum number of items per page. |\n| `items` | array | Array of collection objects. |\n| `items[].id` | number | ID of the collection. |\n| `items[].name` | string | Name of the collection. |\n| `items[].searchable` | boolean | Indicates if the collection is searchable. |\n| `items[].highlight` | boolean | Indicates if the collection is highlighted. |\n| `items[].dateFrom` | string | Start date of the collection's validity. |\n| `items[].dateTo` | string | End date of the collection's validity. |\n| `items[].totalSku` | number | Total number of SKUs in the collection. |\n| `items[].totalProducts` | number | Total number of products in the collection. |\n| `items[].type` | string | Type of the collection. |\n| `items[].lastModifiedBy` | string/null | User who last modified the collection, if available. |\n\nThis endpoint provides useful information to manage and view catalog collections with pagination support." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/catalog_system/pvt/collection/search", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "catalog_system", + "pvt", + "collection", + "search" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Tue, 25 Mar 2025 13:39:11 GMT" + }, + { + "key": "Content-Encoding", + "value": "gzip" + }, + { + "key": "Vary", + "value": "Accept-Encoding" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "catalogapi-v3.8.11" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-21-30" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.036" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.036" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8925b71bb3654008054231e03eaa658c.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "JqQHOpNuY_gnUOamyfA7oliKXJJfNh7VjDQhJM5tc7acuEBlD60VXg==" + } + ], + "cookie": [], + "body": "{\n \"paging\": {\n \"page\": 1,\n \"perPage\": 1,\n \"total\": 1,\n \"pages\": 1,\n \"limit\": 3000\n },\n \"items\": [\n {\n \"id\": 137,\n \"name\": \"LeroLero\",\n \"searchable\": false,\n \"highlight\": false,\n \"dateFrom\": \"2025-02-12T14:27:00\",\n \"dateTo\": \"2074-02-12T14:27:00\",\n \"totalSku\": 2,\n \"totalProducts\": 2,\n \"type\": \"Manual\",\n \"lastModifiedBy\": null\n }\n ]\n}" + } + ] + }, + { + "name": "List Credit Cards via Checkout", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/checkout/pub/profiles?email={{email}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "checkout", + "pub", + "profiles" + ], + "query": [ + { + "key": "email", + "value": "{{email}}" + } + ] + }, + "description": "**Official Documentation**: [VTEX Checkout API - GET /api/checkout/pub/profiles](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/profiles)\n\nThis API endpoint retrieves the checkout profiles associated with a given email from the VTEX platform.\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/checkout/pub/profiles?email={{email}}\n\n ```\n\n### Response\n\nA successful response returns a JSON object with the user's profile information, available accounts, addresses, and contact details.\n\n#### Example Response\n\n``` json\n{\n \"userProfileId\": \"\",\n \"profileProvider\": \"\",\n \"availableAccounts\": [\n {\n \"accountId\": \"\",\n \"paymentSystem\": \"\",\n \"paymentSystemName\": \"\",\n \"cardNumber\": \"\",\n \"bin\": \"\",\n \"availableAddresses\": [\"\"],\n \"expirationDate\": \"\",\n \"isExpired\": true,\n \"accountStatus\": null\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"\",\n \"receiverName\": \"\",\n \"addressId\": \"\",\n \"isDisposable\": true,\n \"postalCode\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": []\n }\n ],\n \"contactInformation\": [],\n \"contacts\": [],\n \"contactsInfo\": [],\n \"userProfile\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"document\": \"\",\n \"documentType\": \"\",\n \"phone\": \"\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": true,\n \"profileCompleteOnLoading\": null,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"isComplete\": true\n}\n\n ```\n\n### Fields Description\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `userProfileId` | string | Unique identifier of the user profile. |\n| `profileProvider` | string | Profile provider source. |\n| `availableAccounts` | array | Array of available payment accounts. |\n| `availableAccounts[].accountId` | string | Account ID for the payment method. |\n| `availableAccounts[].paymentSystem` | string | Payment system ID. |\n| `availableAccounts[].paymentSystemName` | string | Name of the payment system. |\n| `availableAccounts[].cardNumber` | string | Masked card number. |\n| `availableAccounts[].bin` | string | Card BIN (first digits of the card). |\n| `availableAccounts[].availableAddresses` | array | Associated address IDs. |\n| `availableAccounts[].expirationDate` | string | Card expiration date. |\n| `availableAccounts[].isExpired` | boolean | Indicates whether the card is expired. |\n| `availableAccounts[].accountStatus` | string/null | Account status, if applicable. |\n| `availableAddresses` | array | List of user addresses. |\n| `availableAddresses[].addressType` | string | Type of address (e.g., residential, billing). |\n| `availableAddresses[].receiverName` | string | Name of the address receiver. |\n| `availableAddresses[].addressId` | string | ID of the address. |\n| `availableAddresses[].isDisposable` | boolean | Indicates if the address is disposable. |\n| `availableAddresses[].postalCode` | string | Postal code. |\n| `availableAddresses[].city` | string | City name. |\n| `availableAddresses[].state` | string | State abbreviation. |\n| `availableAddresses[].country` | string | Country code. |\n| `availableAddresses[].street` | string | Street name. |\n| `availableAddresses[].number` | string | Street number. |\n| `availableAddresses[].neighborhood` | string | Neighborhood name. |\n| `availableAddresses[].complement` | string/null | Complement field. |\n| `availableAddresses[].reference` | string/null | Reference info. |\n| `availableAddresses[].geoCoordinates` | array | Geographic coordinates. |\n| `contactInformation` | array | List of contact information fields (deprecated). |\n| `contacts` | array | Contact details. |\n| `contactsInfo` | array | Detailed contact information. |\n| `userProfile` | object | Object containing user profile data. |\n| `userProfile.email` | string | Email address. |\n| `userProfile.firstName` | string | First name. |\n| `userProfile.lastName` | string | Last name. |\n| `userProfile.document` | string | Document number. |\n| `userProfile.documentType` | string | Type of document (e.g., CPF, CNPJ). |\n| `userProfile.phone` | string | Phone number. |\n| `userProfile.corporateName` | string/null | Corporate name (for B2B users). |\n| `userProfile.tradeName` | string/null | Trade name. |\n| `userProfile.corporateDocument` | string/null | Corporate document number. |\n| `userProfile.stateInscription` | string/null | State inscription. |\n| `userProfile.corporatePhone` | string/null | Corporate phone number. |\n| `userProfile.isCorporate` | boolean | Indicates if the profile is corporate. |\n| `userProfile.profileCompleteOnLoading` | boolean/null | Whether profile was complete on loading. |\n| `userProfile.profileErrorOnLoading` | boolean/null | Whether profile had errors on loading. |\n| `userProfile.customerClass` | string/null | Customer class, if defined. |\n| `isComplete` | boolean | Indicates if the profile is complete. |\n\nThis endpoint is useful for retrieving a customer's saved profile and contextual purchase details during the checkout flow." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.myvtex.com/api/checkout/pub/profiles?email={{email}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "myvtex", + "com" + ], + "path": [ + "api", + "checkout", + "pub", + "profiles" + ], + "query": [ + { + "key": "email", + "value": "{{email}}" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Tue, 25 Mar 2025 14:04:50 GMT" + }, + { + "key": "Cache-Control", + "value": "no-store,no-cache,must-revalidate" + }, + { + "key": "Content-Encoding", + "value": "gzip" + }, + { + "key": "Pragma", + "value": "no-store,no-cache" + }, + { + "key": "Vary", + "value": "Accept-Encoding" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "chk-v2.333.0" + }, + { + "key": "x-vtex-operation-id", + "value": "9bf92000-3d0e-4417-bbdd-d214d854cafe" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-56-114" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.787" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.784" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 5013aa2969ca99b3a9a086e23ddf216a.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "RX1Nxwo3YzkySxNa5oTm89jObNXFjq8WWTXhIlQcYCLLWeZs5KLh-w==" + } + ], + "cookie": [], + "body": "{\n \"userProfileId\": \"e607f3bf-2ee4-11e8-81cd-0a9938145238\",\n \"profileProvider\": \"QA Store\",\n \"availableAccounts\": [\n {\n \"accountId\": \"E3263B9493B34087A93B0265410BE177\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"444433\",\n \"availableAddresses\": [\n \"a2d8a83b6b0d43bfb12b76c85ba8e822\"\n ],\n \"expirationDate\": \"03/2021\",\n \"isExpired\": true,\n \"accountStatus\": null\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Saul Goodman\",\n \"addressId\": \"a2d8a83b6b0d43bfb12b76c85ba8e822\",\n \"isDisposable\": false,\n \"postalCode\": \"21050-454\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Avenida Dom Hélder Câmara\",\n \"number\": \"34\",\n \"neighborhood\": \"Maria da Graça\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": []\n }\n ],\n \"contactInformation\": [],\n \"contacts\": [],\n \"contactsInfo\": [],\n \"userProfile\": {\n \"email\": \"userautomated0.3313241773905462@mailinator.com\",\n \"firstName\": \"Saul\",\n \"lastName\": \"Goodman\",\n \"document\": \"26927864083\",\n \"documentType\": \"cpf\",\n \"phone\": \"+552222222222\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": null,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"isComplete\": true\n}" + } + ] + }, + { + "name": "ALTERNATIVE Get BK / List Credit Cards", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/BK/search?userId={{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "BK", + "search" + ], + "query": [ + { + "key": "userId", + "value": "{{contractId}}" + } + ] + }, + "description": "**Official Documentation**: Not officially documented — alternative retrieval method.\n\nThis endpoint provides an alternative way to retrieve credit card information by querying the `BK` data entity using the `userId` (contract ID).\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/dataentities/BK/search?userId={{contractId}}\n\n ```\n\n> No request body is required. \n \n\n### Response\n\nReturns a `200 OK` status with an array of objects containing credit card metadata linked to the provided user ID.\n\n#### Example Response\n\n``` json\n[\n {\n \"name\": \"Visa ending 1234\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"value\": \"someTokenOrValue\",\n \"id\": \"BK-123\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"BK\"\n }\n]\n\n ```\n\n### Fields Description\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `name` | string | Name or label associated with the credit card. |\n| `userId` | string | Unique identifier of the user (contract ID). |\n| `value` | string | Token or reference value for the credit card. |\n| `id` | string | ID of the document within the BK entity. |\n| `accountId` | string | ID of the VTEX account. |\n| `accountName` | string | Name of the VTEX account. |\n| `dataEntityId` | string | Data entity ID (BK in this case). |\n\nThis method is helpful when alternative access to credit card references is needed for integration or validation flows." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/api/dataentities/BK/search?userId={{contractId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "BK", + "search" + ], + "query": [ + { + "key": "userId", + "value": "{{contractId}}" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "771" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Tue, 25 Mar 2025 13:58:56 GMT" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Content-Encoding", + "value": "gzip" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Vary", + "value": "x-vtex-api-appKey,x-vtex-api-appToken,REST-Range,Accept" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.11-api" + }, + { + "key": "REST-AcceptRanges", + "value": "resources" + }, + { + "key": "REST-Content-Range", + "value": "resources 0-1/1" + }, + { + "key": "x-vtex-took", + "value": "174" + }, + { + "key": "X-VTEX-ApiCache-Time", + "value": "0" + }, + { + "key": "X-VTEX-Cache-Status-Janus-ApiCache", + "value": "MISS" + }, + { + "key": "X-Powered-By-VTEX-Cache", + "value": "2.5.0" + }, + { + "key": "X-VTEX-Cache-Server", + "value": "ip-172-16-30-248" + }, + { + "key": "X-VTEX-Cache-Time", + "value": "0.181" + }, + { + "key": "X-VTEX-Cache-Backend-Connect-Time", + "value": "0.000" + }, + { + "key": "X-VTEX-Cache-Backend-Header-Time", + "value": "0.180" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 32f5a0e0ae68a54cbbc9d13f80b4f150.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GRU1-C2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "reVcieIW4QBSVksT2Q5ltBdgpIR9cSCS9frWbUbWZO5CYMGf27vWeQ==" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"vcs-checkout\",\n \"userId\": \"e607f3bf-2ee4-11e8-81cd-0a9938145238\",\n \"value\": \"{\\\"isToSavePersonalData\\\":\\\"True\\\",\\\"lastPurchasesAddressId\\\":\\\"a2d8a83b6b0d43bfb12b76c85ba8e822\\\",\\\"paymentData\\\":\\\"{\\\\\"availableAccounts\\\\\":[{\\\\\"accountId\\\\\":\\\\\"E3263B9493B34087A93B0265410BE177\\\\\",\\\\\"paymentSystem\\\\\":\\\\\"2\\\\\",\\\\\"paymentSystemName\\\\\":\\\\\"Visa\\\\\",\\\\\"cardNumber\\\\\":\\\\\"************1111\\\\\",\\\\\"bin\\\\\":\\\\\"444433\\\\\",\\\\\"availableAddresses\\\\\":[\\\\\"a2d8a83b6b0d43bfb12b76c85ba8e822\\\\\"],\\\\\"expirationDate\\\\\":\\\\\"03/2021\\\\\",\\\\\"isExpired\\\\\":true,\\\\\"accountStatus\\\\\":null}],\\\\\"availableTokens\\\\\":[],\\\\\"transactions\\\\\":null,\\\\\"giftCards\\\\\":[],\\\\\"giftCardMessages\\\\\":[],\\\\\"numberOfPaymentErrors\\\\\":0,\\\\\"numberOfDeniedTransactions\\\\\":0,\\\\\"lastDeniedTransaction\\\\\":null}\\\",\\\"lastUserPurchases\\\":\\\"[{\\\\\"creationDate\\\\\":\\\\\"2018-03-23T21: 54: 56.1409516Z\\\\\",\\\\\"orderId\\\\\":\\\\\"819663312477-01\\\\\",\\\\\"orderGroup\\\\\":\\\\\"819663312477\\\\\",\\\\\"value\\\\\":5500}]\\\"}\",\n \"id\": \"e5accdd5-2ee4-11e8-81cd-0a8d3a2dca1a\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"BK\"\n }\n]" + } + ] + } + ], + "description": "These APIs are auxiliary and must support the completion of contracts, especially the Restrictions fields." + }, + { + "name": "Card Token Systems", + "item": [ + { + "name": "Get Card Token by ID", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "payments", + "pvt", + "accounts", + "{{id}}" + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `ViewPayments` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nRetrieves data for a specific token by its ID (unique identifier automatically generated during token creation).\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n\n## Response\n\n### Successful response\n\n- Status Code: `200 OK` - Returns a card token object.\n \n- Body:\n \n\n``` json\n{\n \"id\": \"string\",\n \"providerId\": \"string\",\n \"orderGroup\": \"string\",\n \"profileId\": \"string\",\n \"shopperId\": \"string\",\n \"email\": \"string\",\n \"card\": {\n \"paymentSystemId\": \"string\",\n \"paymentSystemName\": \"string\",\n \"firstDigits\": \"000000\",\n \"lastDigits\": \"0000\",\n \"address\": {\n \"addressType\": \"string\",\n \"addressId\": \"string\",\n \"postalCode\": \"string\",\n \"street\": \"string\",\n \"neighborhood\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"number\": \"string\",\n \"complement\": \"string\"\n },\n \"holderName\": \"string\"\n },\n \"cardTokenData\": {\n \"type\": \"string\",\n \"value\": \"string\",\n \"expiration\": \"YYYY-MM\",\n \"label\": \"string\",\n \"providerCardTokenId\": \"string\",\n \"useCvvForAuthorization\": \"boolean\",\n \"href\": \"string\"\n },\n \"extraData\": {\n \"string\": \"string\"\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n| providerId | string | Name of the connector's owner account (`accountName`) used to create the token. |\n| orderGroup | string | Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`, the order group ID is `v71021570str`. |\n| profileId | string | Profile ID in the Profile System (used for contract identification). |\n| shopperId | string | Shopper identification. |\n| email | string | Email is used only if neither `profileId` nor `orderGroup` are provided (rare use). |\n| card | object | Card object. |\n| card.paymentSystemId | string | Payment system ID in the Payment Gateway. |\n| card.paymentSystemName | string | Card brand, e.g. Visa, Mastercard. |\n| card.firstDigits | string | Card BIN (first six digits). |\n| card.lastDigits | string | The last four digits of the card. |\n| card.address | object | Card address object. |\n| card.address.addressType | string | Address type. For example, `Residential` or `Pickup`. |\n| card.address.addressId | string | Address identifier. |\n| card.address.postalCode | string | Postal code (ZIP/CEP). |\n| card.address.street | string | Street name. |\n| card.address.neighborhood | string | Neighborhood name. |\n| card.address.city | string | City name. |\n| card.address.state | string | State name. |\n| card.address.country | string | Country name. |\n| card.address.number | string | Street number. |\n| card.address.complement | string | Address complement (e.g., apartment, building). |\n| card.holderName | string | Name of the cardholder as printed on the card. |\n| cardTokenData | object | Card token data object. |\n| cardTokenData.type | string | Type of token (e.g., FILE, TOKEN_CLIENT_ID, TOKEN_VALUE). |\n| cardTokenData.value | string | The token value to be used in transactions. |\n| cardTokenData.expiration | string | Token expiration date in `YYYY-MM` format. |\n| cardTokenData.label | string | Token alias (an alternative name to simplify token identification). |\n| cardTokenData.providerCardTokenId | string | Client ID used to retrieve the token from the provider. |\n| cardTokenData.useCvvForAuthorization | boolean | Flag indicating if CVV is required (`true`) or not (`false`). |\n| cardTokenData.href | string | URL of the token file stored by the provider. |\n| extraData | object | Dictionary for additional data. |\n\n#### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Invalid request data. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Token not previously registered. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + }, + { + "name": "Create Card Token", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"providerId\":\"string\",\r\n \"profileId\":\"string optional if email or orderGroup exists\",\r\n \"email\": \"string optional if profileId or orderGroup exists\",\r\n \"orderGroup\": \"string optional if profileId or email exists\",\r\n \"card\":{\r\n \"paymentSystemName\":\"string\",\r\n \"paymentSystemId\":\"string optional\",\r\n \"firstDigits\":\"string\",\r\n \"lastDigits\":\"string\",\r\n \"address\":{\r\n \"addressType\":\"string\",\r\n \"addressId\":\"string\",\r\n \"postalCode\":\"string\",\r\n \"street\":\"string\",\r\n \"neighborhood\":\"string\",\r\n \"city\":\"string\",\r\n \"state\":\"string\",\r\n \"country\":\"string\",\r\n \"number\":\"string\",\r\n \"complement\":\"string\"\r\n },\r\n \"holderName\":\"string\"\r\n },\r\n \"cardTokenData\":{\r\n \"type\":\"string\",\r\n \"value\":\"string required if type is TOKEN_VALUE\",\r\n \"expiration\":\"string\",\r\n \"label\":\"string optional\",\r\n \"href\":\"string required if type is FILE\",\r\n \"providerCardTokenId\":\"string required if type is TOKEN_CLIENT_ID\",\r\n \"useCvvForAuthorization\": false // boolean optional default false\r\n },\r\n \"extraData\":{\r\n \"additionalProp1\":\"string\",\r\n \"additionalProp2\":\"string\",\r\n \"additionalProp3\":\"string\"\r\n }\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "card-token-vault", + "tokens" + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `CreateCardTokens` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nRegisters a new card token in the system.\n\n### Request body\n\n``` json\n{\n \"providerId\": \"string\",\n \"profileId\": \"string optional if email or orderGroup exists\",\n \"shopperId\": \"string optional, mandatory only if a personal card is used\",\n \"email\": \"string optional if profileId or orderGroup exists\",\n \"orderGroup\": \"string optional if profileId or email exists\",\n \"card\":{\n \"paymentSystemName\": \"string\",\n \"paymentSystemId\": \"string optional\",\n \"firstDigits\": \"string\",\n \"lastDigits\": \"string\",\n \"address\":{\n \"addressType\": \"string\",\n \"addressId\": \"string\",\n \"postalCode\": \"string\",\n \"street\": \"string\",\n \"neighborhood\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"number\": \"string\",\n \"complement\": \"string\"\n },\n \"holderName\": \"string\"\n },\n \"cardTokenData\":{\n \"type\": \"string\",\n \"value\": \"string required if type is TOKEN_VALUE\",\n \"expiration\": \"string\",\n \"label\": \"string optional\",\n \"href\": \"string required if type is FILE\",\n \"providerCardTokenId\": \"string required if type is TOKEN_CLIENT_ID\",\n \"useCvvForAuthorization\": \"boolean optional, default false\"\n },\n \"extraData\":{\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| providerId | Yes | string | Name of the connector's owner account (`accountName`) used to create the token. |\n| profileId | No | string | Profile ID in the Profile System (used for contract identification). This field is optional if `email` or `orderGroup` exists. |\n| shopperId | No | string | Shopper identification. This field is optional and only applicable if a personal card is used. |\n| email | No | string | Email is used only if neither `profileId` nor `orderGroup` are provided (rare use). |\n| orderGroup | No | string | Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`, the order group ID is `v71021570str`. This field is optional if `email` or `profileId` exists. |\n| card | yes | object | Card object. |\n| card.paymentSystemId | No | string | Payment system ID in the Payment Gateway. |\n| card.paymentSystemName | Yes | string | Card brand, e.g. Visa, Mastercard. |\n| card.firstDigits | Yes | string | Card BIN (first six digits). |\n| card.lastDigits | Yes | string | The last four digits of the card. |\n| card.address | No | object | Card address object. |\n| card.address.addressType | No | string | Address type. For example, `Residential` or `Pickup`. |\n| card.address.addressId | No | string | Address identifier. |\n| card.address.postalCode | No | string | Postal code (ZIP/CEP). |\n| card.address.street | No | string | Street name. |\n| card.address.neighborhood | No | string | Neighborhood name. |\n| card.address.city | No | string | City name. |\n| card.address.state | No | string | State name. |\n| card.address.country | No | string | Country name. |\n| card.address.number | No | string | Street number. |\n| card.address.complement | No | string | Address complement (e.g., apartment, building). |\n| card.holderName | No | string | Name of the cardholder as printed on the card. |\n| cardTokenData | Yes | object | Card token data object. |\n| cardTokenData.type | Yes | string | Type of token (e.g., FILE, TOKEN_CLIENT_ID, TOKEN_VALUE). |\n| cardTokenData.value | No | string | The token value to be used in transactions. This field is required if the `type` is TOKEN_VALUE. |\n| cardTokenData.expiration | Yes | string | Token expiration date in `YYYY-MM` format. |\n| cardTokenData.label | No | string | Token alias (an alternative name to simplify token identification). |\n| cardTokenData.href | No | string | URL of the token file stored by the provider. This field is required if the `type` is FILE. |\n| cardTokenData.providerCardTokenId | No | string | Client ID used to retrieve the token from the provider. This field is required if the `type` is TOKEN_CLIENT_ID. |\n| cardTokenData.useCvvForAuthorization | No | boolean | Flag indicating if CVV is required (`true`) or not (`false`). Default: `false`. |\n| extraData | No | object | Dictionary for additional data. |\n\n### Response\n\n#### Successful response\n\n- Status Code: `201 Created` - token saved.\n \n- Body: No content.\n \n\n#### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Problem validating request data. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 409 | Token already exists. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + }, + { + "name": "Update Card Token", + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"providerId\":\"string\",\r\n \"profileId\":\"string optional if email or orderGroup exists\",\r\n \"email\": \"string optional if profileId or orderGroup exists\",\r\n \"orderGroup\": \"string optional if profileId or email exists\",\r\n \"cardTokenData\":{\r\n \"type\":\"string\",\r\n \"value\":\"string required if type is TOKEN_VALUE\",\r\n \"expiration\":\"string\",\r\n \"label\":\"string optional\",\r\n \"href\":\"string required if type is FILE\",\r\n \"providerCardTokenId\":\"string required if type is TOKEN_CLIENT_ID\",\r\n \"useCvvForAuthorization\":\"boolean optional, default false\"\r\n },\r\n \"extraData\":{\r\n \"additionalProp1\":\"string\",\r\n \"additionalProp2\":\"string\",\r\n \"additionalProp3\":\"string\"\r\n }\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/{{id}}", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "card-token-vault", + "tokens", + "{{id}}" + ] + }, + "description": "## Request\n\n- **Method**: `PUT`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/{{id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `ManageCardTokens` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nUpdates data for an existing token.\n\nThis endpoint requires sending the complete request body from the **Create Card Token** endpoint, except for the `card` object.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n\n### Request body\n\n``` json\n{\n \"providerId\":\"string\",\n \"profileId\": \"string optional if email or orderGroup exists\",\n \"shopperId\": \"string optional, mandatory only if a personal card is used\",\n \"email\": \"string optional if profileId or orderGroup exists\",\n \"orderGroup\": \"string optional if profileId or email exists\",\n \"cardTokenData\":{\n \"type\": \"string\",\n \"value\": \"string required if type is TOKEN_VALUE\",\n \"expiration\": \"string\",\n \"label\": \"string optional\",\n \"href\": \"string required if type is FILE\",\n \"providerCardTokenId\": \"string required if type is TOKEN_CLIENT_ID\",\n \"useCvvForAuthorization\": \"boolean optional, default false\"\n },\n \"extraData\":{\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| providerId | Yes | string | Name of the owner account of the connector used to create the token. |\n| profileId | No | string | Profile ID in the Profile System. This field is optional if `email` or `orderGroup` exists. |\n| shopperId | No | string | Shopper identification. This field is optional and only applicable if a personal card is used. |\n| email | No | string | Email is used only if neither `profileId` nor `orderGroup` are provided (rare use). |\n| orderGroup | No | string | Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`, the order group ID is `v71021570str`. This field is optional if `email` or `profileId` exists. |\n| cardTokenData | Yes | object | Card token data object. |\n| cardTokenData.type | Yes | string | Type of token (e.g., FILE, TOKEN_CLIENT_ID, TOKEN_VALUE). |\n| cardTokenData.value | No | string | The token value to be used in transactions. This field is required if the `type` is TOKEN_VALUE. |\n| cardTokenData.expiration | Yes | string | Token expiration date in `YYYY-MM` format. |\n| cardTokenData.label | No | string | Token alias (an alternative name to simplify token identification). |\n| cardTokenData.href | No | string | URL of the token file stored by the provider. This field is required if the `type` is FILE. |\n| cardTokenData.providerCardTokenId | No | string | Client ID used to retrieve the token from the provider. This field is required if the `type` is TOKEN_CLIENT_ID. |\n| cardTokenData.useCvvForAuthorization | No | boolean | Flag indicating if CVV is required (`true`) or not (`false`). Default: `false`. |\n| extraData | No | object | Dictionary for additional data. |\n\n### Response\n\n#### Successful response\n\n- Status Code: `201 Created` - token saved.\n \n- Body: No content.\n \n\n#### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Problem validating request data. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Token not previously registered. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + }, + { + "name": "Delete Card Token", + "request": { + "method": "DELETE", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "payments", + "pvt", + "accounts", + "{{id}}" + ] + }, + "description": "## Request\n\n- **Method**: `DELETE`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `MakePayments` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nDeletes a token from the system.\n\nThis endpoint doesn’t require a request body.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n\n## Response\n\n### Successful response\n\n- Status Code: `200 OK` - token deleted.\n \n- Body: No content.\n \n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Token not previously registered. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + }, + { + "name": "Import Token", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "multipart/form-data", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "'file=@\"/C:/test/test.xlsx\"'", + "options": { + "raw": { + "language": "text" + } + } + }, + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "card-token-vault", + "tokens", + "import" + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `multipart/form-data`\n \n- **Permissions**: The user or application key must have the `ImportCardToken` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nImports tokens in bulk via an XLSX file. Note that:\n\n- **File size and type:** Only XLSX files with a maximum size of 20MB are allowed.\n \n- **Simultaneous imports:** Each account can only trigger one import at a time. If an import is in progress, you need to wait for it to finish to trigger another import.\n \n- **Auditing:** All import actions are audited.\n \n\n### Request body\n\n```\n'file=@\"/C:/test/test.xlsx\"'\n\n ```\n\nThe body of the request will contain your XLSX file, which you'll send as a form data part.\n\nThe XLSX file must have the first row with the following headers:\n\n``` json\naccountName,providerId,profileId,paymentSystemName,cardFirstDigits,cardLastDigits,cardAddressType,cardAddressPostalCode,cardAddressStreet,cardAddressNeighborhood,cardAddressCity,cardAddressState,cardAddressCountry,cardAddressNumber,cardAddressComplement,cardHolderName,tokenType,tokenValue,tokenExpiration,tokenLabel,tokenProviderCardTokenId,tokenUseCvvForAuthorization,tokenHref,extraData,email,shopperId\n\n ```\n\nThe `extraData` field should contain a JSON with a dictionary of additional data, or an empty JSON.\n\n## Response\n\n### Successful response\n\n- Status Code: `202 Accepted` - File received.\n \n- Body: Returns an import the Token ID in the system, which can be used to retrieve the import status and the report from the import.\n \n\n``` json\n{\n\"id\": \"string\"\n}\n\n ```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| id | string | Import ID. |\n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Incorrect `Content-Type` or invalid file type. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + }, + { + "name": "Retrieve Import Current Status", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "card-token-vault", + "tokens", + "import", + "{{importId}}" + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `GetImportCardTokenStatus` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nReturns the status and progress percentage of an import.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| importId | Yes | string | Import ID. |\n\n## Response\n\n### Successful response\n\n- Status Code: `200 OK` - import data obtained.\n \n- Body: Returns the import status.\n \n\n``` json\n{\n \"status\": \"RUNNING\",\n \"id\": \"string\",\n \"completionPercentage\":\"integer\",\n \"createdDate\": \"string\",\"\n \"updatedDate\": \"string\",\n \"reportUrl\":\"string optional if the import process had any error\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| status | string | Response status, which can be: `DONE`, `RUNNING`, `CREATED` or `FAILED`. |\n| id | string | Import ID. |\n| completionPercentage | integer | Importing completion percentage. |\n| createdDate | string | Creation date. |\n| updatedDate | string | Last update date. |\n| reportUrl | string | Report URL. This field is optional if the import process had an error. |\n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Import not found. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + }, + { + "name": "Retrieve Import Report", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}/report", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "card-token-vault", + "tokens", + "import", + "{{importId}}", + "report" + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}/report`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `GetImportCardTokensReport` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nReturns the import report, indicating lines with issues.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| importId | Yes | string | Import ID. |\n\n## Response\n\n### Successful response\n\n- Status Code: `302 Found` - redirects the user to the report download URL.\n \n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Import not found. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" + }, + "response": [] + } + ], + "description": "The Card Token Vault API is responsible for creating and updating card tokens, as well as supporting bulk imports. Card tokens are unique identifiers that represent securely stored credit card data. The Payment Gateway API enables the retrieval and deletion of card tokens.\n\n> ℹ️ This API's endpoints can be used for personal cards (cards associated with a single buyer) and shared cards (cards used by more than one person and associated with a specific contract). However, in a scenario of operations with personal cards, the `shopperId` must be additionally sent in the [Created Card Token](https://documenter.getpostman.com/view/2352637/2sAYkKGcHD#7fe79cbd-2f5b-420b-9993-f4b4af8265d1) or [Update Card Token](https://documenter.getpostman.com/view/2352637/2sAYkKGcHD#cba5b948-a4ad-4eb8-8659-7c32a3bd232b) endpoints." + }, + { + "name": "B2B User Migration", + "item": [ + { + "name": "1. Create User", + "request": { + "method": "POST", + "header": [ + { + "key": "Cookie", + "value": "VtexIdclientAutCookie_b2bfaststoredev={{VtexIdclientAutCookie}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"identifier\": \"unique_login_key\",\n \"identifierType\": \"username\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountname}}.vtexcommercestable.com.br/api/authenticator/storefront/users?isLegacyPassword=false", + "protocol": "https", + "host": [ + "{{accountname}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "authenticator", + "storefront", + "users" + ], + "query": [ + { + "key": "isLegacyPassword", + "value": "false" + } + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountname}}.vtexcommercestable.com.br/api/authenticator/storefront/users?isLegacyPassword=false`\n \n- **Authentication**: Requires `VtexIdclientAutCookie_{{accountname}}={{VtexIdclientAutCookie}}` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Create user` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (VTEX ID > User Management).\n \n\nRegister a new user in the [VTEX ID](https://developers.vtex.com/docs/api-reference/vtex-id-api).\n\n> ℹ️ All users are created without any Organization Unit or storefront permissions assigned to them. \n \n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| isLegacyPassword | Yes | boolean | Indicates whether the user’s password recovery should be handled by an external service or by the user themself during their first login. The default value is `false`, meaning the user will set their password. |\n\n### Request body\n\n``` json\n{\n \"identifier\": \"unique_login_key\",\n \"identifierType\": \"username\"\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| identifier | Yes | string | This user will be registered with a `unique_login_key`, which is their unique identifier during the login process. The `unique_login_key` is an open, case-insensitive field that accepts 3 to 70 characters, including special characters and whitespace. |\n| identifierType | Yes | string | Indicate the type of login key added, including values such as `username`, `email`, or `telephone`. Currently, only the `username` value is supported. |\n\n> ⚠️ Once you create a user, you cannot edit or delete it. If any data was entered incorrectly, the easiest solution is to create a new username with the correct details." + }, + "response": [] + }, + { + "name": "2. Get User by Identifier", + "request": { + "method": "GET", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}" + } + ], + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/pvt/user/info?user={{identifier}}", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "vtexid", + "pvt", + "user", + "info" + ], + "query": [ + { + "key": "user", + "value": "{{identifier}}" + } + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/vtexid/pvt/user/info?user={{identifier}}`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n\nSearch for a user by their identifier (username, email, or telephone).\n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| identifier | Yes | string | This information must be provided in URL-encoded format. |" + }, + "response": [] + }, + { + "name": "3. Get List of Organization Units", + "request": { + "method": "GET", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}" + } + ], + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1?page=4&pageSize=100", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "organization-units", + "v1" + ], + "query": [ + { + "key": "page", + "value": "4" + }, + { + "key": "pageSize", + "value": "100" + } + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1?page=4&pageSize=100`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nRetrieves a paginated list of all Organization Units, which can be navigated using the `page` and `pageSize` parameters.\n\n> ℹ️ Organization Units represent the organizations to which a buyer user belongs. \n \n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| page | Yes | number | Page number of the results. |\n| pageSize | Yes | number | Number of items per page. |" + }, + "response": [] + }, + { + "name": "4. Create Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{Unit Name}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "organization-units", + "v1" + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nCreates a new Organization Unit. All units are initially created at the root level.\n\n### Request body\n\n``` json\n{\n \"name\": \"Unit Name\"\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| name | Yes | string | Name of the Organization Unit to be created. |" + }, + "response": [] + }, + { + "name": "5. Assign user to Organization Unit", + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text", + "disabled": true + }, + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"userIds\": [\"userId\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{organizationUnit}}", + "users" + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nLinks a user to an Organization Unit.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| organizationUnit | Yes | string | Name of the Organizational Unit where the user will be assigned. |\n\n### Request body\n\n``` json\n{\n \"userIds\": [\"userId\"]\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| userIds | Yes | array | Identification of the user to whom an Organization Unit will be assigned. |" + }, + "response": [] + }, + { + "name": "6. Get Users from Unit", + "request": { + "method": "GET", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "vtexid", + "organization-units", + "{{organizationUnit}}", + "users" + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `View Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nLists all users stored in an Organization Unit.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| organizationUnit | Yes | string | Name of the Organizational Unit where users are stored. |" + }, + "response": [] + }, + { + "name": "7. Assign Roles to User", + "request": { + "method": "POST", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"userId\",\n \"roleIds\": [1, 2, 3]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "license-manager", + "storefront", + "users" + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Storefront User Permissions` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (License manager > Services access control).\n \n\nAssigns one or more administrative roles to a buyer user within an organization.\n\nEach administrative role is identified by a unique `roleId`, represented as a number. You can find the available `roleId` values and their corresponding permissions in the table below:\n\n| Permission | Available Actions | RoleID |\n| --- | --- | --- |\n| **Organizational Unit Admin** | Manage Organization & Contract | 1 |\n| **Order Approver** | Approve Orders | 2 |\n| **Order Modifier** | Modify Orders | 3 |\n| **Buyer** | Place Orders | 4 |\n| **Personal Cards User** | Use ad hoc credit card | 5 |\n| **Contract Manager** | View My Contract Orders | 6 |\n| **Buyer Organization Manager** | View My Org Unit Orders | 7 |\n| **Contract Viewer** | Manage Authentication
View My Cards
View Addresses | 8 |\n| **Address Manager** | Manage Addresses | 9 |\n\n### Request body\n\n``` json\n{\n \"id\": \"userId\",\n \"roleIds\": [1, 2, 3]\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Identification of the user to whom one or more roles will be assigned. |\n| rolesIds | Yes | array of numbers | Identification number of the assigned role. |" + }, + "response": [] + }, + { + "name": "8. Verify User Roles", + "request": { + "method": "GET", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "url": { + "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users/{{username}}/roles", + "protocol": "https", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "license-manager", + "storefront", + "users", + "{{username}}", + "roles" + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users/{{username}}/roles`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Save Storefront User Permissions` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (License manager > Services access control).\n \n\nList the administrative roles for a storefront user. For more information, see [Fetch storefront user roles by ID](https://developers.vtex.com/docs/api-reference/storefront-permissions-api#get-/api/license-manager/storefront/users/-userId-/roles).\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| username | Yes | string | Username identification. |" + }, + "response": [] + }, + { + "name": "9. Save shopper data", + "request": { + "method": "POST", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"userId\": \"userId\",\n\t\"firstName\": \"User First Name 2\",\n\t\"lastName\": \"User Last Name\",\n\t\"document\": \"111.444.000-00\",\n \"email\": \"user@vtex.com\",\n \"phone\": \"5583987499600\",\n\t\"documentType\": \"cpf\",\n\t\"cards\": [],\n \"unitId\": \"{{organizationUnit}}\"\n}\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1", + "protocol": "http", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "dataentities", + "shopper", + "documents" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + } + ] + }, + "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Dynamic storage generic resources` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Dynamic Storage).\n \n\nPopulates and manages users’ profile information. Shopper data serves as the source of truth for details as first and last name, document, telephone, email, and more.\n\nFor more information, see [VTEX Developers - Master Data APIs](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents).\n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| _schema | Yes | string | Version identification. |\n\n### Request body\n\n``` json\n{\n \"userId\": \"userId\",\n \"firstName\": \"User First Name 2\",\n \"lastName\": \"User Last Name\",\n \"document\": \"111.444.000-00\",\n \"email\": \"user@vtex.com\",\n \"phone\": \"5583987499600\",\n \"documentType\": \"cpf\",\n \"cards\": []\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| userId | Yes | string | User identification. |\n| firstName | Yes | string | The first name of the user. |\n| lastName | Yes | string | The last name of the user. |\n| document | Yes | string | The document number of the user. |\n| email | Yes | string | The email of the user. |\n| phone | Yes | string | The phone number of the user. |\n| documentType | Yes | string | Type of document (e.g., CPF, CNPJ). |\n| cards | Yes | array | Cards information. |" + }, + "response": [] + }, + { + "name": "10. Get shopper data", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [ + { + "key": "X-VTEX-API-AppKey", + "value": "{{X-VTEX-API-AppKey}}", + "type": "text" + }, + { + "key": "X-VTEX-API-AppToken", + "value": "{{X-VTEX-API-AppToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/search?_schema=v1&_where=userId={{userId}}&_fields=_all", + "protocol": "http", + "host": [ + "{{accountName}}", + "vtexcommercestable", + "com", + "br" + ], + "path": [ + "api", + "dataentities", + "shopper", + "search" + ], + "query": [ + { + "key": "_schema", + "value": "v1" + }, + { + "key": "_where", + "value": "userId={{userId}}" + }, + { + "key": "_fields", + "value": "_all" + } + ] + }, + "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/search?_schema=v1&_where=userId={{userId}}&_fields=_all`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Dynamic storage generic resources` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Dynamic Storage).\n \n\nList the stored shopper data. For more information, see [VTEX Developers - Master Data APIs](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents).\n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| _schema | Yes | string | Version identification. |\n| _where | Yes | string | Username identification. |\n| _fields | Yes | string | Identification of the shopper profile fields that will be displayed. |\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| userId | Yes | string | Username identification. |" + }, + "response": [] + } + ], + "description": "This guide explains a secure process for migrating a merchant’s user base - including user passwords - from external platforms to VTEX.\n\nThe migration involves the following operations:\n\n1. Creating users at VTEX\n \n2. Adding users to Buyer Organizations\n \n3. Assigning administrative roles within Buyer Organizations\n \n4. Registering profile information" + }, + { + "name": "🧪 EXPERIMENTAL 🧪", + "item": [ + { + "name": "Prospects", + "item": [ + { + "name": "Create Prospect", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"businessDocument\": \"{{businessDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"fancyName\": \"{{fancyName}}\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/PS/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "PS", + "documents" + ] + }, + "description": "This endpoint allows you to add a new document entity to the system.\n\n#### Request Body\n\n- `email` (string): The email of the entity.\n \n- `firstName` (string): The first name of the entity.\n \n- `lastName` (string): The last name of the entity.\n \n- `document` (string): The document number of the entity.\n \n- `documentType` (string): The type of document.\n \n- `businessDocument` (string): The business document of the entity.\n \n- `homePhone` (string): The home phone number of the entity.\n \n- `cellPhone` (string): The cell phone number of the entity.\n \n- `corporateName` (string): The corporate name of the entity.\n \n- `fancyName` (string): The fancy name of the entity.\n \n- `isPJ` (boolean): Indicates if the entity is a legal entity.\n \n- `stateRegistration` (string): The state registration of the entity.\n \n- `isFreeStateRegistration` (boolean): Indicates if the state registration is free.\n \n\n#### Response\n\n- `Id` (string): The ID of the newly added document entity.\n \n- `Href` (string): The URL of the newly added document entity.\n \n- `DocumentId` (string): The document ID of the newly added document entity." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"business-klub-spc@email.com\",\r\n \"firstName\": \"Business Klub\",\r\n \"lastName\": \"SPC\",\r\n \"document\": \"00000000000000\",\r\n \"documentType\": \"CNPJ\",\r\n \"businessDocument\": \"00000000000000\",\r\n \"homePhone\": \"1122223333\",\r\n \"cellPhone\": \"11999991111\",\r\n \"businessPhone\": \"1122223333\",\r\n \"corporateName\": \"Business Klub SPC\",\r\n \"fancyName\": \"Business Klub SPC\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "202" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Wed, 19 Mar 2025 21:43:29 GMT" + }, + { + "key": "x-vtex-took", + "value": "135" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.8-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "V7-IZnmhGRFbCKMOxAt_deklX3uTFhSkxJZ4UYnFRnif2Y10V_eL4Q==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/PS/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}" + } + ] + }, + { + "name": "List Prospects", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{vault:VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"businessDocument\": \"{{businessDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"fancyName\": \"{{fancyName}}\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/PS/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "PS", + "documents" + ] + }, + "description": "### Add New ProspectEntity\n\nThis endpoint allows you to add a new document entity to the system.\n\n#### Request Body\n\n- `email` (string): The email of the entity.\n \n- `firstName` (string): The first name of the entity.\n \n- `lastName` (string): The last name of the entity.\n \n- `document` (string): The document number of the entity.\n \n- `documentType` (string): The type of document.\n \n- `businessDocument` (string): The business document of the entity.\n \n- `homePhone` (string): The home phone number of the entity.\n \n- `cellPhone` (string): The cell phone number of the entity.\n \n- `corporateName` (string): The corporate name of the entity.\n \n- `fancyName` (string): The fancy name of the entity.\n \n- `isPJ` (boolean): Indicates if the entity is a legal entity.\n \n- `stateRegistration` (string): The state registration of the entity.\n \n- `isFreeStateRegistration` (boolean): Indicates if the state registration is free.\n \n\n#### Response\n\n- `Id` (string): The ID of the newly added document entity.\n \n- `Href` (string): The URL of the newly added document entity.\n \n- `DocumentId` (string): The document ID of the newly added document entity." + }, + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "VtexIdclientAutCookie", + "value": "{{VtexIdclientAutCookie}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"email\": \"business-klub-spc@email.com\",\r\n \"firstName\": \"Business Klub\",\r\n \"lastName\": \"SPC\",\r\n \"document\": \"00000000000000\",\r\n \"documentType\": \"CNPJ\",\r\n \"businessDocument\": \"00000000000000\",\r\n \"homePhone\": \"1122223333\",\r\n \"cellPhone\": \"11999991111\",\r\n \"businessPhone\": \"1122223333\",\r\n \"corporateName\": \"Business Klub SPC\",\r\n \"fancyName\": \"Business Klub SPC\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/dataentities/CL/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "dataentities", + "CL", + "documents" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "202" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Date", + "value": "Wed, 19 Mar 2025 21:43:29 GMT" + }, + { + "key": "x-vtex-took", + "value": "135" + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*" + }, + { + "key": "Access-Control-Expose-Headers", + "value": "REST-Content-Range" + }, + { + "key": "Cache-Control", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "-1" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "X-VTEX-Janus-Router-Backend-App", + "value": "ds-api-v10.210.8-api" + }, + { + "key": "X-AspNet-Version", + "value": "4.0.30319" + }, + { + "key": "X-Powered-By", + "value": "ASP.NET" + }, + { + "key": "X-Cache", + "value": "Miss from cloudfront" + }, + { + "key": "Via", + "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" + }, + { + "key": "X-Amz-Cf-Pop", + "value": "GIG51-P2" + }, + { + "key": "X-Amz-Cf-Id", + "value": "V7-IZnmhGRFbCKMOxAt_deklX3uTFhSkxJZ4UYnFRnif2Y10V_eL4Q==" + } + ], + "cookie": [], + "body": "{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/PS/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}" + } + ] + } + ], + "description": "These APIs are for creating the contract, and are expected to be used only for store management. \nIn this collection there are auxiliary APIs to support filling out the contract, especially the restrictions object." + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "accountName", + "value": "{{accountName}}" + }, + { + "key": "unitId", + "value": "{{unitId}}" + }, + { + "key": "userId", + "value": "{{userId}}" + }, + { + "key": "baseUrl", + "value": "https://{{accountName}}.myvtex.com" + }, + { + "key": "scope", + "value": "{{contractIds|addresses|paymentSystemIds|priceTables|collectionIds|creditCards|customFields}}" + }, + { + "key": "term", + "value": "{{term}}" + }, + { + "key": "resourceKey", + "value": "{{resourceKey}}" + }, + { + "key": "budgetId", + "value": "{{budgetId}}" + }, + { + "key": "allocationId", + "value": "{{allocationId}}" + }, + { + "key": "reservationId", + "value": "{{reservationId}}" + }, + { + "key": "transactionId", + "value": "{{transactionId}}" + }, + { + "key": "contractId", + "value": "{{contractId}}" + }, + { + "key": "addressId", + "value": "{{addressId}}" + }, + { + "key": "unitName", + "value": "{{unitName}}" + }, + { + "key": "customFieldValueId", + "value": "{{customFieldValueId}}" + }, + { + "key": "customField", + "value": "{{customField}}" + }, + { + "key": "email", + "value": "{{email}}" + } + ] +} \ No newline at end of file From 5a16e97906f2265399b5305ab30dc77aab0d18d3 Mon Sep 17 00:00:00 2001 From: Ricardo Correia Date: Mon, 18 May 2026 13:19:10 -0300 Subject: [PATCH 2/8] Send correct file --- VTEX - Payment Policies API.json | 1136 ++++++++++++++++++++++++++++++ 1 file changed, 1136 insertions(+) create mode 100644 VTEX - Payment Policies API.json diff --git a/VTEX - Payment Policies API.json b/VTEX - Payment Policies API.json new file mode 100644 index 000000000..f1d03e17c --- /dev/null +++ b/VTEX - Payment Policies API.json @@ -0,0 +1,1136 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Payment Policies API", + "description": "The Payment Policies API allows VTEX merchants to configure rules that include or exclude payment systems for specific cart items. The Payment Configuration Service (PCS) stores policy rules, while the Payment Information Service (PIS) evaluates those rules during checkout and returns the payment systems available for each item.\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## Index\r\n\r\n### Payment policy rules\r\n\r\n- `POST` [Create policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/payment-configuration-service/policy-rules)\r\n- `GET` [List policy rules](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules)\r\n- `GET` [Get policy rule by ID](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PUT` [Update policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#put-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PATCH` [Update policy rule partially](https://developers.vtex.com/docs/api-reference/payment-policies-api#patch-/api/payment-configuration-service/policy-rules/-id-)\r\n- `DELETE` [Delete policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#delete-/api/payment-configuration-service/policy-rules/-id-)\r\n\r\n### Payment policy evaluation\r\n\r\n- `POST` [Evaluate payment policies](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/pvt/payment-systems/search)\r\n\r\n## Rule engine\r\n\r\n> ℹ️ Currently the Payment policies feature supports `and`, `or`, `==`, and `in` operators, with a limit of 500 operators per expression. Available context variables are `collectionIds`, containing the collection IDs associated with the item, and `shippingState`, containing the delivery state code.", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://pcs.{environment}.com.br", + "description": "Payment Configuration Service server URL.", + "variables": { + "environment": { + "description": "Environment to use. Used as part of the URL.", + "enum": [ + "vtexcommercestable" + ], + "default": "vtexcommercestable" + } + } + }, + { + "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" + } + } + } + ], + "paths": { + "/api/payment-configuration-service/policy-rules": { + "servers": [ + { + "url": "https://pcs.{environment}.com.br", + "description": "Payment Configuration Service server URL.", + "variables": { + "environment": { + "description": "Environment to use. Used as part of the URL.", + "enum": [ + "vtexcommercestable" + ], + "default": "vtexcommercestable" + } + } + } + ], + "post": { + "tags": [ + "Payment policy rules" + ], + "summary": "Create policy rule", + "operationId": "createPolicyRule", + "description": "Creates a payment policy rule for the VTEX account informed in 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/AccountName" + }, + { + "$ref": "#/components/parameters/Content-Type" + }, + { + "$ref": "#/components/parameters/Accept" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRuleInput" + }, + "example": { + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": true, + "priority": 90, + "action": "Exclude", + "paymentSystems": [ + 100 + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRule" + }, + "example": { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "accountName": "cosmetics2", + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": true, + "priority": 90, + "action": "Exclude", + "paymentSystems": [ + 100 + ], + "createdAt": "2026-04-01T10:00:00Z", + "updatedAt": "2026-04-01T10:00:00Z" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + } + } + }, + "get": { + "tags": [ + "Payment policy rules" + ], + "summary": "List policy rules", + "operationId": "listPolicyRules", + "description": "Lists the payment policy rules configured for the VTEX account informed in 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 | **ViewPayments** |\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/AccountName" + }, + { + "$ref": "#/components/parameters/Accept" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of policy rules configured for the account.", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "example": [ + { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "accountName": "cosmetics2", + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": true, + "priority": 90, + "action": "Exclude", + "paymentSystems": [ + 100 + ], + "createdAt": "2026-04-01T10:00:00Z", + "updatedAt": "2026-04-01T10:00:00Z" + } + ] + } + } + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + } + } + } + }, + "/api/payment-configuration-service/policy-rules/{id}": { + "servers": [ + { + "url": "https://pcs.{environment}.com.br", + "description": "Payment Configuration Service server URL.", + "variables": { + "environment": { + "description": "Environment to use. Used as part of the URL.", + "enum": [ + "vtexcommercestable" + ], + "default": "vtexcommercestable" + } + } + } + ], + "get": { + "tags": [ + "Payment policy rules" + ], + "summary": "Get policy rule by ID", + "operationId": "getPolicyRuleById", + "description": "Retrieves a payment policy rule by ID for the VTEX account informed in 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 | **ViewPayments** |\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/PolicyRuleId" + }, + { + "$ref": "#/components/parameters/AccountName" + }, + { + "$ref": "#/components/parameters/Accept" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRule" + }, + "example": { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "accountName": "cosmetics2", + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": true, + "priority": 90, + "action": "Exclude", + "paymentSystems": [ + 100 + ], + "createdAt": "2026-04-01T10:00:00Z", + "updatedAt": "2026-04-01T10:00:00Z" + } + } + } + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + }, + "put": { + "tags": [ + "Payment policy rules" + ], + "summary": "Update policy rule", + "operationId": "updatePolicyRule", + "description": "Replaces a payment policy rule for the VTEX account informed in the `an` query parameter. Send the same response body as the `POST` request, excluding `id`, `accountName`, createdAt`, or `updatedAt`.\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/PolicyRuleId" + }, + { + "$ref": "#/components/parameters/AccountName" + }, + { + "$ref": "#/components/parameters/Content-Type" + }, + { + "$ref": "#/components/parameters/Accept" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRuleInput" + }, + "example": { + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": true, + "priority": 90, + "action": "Exclude", + "paymentSystems": [ + 100 + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRule" + }, + "example": { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "accountName": "cosmetics2", + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": true, + "priority": 90, + "action": "Exclude", + "paymentSystems": [ + 100 + ], + "createdAt": "2026-04-01T10:00:00Z", + "updatedAt": "2026-04-01T10:00:00Z" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + }, + "patch": { + "tags": [ + "Payment policy rules" + ], + "summary": "Update policy rule partially", + "operationId": "patchPolicyRule", + "description": "Updates one or more fields of a payment policy rule for the VTEX account informed in 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/PolicyRuleId" + }, + { + "$ref": "#/components/parameters/AccountName" + }, + { + "$ref": "#/components/parameters/Content-Type" + }, + { + "$ref": "#/components/parameters/Accept" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRulePatch" + }, + "example": { + "priority": 50, + "paymentSystems": [ + 100, + 200 + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyRule" + }, + "example": { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "accountName": "cosmetics2", + "name": "Exclude EBT for collection 139 in NY", + "expression": { + "and": [ + { + "in": [ + 139, + { + "var": "collectionIds" + } + ] + }, + { + "==": [ + { + "var": "shippingState" + }, + "NY" + ] + } + ] + }, + "enabled": false, + "priority": 50, + "action": "Exclude", + "paymentSystems": [ + 100, + 200 + ], + "createdAt": "2026-04-01T10:00:00Z", + "updatedAt": "2026-04-01T11:00:00Z" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + }, + "delete": { + "tags": [ + "Payment policy rules" + ], + "summary": "Delete policy rule", + "operationId": "deletePolicyRule", + "description": "Deletes a payment policy rule for the VTEX account informed in 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/PolicyRuleId" + }, + { + "$ref": "#/components/parameters/AccountName" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + } + }, + "/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" + } + } + } + ], + "post": { + "tags": [ + "Payment policy evaluation" + ], + "summary": "Evaluate payment policies", + "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.\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 | **ViewPayments** |\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/AccountName" + }, + { + "$ref": "#/components/parameters/Content-Type" + }, + { + "$ref": "#/components/parameters/Accept" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPolicySearchRequest" + }, + "example": { + "items": [ + { + "id": "sku-01", + "collectionIds": [ + 139, + 45 + ], + "shippingData": { + "state": "NY" + } + }, + { + "id": "sku-02", + "collectionIds": [ + 200 + ], + "shippingData": { + "state": "NY" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPolicySearchResponse" + }, + "example": { + "paymentSystemAssignments": [ + { + "paymentSystem": 1, + "itemIds": [ + "sku-01", + "sku-02" + ] + }, + { + "paymentSystem": 4, + "itemIds": [ + "sku-01", + "sku-02" + ] + }, + { + "paymentSystem": 100, + "itemIds": [ + "sku-02" + ] + } + ], + "paymentSystemDefinitions": [ + { + "id": 1, + "name": "Debit Card", + "groupName": "debitCard" + }, + { + "id": 4, + "name": "Mastercard", + "groupName": "creditCard" + }, + { + "id": 100, + "name": "EBT Card", + "groupName": "ebt" + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + } + } + } + } + }, + "security": [ + { + "appKey": [], + "appToken": [] + }, + { + "VtexIdclientAutCookie": [] + } + ], + "components": { + "securitySchemes": { + "appKey": { + "type": "apiKey", + "in": "header", + "name": "X-VTEX-API-AppKey", + "description": "Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)." + }, + "appToken": { + "type": "apiKey", + "in": "header", + "name": "X-VTEX-API-AppToken", + "description": "Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)." + }, + "VtexIdclientAutCookie": { + "type": "apiKey", + "in": "header", + "name": "VtexIdclientAutCookie", + "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." + } + }, + "schemas": { + "PolicyRuleInput": { + "type": "object", + "description": "Payload used to create or replace a payment policy rule.", + "required": [ + "name", + "expression", + "enabled", + "priority", + "action", + "paymentSystems" + ], + "properties": { + "name": { + "type": "string", + "description": "Policy rule name." + }, + "expression": { + "$ref": "#/components/schemas/JsonLogicExpression" + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the policy rule is active." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Rule priority. Lower values have higher precedence when conflicting rules match the same item." + }, + "action": { + "type": "string", + "description": "Action applied to the payment systems when the rule expression matches.", + "enum": [ + "Include", + "Exclude" + ] + }, + "paymentSystems": { + "type": "array", + "description": "Payment system IDs affected by the rule.", + "items": { + "type": "integer", + "format": "int32", + "description": "Payment system ID." + } + } + } + }, + "PolicyRulePatch": { + "type": "object", + "description": "Payload used to update one or more fields of a payment policy rule.", + "properties": { + "name": { + "type": "string", + "description": "Policy rule name." + }, + "expression": { + "$ref": "#/components/schemas/JsonLogicExpression" + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the policy rule is active." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Rule priority. Lower values have higher precedence when conflicting rules match the same item." + }, + "action": { + "type": "string", + "description": "Action applied to the payment systems when the rule expression matches.", + "enum": [ + "Include", + "Exclude" + ] + }, + "paymentSystems": { + "type": "array", + "description": "Payment system IDs affected by the rule.", + "items": { + "type": "integer", + "format": "int32", + "description": "Payment system ID." + } + } + } + }, + "PolicyRule": { + "type": "object", + "description": "Payment policy rule returned by the API.", + "required": [ + "id", + "accountName", + "name", + "expression", + "enabled", + "priority", + "action", + "paymentSystems", + "createdAt", + "updatedAt" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "Unique identifier of the policy rule." + }, + "accountName": { + "type": "string", + "description": "VTEX account that owns the policy rule." + }, + "name": { + "type": "string", + "description": "Policy rule name." + }, + "expression": { + "$ref": "#/components/schemas/JsonLogicExpression" + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the policy rule is active." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Rule priority. Lower values have higher precedence when conflicting rules match the same item." + }, + "action": { + "type": "string", + "description": "Action applied to the payment systems when the rule expression matches.", + "enum": [ + "Include", + "Exclude" + ] + }, + "paymentSystems": { + "type": "array", + "description": "Payment system IDs affected by the rule.", + "items": { + "type": "integer", + "format": "int32", + "description": "Payment system ID." + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Date and time when the policy rule was created in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "Date and time when the policy rule was last updated in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + } + } + }, + "JsonLogicExpression": { + "type": "object", + "description": "JSONLogic expression evaluated against item context. Currently supports `and`, `or`, `==`, and `in`, with `collectionIds` and `shippingState` as available variables.", + "additionalProperties": true + }, + "PaymentPolicySearchRequest": { + "type": "object", + "description": "Payload used to evaluate payment policies for cart items.", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "description": "Cart items to evaluate against active payment policy rules.", + "items": { + "$ref": "#/components/schemas/PaymentPolicySearchItem" + } + } + } + }, + "PaymentPolicySearchItem": { + "type": "object", + "description": "Cart item context used by the payment policy engine.", + "required": [ + "id", + "collectionIds", + "shippingData" + ], + "properties": { + "id": { + "type": "string", + "description": "Item identifier used to map available payment systems back to the cart item." + }, + "collectionIds": { + "type": "array", + "description": "Collection IDs associated with the item in the VTEX catalog.", + "items": { + "type": "integer", + "format": "int32", + "description": "Collection ID." + } + }, + "shippingData": { + "type": "object", + "description": "Shipping context used by the payment policy engine.", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "string", + "description": "State code of the main delivery address." + } + } + } + } + }, + "PaymentPolicySearchResponse": { + "type": "object", + "description": "Payment policy evaluation result returned by the Payment Information Service.", + "required": [ + "paymentSystemAssignments", + "paymentSystemDefinitions" + ], + "properties": { + "paymentSystemAssignments": { + "type": "array", + "description": "Relationship between payment systems and the item IDs for which each payment system is available.", + "items": { + "$ref": "#/components/schemas/PaymentSystemAssignment" + } + }, + "paymentSystemDefinitions": { + "type": "array", + "description": "Payment system metadata for the payment systems returned in the assignments.", + "items": { + "$ref": "#/components/schemas/PaymentSystemDefinition" + } + } + } + }, + "PaymentSystemAssignment": { + "type": "object", + "description": "Payment system availability for one or more items.", + "required": [ + "paymentSystem", + "itemIds" + ], + "properties": { + "paymentSystem": { + "type": "integer", + "format": "int32", + "description": "Payment system ID." + }, + "itemIds": { + "type": "array", + "description": "Item IDs for which the payment system is available.", + "items": { + "type": "string", + "description": "Item ID." + } + } + } + }, + "PaymentSystemDefinition": { + "type": "object", + "description": "Payment system metadata.", + "required": [ + "id", + "name", + "groupName" + ], + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Payment system ID." + }, + "name": { + "type": "string", + "description": "Payment system display name." + }, + "groupName": { + "type": "string", + "description": "Payment system group name." + } + } + }, + "Error": { + "type": "object", + "description": "Error response returned when the request cannot be completed.", + "properties": { + "message": { + "type": "string", + "description": "Error message." + } + } + } + }, + "parameters": { + "Content-Type": { + "name": "Content-Type", + "in": "header", + "description": "Type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + }, + "Accept": { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + }, + "AccountName": { + "name": "an", + "in": "query", + "description": "Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "required": true, + "style": "form", + "schema": { + "type": "string", + "example": "cosmetics2" + } + }, + "PolicyRuleId": { + "name": "id", + "in": "path", + "description": "Unique identifier of the policy rule.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + }, + "responses": { + "BadRequest": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + }, + "example": { + "message": "Invalid JSONLogic expression, malformed request body, or policy rule limit exceeded." + } + } + } + }, + "Unauthorized": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + }, + "example": { + "message": "Missing or invalid credentials." + } + } + } + }, + "Forbidden": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + }, + "example": { + "message": "The user or API key does not have the required permission." + } + } + } + }, + "NotFound": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + }, + "example": { + "message": "Policy rule not found for the account." + } + } + } + } + } + }, + "tags": [ + { + "name": "Payment policy rules" + }, + { + "name": "Payment policy evaluation" + } + ] +} From 552fad7baef05e75680a89e235cb0e813ff4e704 Mon Sep 17 00:00:00 2001 From: Ricardo Correia <87548049+ricardoaerobr@users.noreply.github.com> Date: Mon, 18 May 2026 13:19:16 -0300 Subject: [PATCH 3/8] Delete Primary APIs.postman_collection (1).json --- Primary APIs.postman_collection (1).json | 15682 --------------------- 1 file changed, 15682 deletions(-) delete mode 100644 Primary APIs.postman_collection (1).json diff --git a/Primary APIs.postman_collection (1).json b/Primary APIs.postman_collection (1).json deleted file mode 100644 index a871641c5..000000000 --- a/Primary APIs.postman_collection (1).json +++ /dev/null @@ -1,15682 +0,0 @@ -{ - "info": { - "_postman_id": "6f9ecbeb-2271-4340-8fe1-945d77661db7", - "name": "Primary APIs", - "description": "These are the primary APIs for handling B2B cases.\n\n## Authentication\n\nYou can authenticate requests to these APIs by sending a VTEX user token in a header named `VtexIdclientAutCookie`. Learn more in [API authentication using user tokens](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens).\n\n## Changelog\n\nCheck our [Documentation Changelog](https://vtex.github.io/odp-docs/) to see the latest updates to this collection.", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "48144395", - "_collection_link": "https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/collection/2352637-6f9ecbeb-2271-4340-8fe1-945d77661db7?action=share&source=collection_link&creator=48144395" - }, - "item": [ - { - "name": "Contracts", - "item": [ - { - "name": "Create Contract", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"corporateDocument\": \"{{corporateDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"tradeName\": \"{{tradeName}}\",\r\n \"isCorporate\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\",\r\n \"priceTables\": \"{{priceTables}}\",\r\n \"restrictions\": {\r\n \"vtex.catalog\": {\r\n \"collectionIds\": []\r\n },\r\n \"vtex.checkout\": {\r\n \"creditCards\": [\"da89bc50-994e-4e39-9974-4a9d081cc3f4\",\"65ec3ec6-c504-4431-b17a-ea3800fb03d2\"]\r\n },\r\n \"vtex.payments\": {\r\n \"paymentSystemIds\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5,\r\n 7,\r\n 8,\r\n 9,\r\n 14,\r\n 21,\r\n 29,\r\n 31,\r\n 33,\r\n 34,\r\n 35,\r\n 36,\r\n 37,\r\n 48,\r\n 789]\r\n }\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents" - ] - }, - "description": "This endpoint enables you to create a new Contract, also referred to as the `CL` data entity.\n\n> ⚠️ When creating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/CL/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"email\": \"{{email}}\",\n \"firstName\": \"{{firstName}}\",\n \"lastName\": \"{{lastName}}\",\n \"document\": \"{{document}}\",\n \"documentType\": \"{{documentType}}\",\n \"isCorporate\": true,\n \"corporateDocument\": \"{{businessDocument}}\",\n \"homePhone\": \"{{homePhone}}\",\n \"cellPhone\": \"{{cellPhone}}\",\n \"corporateName\": \"{{corporateName}}\",\n \"tradeName\": \"{{doingBusinessAs}}\",\n \"stateRegistration\": \"\",\n \"isFreeStateRegistration\": \"true\",\n \"priceTables\": \"{{priceTables}}\",\n \"restrictions\": {\n \"vtex.catalog\": {\n \"collectionIds\": []\n },\n \"vtex.checkout\": {\n \"creditCards\": [\n \"da89bc50-994e-4e39-9974-4a9d081cc3f4\",\n \"65ec3ec6-c504-4431-b17a-ea3800fb03d2\"\n ]\n },\n \"vtex.payments\": {\n \"paymentSystemIds\": [\n 1, 2, 3, 4, 5, 7, 8, 9, 14, 21, 29, 31, 33, 34, 35, 36, 37, 48, 789\n ]\n }\n }\n}\n\n ```\n\n| Field | Type | Max Length | Description |\n| --- | --- | --- | --- |\n| `email` | `string` | 300 | The email of the contact. |\n| `firstName` | `string` | 300 | The first name of the contact. |\n| `lastName` | `string` | 300 | The last name of the contact. |\n| `document` | `string` | 300 | The document number of the contact. |\n| `documentType` | `string` | 300 | The type of document (e.g., \"EIN\", \"State Business Registration Number\"). |\n| `isCorporate` | `boolean` | \\- | Whether it's a legal entity. Always \"true\" for contracts. |\n| `corporateDocument` | `string` | 300 | The business document of the contact. |\n| `homePhone` | `string` | 300 | The home phone number of the contact. |\n| `cellPhone` | `string` | 300 | The cell phone number of the contact. |\n| `corporateName` | `string` | 300 | The corporate name of the contact. |\n| `tradeName` | `string` | 300 | The trade name (\"doing business as\") of the contact. |\n| `stateRegistration` | `string` | 300 | The state registration of the contact. |\n| `isFreeStateRegistration` | `boolean` | \\- | Indicates if the state registration is free. |\n| `priceTables` | `string` | 50 entries | Price tables associated with the contact, separated by commas. |\n| `restrictions` | `object` | \\- | Object with restriction definitions for `vtex.catalog`, `vtex.checkout`, and `vtex.payments`. |\n| └─ `vtex.catalog` | `object` | \\- | Contains restrictions regarding catalog. Fields: `collectionIds`. |\n| └─ `collectionIds` | `array of string` | | A list of collection IDs that define which product collections (sets of SKUs) the B2B customer can view or purchase from. These IDs are internal catalog entities used to group products logically. |\n| └─ `vtex.checkout` | `object` | \\- | Contains restrictions regarding checkout. Fields: `creditCards`. |\n| └─ `creditCards` | `array of string` | | A list of credit card IDs that the customer is allowed to use during checkout. These IDs reference cards stored in the BK entity, managed by the VTEX Checkout system. |\n| └─ `vtex.payments` | `object` | \\- | Contains restrictions regarding payments. Fields: `paymentSystemIds`. |\n| └─ `paymentSystemIds` | `array of string` | | A list of numeric IDs that represent the allowed payment systems (e.g., credit card processors) for the customer. These IDs are predefined and globally recognized by VTEX. |\n\n**Note**: Only the following restriction fields are accepted:\n\n- `vtex.catalog.collectionIds`\n \n- `vtex.checkout.creditCards`\n \n- `vtex.payments.paymentSystemIds`\n \n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/CL/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | The ID of the created contract document. |\n| `Href` | `string` | URL of the created document. |\n| `DocumentId` | `string` | The document ID. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"business-klub-spc@email.com\",\r\n \"firstName\": \"Business Klub\",\r\n \"lastName\": \"SPC\",\r\n \"document\": \"00000000000000\",\r\n \"documentType\": \"EIN\",\r\n \"corporateDocument\": \"00000000000000\",\r\n \"homePhone\": \"1122223333\",\r\n \"cellPhone\": \"11999991111\",\r\n \"businessPhone\": \"1122223333\",\r\n \"corporateName\": \"Business Klub SPC\",\r\n \"tradeName\": \"Business Klub SPC\",\r\n \"isCorporate\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\",\r\n \"priceTables\": \"CL-4000060,CL3000007,NCC,NCNC\",\r\n \"restrictions\": {\r\n \"vtex.payments\": {\r\n \"paymentSystemIds\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5,\r\n 7,\r\n 8,\r\n 9,\r\n 14,\r\n 21,\r\n 29,\r\n 31,\r\n 33,\r\n 34,\r\n 35,\r\n 36,\r\n 37,\r\n 48,\r\n 789]\r\n }\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "202" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Wed, 19 Mar 2025 21:43:29 GMT" - }, - { - "key": "x-vtex-took", - "value": "135" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.8-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "V7-IZnmhGRFbCKMOxAt_deklX3uTFhSkxJZ4UYnFRnif2Y10V_eL4Q==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/CL/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}" - } - ] - }, - { - "name": "Get Contract", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - }, - "description": "This endpoint retrieves information related to a given contract, by its unique identifier. The request should be sent as an HTTP GET to:\n\n```\nhttps://{{accountName}}.myvtex.com/api/dataentities/CL/documents/{{contractId}}?_fields=_all\n\n ```\n\n### Parameters\n\nThe request includes the\\`contractId\\` (ID of the contract to be deleted) as a path parameter, and the \"_fields=_all\" query parameter to specify that all fields of the document should be included in the response.\n\n### Request\n\n- Method: `GET`\n \n- Headers: `VtexIdclientAutCookie`\n \n- No request body required\n \n\n### Response\n\nReturns all available fields for the specified contract.\n\n#### Example Response:\n\n``` json\n{\n \"cluster\": null,\n \"priceTables\": \"CL-4000060,CL3000007,NCC,NCNC\",\n \"isCorporate\": null,\n \"tradeName\": null,\n \"rclastcart\": null,\n \"rclastcartvalue\": null,\n \"rclastsession\": null,\n \"rclastsessiondate\": null,\n \"homePhone\": \"1122223333\",\n \"phone\": null,\n \"brandPurchasedTag\": null,\n \"brandVisitedTag\": null,\n \"categoryPurchasedTag\": null,\n \"categoryVisitedTag\": null,\n \"departmentVisitedTag\": null,\n \"productPurchasedTag\": null,\n \"productVisitedTag\": null,\n \"stateRegistration\": \"\",\n \"email\": \"business-klub-spc@email.com\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"firstName\": \"Business Klub\",\n \"lastName\": \"SPC\",\n \"document\": \"00000000000000\",\n \"isNewsletterOptIn\": false,\n \"localeDefault\": null,\n \"attach\": null,\n \"approved\": null,\n \"birthDate\": null,\n \"businessPhone\": \"1122223333\",\n \"carttag\": null,\n \"checkouttag\": null,\n \"corporateDocument\": null,\n \"corporateName\": \"Business Klub SPC\",\n \"documentType\": \"CNPJ\",\n \"gender\": null,\n \"visitedProductWithStockOutSkusTag\": null,\n \"customerClass\": null,\n \"profilePicture\": null,\n \"birthDateMonth\": null,\n \"id\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"CL\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}\n\n ```\n\n### Field Descriptions\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `cluster`, `tradeName`, etc. | `null` | Internal or optional analytics/tags fields |\n| `priceTables` | `string` | Comma-separated list of assigned price table codes |\n| `homePhone`, `businessPhone` | `string` | Contact phone numbers |\n| `email`, `firstName`, `lastName` | `string` | Basic identity information |\n| `document`, `documentType` | `string` | The type of document (e.g., \"EIN\", \"State Business Registration Number\"). |\n| `corporateName` | `string` | Company’s registered corporate name |\n| `stateRegistration` | `string` | State-level registration number |\n| `isNewsletterOptIn` | `boolean` | Indicates newsletter opt-in status |\n| `createdIn`, `lastInteractionIn` | `string` | Timestamps of document creation and last update |\n| `id`, `dataEntityId` | `string` | Unique contract ID and fixed entity ID (always \"CL\") |\n| `accountId`, `accountName` | `string` | Internal VTEX account identifiers |\n| `followers`, `tags` | `array` | Metadata arrays |\n| Other nullable fields | `null` | May be present depending on account configuration or user interactions |\n\nNote: Some fields may be `null` if not applicable to the specific contract record." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents", - "2da4e9ab-050b-11f0-b37f-f4b136dbcce1" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:27:21 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.024" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "Content-Encoding", - "value": "gzip" - }, - { - "key": "Vary", - "value": "Accept-Encoding" - }, - { - "key": "trace-id", - "value": "00-6c22efa9bd304804c414d791bdf9ae72-a57b0ce57ba791c8-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"b91d4d8cb71380718e01487c9c0e2544\"" - }, - { - "key": "x-vtex-took", - "value": "15" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-31-82" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.022" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "TSeQuAQEPiuuBTWGYrh-90Is8xep2d-m2ouNutIlaxvtodVw0CZaNg==" - } - ], - "cookie": [], - "body": "{\n \"cluster\": null,\n \"priceTables\": \"CL-4000060,CL3000007,NCC,NCNC\",\n \"isCorporate\": true,\n \"tradeName\": null,\n \"rclastcart\": null,\n \"rclastcartvalue\": null,\n \"rclastsession\": null,\n \"rclastsessiondate\": null,\n \"homePhone\": \"1122223333\",\n \"phone\": null,\n \"brandPurchasedTag\": null,\n \"brandVisitedTag\": null,\n \"categoryPurchasedTag\": null,\n \"categoryVisitedTag\": null,\n \"departmentVisitedTag\": null,\n \"productPurchasedTag\": null,\n \"productVisitedTag\": null,\n \"stateRegistration\": \"\",\n \"email\": \"business-klub-spc@email.com\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"firstName\": \"Business Klub\",\n \"lastName\": \"SPC\",\n \"document\": \"00000000000000\",\n \"isNewsletterOptIn\": false,\n \"localeDefault\": null,\n \"attach\": null,\n \"approved\": null,\n \"birthDate\": null,\n \"businessPhone\": \"1122223333\",\n \"carttag\": null,\n \"checkouttag\": null,\n \"corporateDocument\": null,\n \"corporateName\": \"Business Klub SPC\",\n \"documentType\": \"CNPJ\",\n \"gender\": null,\n \"visitedProductWithStockOutSkusTag\": null,\n \"customerClass\": null,\n \"profilePicture\": null,\n \"birthDateMonth\": null,\n \"id\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"CL\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:43:29.7132146Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}" - } - ] - }, - { - "name": "Update Contract", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"accountAlias\": null,\r\n \"phone\": \"\",\r\n \"restrictions\": {\r\n \"vtex.catalog\": {\r\n \"collectionIds\": []\r\n },\r\n \"vtex.checkout\": {\r\n \"creditCards\": []\r\n },\r\n \"vtex.payments\": {\r\n \"paymentSystemIds\": [\r\n \"201\"\r\n ]\r\n }\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents", - "{{contractId}}" - ] - }, - "description": "**Update Contract**\n\nThis endpoint allows you to update an existing contract by its unique identifier.\n\n> ⚠️ When updating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n---\n\n### Request\n\n**Method:** PATCH \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/CL/documents/{{contractId}}`\n\n**Headers:**\n\n- `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n- `Content-Type: application/json`\n \n\n**Body Example:**\n\n``` json\n{\n \"email\": \"{{email}}\",\n \"firstName\": \"{{firstName}}\",\n \"lastName\": \"{{lastName}}\",\n \"document\": \"{{document}}\",\n \"documentType\": \"{{documentType}}\",\n \"businessDocument\": \"{{businessDocument}}\",\n \"homePhone\": \"{{homePhone}}\",\n \"cellPhone\": \"{{cellPhone}}\",\n \"corporateName\": \"{{corporateName}}\",\n \"tradeName\": \"{{doingBusinessAs}}\",\n \"isCorporate\": \"true\",\n \"stateRegistration\": \"\",\n \"isFreeStateRegistration\": \"true\",\n \"priceTables\": \"{{priceTables}}\"\n}\n\n ```\n\n---\n\n### Field Descriptions\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `email` | string | Yes | Email address of the contact. |\n| `firstName` | string | Yes | First name of the contact. |\n| `lastName` | string | Yes | Last name of the contact. |\n| `document` | string | Yes | Document number (e.g., CNPJ or CPF). |\n| `documentType` | string | Yes | The type of document (e.g., \"EIN\", \"State Business Registration Number\"). |\n| `corporateDocument` | string | No | Business document number if different from main document. |\n| `homePhone` | string | No | Home phone number. |\n| `cellPhone` | string | No | Cell phone number. |\n| `corporateName` | string | Yes | Legal name of the company. |\n| `tradeName` | string | No | Trade/fantasy name. |\n| `isCorporate` | boolean | Yes | Whether it's a legal entity. Always \"true\" for contracts. |\n| `stateRegistration` | string | No | State registration number. Can be empty. |\n| `isFreeStateRegistration` | boolean | No | Indicates if the registration is free/exempt. |\n| `priceTables` | string | No | Comma-separated list of price tables. |\n\n---\n\n### Response\n\n**Status Code:** `204 No Content`\n\nIndicates the contract was updated successfully. No body is returned." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"businessDocument\": \"{{businessDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"tradeName\": \"{{tradeName}}\",\r\n \"isCorporate\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\",\r\n \"priceTables\": \"{{priceTables}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents", - "{{contractId}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": null - } - ] - }, - { - "name": "Delete Contract", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{contractId}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - }, - "description": "**Delete Contract**\n\nThis endpoint allows you to delete a specific contract from the data entity `CL`.\n\n---\n\n### Delete Contract\n\n**Method:** DELETE \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/CL/documents/{{contractId}}?_fields=_all`\n\n**Headers:**\n\n- `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n\n**Request Body:** None\n\n**Response:**\n\n**Status Code:** `204 No Content`\n\nThe contract was deleted successfully. No response body is returned." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents/{{id}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents", - "{{id}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "plain", - "header": [ - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:28:22 GMT" - }, - { - "key": "x-vtex-took", - "value": "225" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "trace-id", - "value": "00-916a9a9627d3152b521eaf9a9ae23532-4edb9c5da7a8d3a3-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "Noe_pmDaIHW1UjbKydoVa0cLLumGh-I13hbiNEBSoKzU8H-Aubgqbw==" - } - ], - "cookie": [], - "body": null - } - ] - }, - { - "name": "Create Address", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"addressLabel\": \"{{addressLabel}}\",\r\n \"postalCode\": \"{{portalCode}}\",\r\n \"street\": \"{{street}}\",\r\n \"number\": \"{{number}}\",\r\n \"neighborhood\": \"{{meighboorhood}}\",\r\n \"complement\": \"\",\r\n \"city\": \"{{city}}\",\r\n \"state\": \"{{state}}\",\r\n \"country\": \"{{country}}\",\r\n \"receiverName\": \"{{receiverName}}\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial|invoice\",\r\n \"userId\": \"{{contractId}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "" - ] - }, - "description": "This endpoint allows you to register a new address, also referred to as the AD data entity.\n\n> ⚠️ When creating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n### Request\n\n**Method:** POST \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/`\n\n**Headers:**\n\n- `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n- `Content-Type: application/json`\n \n\n**Request Body:**\n\n``` json\n{\n \"addressLabel\": \"{{addressLabel}}\",\n \"postalCode\": \"{{postalCode}}\",\n \"street\": \"{{street}}\",\n \"number\": \"{{number}}\",\n \"neighborhood\": \"{{meighboorhood}}\",\n \"complement\": \"\",\n \"city\": \"{{city}}\",\n \"state\": \"{{state}}\",\n \"country\": \"{{country}}\",\n \"receiverName\": \"{{receiverName}}\",\n \"geoCoordinate\": \"\",\n \"addressType\": \"commercial|invoice\",\n \"userId\": \"{{contractId}}\"\n}\n\n ```\n\n### Field Descriptions\n\n| Field | Type | Description |\n| --- | --- | --- |\n| addressLabel | string | A user-defined label to identify the address |\n| postalCode | string | The postal code of the address. The format must be compatible with the address country postal code format. (e.g., '00000' for addresses in the USA) |\n| street | string | The street name of the address |\n| number | string | The street number of the address |\n| neighborhood | string | The neighborhood of the address |\n| complement | string | Any additional address information |\n| city | string | The city of the address |\n| state | string | The state of the address |\n| country | string | The country of the address in three-letter code format (e.g., \"USA\") |\n| receiverName | string | The name of the receiver |\n| geoCoordinate | string | The geographical coordinates of the address (optional) |\n| addressType | string | The type of address:
\\- `commercial`: for shipping.
\\- `invoice`: for billing. |\n| userId | string | The ID of the contract associated with the address |\n\n### Response\n\n**Status Code:** `200 OK`\n\n**Response Body:**\n\n``` json\n{\n \"Id\": \"AD-4286e252-050b-11f0-b37f-d6617047d485\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/AD/documents/4286e252-050b-11f0-b37f-d6617047d485\",\n \"DocumentId\": \"4286e252-050b-11f0-b37f-d6617047d485\"\n}\n\n ```\n\n### Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| Id | string | The prefixed ID of the document |\n| Href | string | The URL to access the created document |\n| DocumentId | string | The actual document ID (UUID) within the entity |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"addressLabel\": \"PRINCIPAL\",\r\n \"postalCode\": \"48226\",\r\n \"street\": \"Toringon Street\",\r\n \"number\": \"11\",\r\n \"neighborhood\": \"\",\r\n \"complement\": \"\",\r\n \"city\": \"Raleigh\",\r\n \"state\": \"NC\",\r\n \"country\": \"USA\",\r\n \"receiverName\": \"Backpack-Klub-LLC\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial\",\r\n \"userId\": \"{{contractBusinessKlubSPCId}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "202" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Wed, 19 Mar 2025 21:44:01 GMT" - }, - { - "key": "x-vtex-took", - "value": "119" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.8-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "laRj6wkBkcRK1VkfvH-LaWVq7jn57yD2N7LGgBzKJgTZ_hpTAduQZg==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"AD-4286e252-050b-11f0-b37f-d6617047d485\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/AD/documents/4286e252-050b-11f0-b37f-d6617047d485\",\n \"DocumentId\": \"4286e252-050b-11f0-b37f-d6617047d485\"\n}" - } - ] - }, - { - "name": "Get Address", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "{{addressId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - }, - "description": "# Get AD Document by ID\n\nThis endpoint retrieves information of a specific address by its unique identifier.\n\n### Request\n\n- **Method:** `GET`\n \n- **URL:** `https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}?_fields=_all`\n \n- **Headers:**\n \n - `VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}`\n \n\n> <p >ℹ️ No request body is required.</p> \n \n\n---\n\n### Response\n\n**Status:** `200 OK`\n\nThe response will contain a JSON object with the full details of the address document.\n\n#### Example Response\n\n``` json\n{\n \"addressLabel\": \"PRINCIPAL\",\n \"addressType\": \"commercial\",\n \"city\": \"Raleigh\",\n \"complement\": \"\",\n \"country\": \"USA\",\n \"countryfake\": null,\n \"geoCoordinate\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"11\",\n \"postalCode\": \"48226\",\n \"receiverName\": \"Backpack-Klub-LLC\",\n \"reference\": null,\n \"state\": \"NC\",\n \"street\": \"Toringon Street\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"id\": \"4286e252-050b-11f0-b37f-d6617047d485\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"AD\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}\n\n ```\n\n#### Response body fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| addressLabel | string | A user-defined label to identify the address |\n| addressType | string | The type of address:
\\- `commercial`: for shipping.
\\- `invoice`: for billing. |\n| city | string | The city of the address |\n| complement | string | Any additional information for the address (e.g., apartment, floor) |\n| country | string | The country of the address in three-letter code format (e.g., \"USA\") |\n| countryfake | string or null | Placeholder or optional country value |\n| geoCoordinate | string | Geographical coordinates of the address (latitude and longitude) |\n| neighborhood | string | The neighborhood of the address |\n| number | string | The street number of the address |\n| postalCode | string | The postal code of the address. The format must be compatible with the address country postal code format. (e.g., '00000' for addresses in the USA) |\n| receiverName | string | The name of the person or entity receiving at this address |\n| reference | string or null | Optional reference point or landmark near the address |\n| state | string | The state or province of the address |\n| street | string | The street name of the address |\n| userId | string | The ID of the user or related entity |\n| id | string | Unique identifier for this address record |\n| accountId | string | ID of the account related to this address |\n| accountName | string | Name of the account related to this address |\n| dataEntityId | string | ID of the data entity this address belongs to |\n| createdBy | string | ID of the user who created the address record |\n| createdIn | string | Timestamp of when the address record was created |\n| updatedBy | string or null | ID of the user who last updated the address record |\n| updatedIn | string or null | Timestamp of the last update to the address record |\n| lastInteractionBy | string | ID of the user who had the last interaction with the record |\n| lastInteractionIn | string | Timestamp of the last interaction with the record |\n| followers | array | List of users following this address record |\n| tags | array | List of tags associated with this address |\n| auto_filter | string or null | Optional field used for automatic filtering or categorization |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{id}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "{{id}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "755" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:29:23 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.088" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "trace-id", - "value": "00-58a18223a783f0dfd0c792be732650f6-dbff3563b6b3d2ac-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"5b1df6c9a17a37929db5da78e1a8d898\"" - }, - { - "key": "x-vtex-took", - "value": "83" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-30-248" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.088" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "D1a5_1N7cu5WSkIRD2lpCecVI3CcQ880Ljk98A-hCoItYQXYSl1u9A==" - } - ], - "cookie": [], - "body": "{\n \"addressLabel\": \"PRINCIPAL\",\n \"addressType\": \"commercial\",\n \"city\": \"Raleigh\",\n \"complement\": \"\",\n \"country\": \"USA\",\n \"countryfake\": null,\n \"geoCoordinate\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"11\",\n \"postalCode\": \"48226\",\n \"receiverName\": \"Backpack-Klub-LLC\",\n \"reference\": null,\n \"state\": \"NC\",\n \"street\": \"Toringon Street\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"id\": \"4286e252-050b-11f0-b37f-d6617047d485\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"AD\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"updatedBy\": null,\n \"updatedIn\": null,\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionIn\": \"2025-03-19T21:44:01.4199691Z\",\n \"followers\": [],\n \"tags\": [],\n \"auto_filter\": null\n}" - } - ] - }, - { - "name": "Update Address", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"addressLabel\": \"{{addressLabel}}\",\r\n \"postalCode\": \"{{portalCode}}\",\r\n \"street\": \"{{street}}\",\r\n \"number\": \"{{number}}\",\r\n \"neighborhood\": \"{{meighboorhood}}\",\r\n \"complement\": \"\",\r\n \"city\": \"{{city}}\",\r\n \"state\": \"{{state}}\",\r\n \"country\": \"{{country}}\",\r\n \"receiverName\": \"{{receiverName}}\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial|invoice\",\r\n \"userId\": \"{{contractId}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "{{addressId}}" - ] - }, - "description": "### Update Address (AD)\n\nThis endpoint allows you to update an existing address document in the `AD` data entity.\n\n> ⚠️ When updating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#). \n \n\n---\n\n#### Request\n\n- **Method**: `PATCH`\n \n- **URL**:\n \n ```\n https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}\n \n ```\n \n- **Headers**:\n \n | Key | Value |\n | --- | --- |\n | `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n | `Content-Type` | `application/json` |\n \n- **Request body fields**:\n \n\n| Field | Type | Description |\n| --- | --- | --- |\n| addressLabel | string | A user-defined label to identify the address |\n| postalCode | string | The postal code of the address. The format must be compatible with the address country postal code format. (e.g., '00000' for addresses in the USA) |\n| street | string | The street name of the address |\n| number | string | The street number of the address |\n| neighborhood | string | The neighborhood of the address |\n| complement | string | Any additional address information |\n| city | string | The city of the address |\n| state | string | The state of the address |\n| country | string | The country of the address in three-letter code format (e.g., \"USA\") |\n| receiverName | string | The name of the receiver |\n| geoCoordinate | string | Geographical coordinates of the address |\n| addressType | string | The type of address:
\\- `commercial`: for shipping.
\\- `invoice`: for billing. |\n| userId | string | The ID of the related contract. |\n\n---\n\n#### Response\n\n- **Status**: `204 No Content` \n The address was successfully updated." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"addressName\": \"{{addressName}}\",\r\n \"postalCode\": \"{{portalCode}}\",\r\n \"street\": \"{{street}}\",\r\n \"number\": \"{{number}}\",\r\n \"neighborhood\": \"\",\r\n \"complement\": \"\",\r\n \"city\": \"{{city}}\",\r\n \"state\": \"{{state}}\",\r\n \"country\": \"{{country}}\",\r\n \"receiverName\": \"{{receiverName}}\",\r\n \"geoCoordinate\": \"\",\r\n \"addressType\": \"commercial|invoice\",\r\n \"userId\": \"{{contractId}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "{{addressId}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": null - } - ] - }, - { - "name": "Delete Address", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{addressId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "{{addressId}}" - ] - }, - "description": "### Delete Address Document (AD Entity)\n\nThis endpoint allows you to delete a specific address document from the `AD` data entity.\n\n#### Request\n\n**Method:** `DELETE` \n**URL:** `https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}`\n\n**Path Parameters**:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| addressId | string | The ID of the address to be deleted |\n\n**Headers**:\n\n| Header | Value |\n| --- | --- |\n| VtexIdclientAutCookie | `{{vault:VtexIdclientAutCookie}}` |\n\n**Body:** None\n\n#### Response\n\n- **Status Code:** `204 No Content` (on success)\n \n- No response body will be returned.\n \n\n#### Example CURL\n\n``` bash\ncurl --location --globoff --request DELETE 'https://{{accountName}}.myvtex.com/api/dataentities/AD/documents/{{addressId}}' \\\n--header 'VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}'\n\n ```" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/AD/documents/{{id}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "AD", - "documents", - "{{id}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "755" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:29:23 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.088" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "trace-id", - "value": "00-58a18223a783f0dfd0c792be732650f6-dbff3563b6b3d2ac-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"5b1df6c9a17a37929db5da78e1a8d898\"" - }, - { - "key": "x-vtex-took", - "value": "83" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-30-248" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.088" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "D1a5_1N7cu5WSkIRD2lpCecVI3CcQ880Ljk98A-hCoItYQXYSl1u9A==" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "These APIs are for creating the contract, and are expected to be used only for store management. Contracts meaning B2B clients of your store.\n\nIn this collection there are auxiliary APIs to support filling out the contract, especially the restrictions object.\n\n### Restrictions\n\nIn the context of this API, **restrictions** define the specific commercial and operational limits that a merchant configures for a contract. These restrictions determine how the customer can interact with the store across key systems such as catalog access, data management, checkout options, and payment methods.\n\nWhile the values configured in the `restrictions` object are not directly passed to the systems, they are used to generate the valid inputs that are. This ensures that the customer’s shopping and purchasing experience aligns with their contract terms and business agreements." - }, - { - "name": "Users & Units", - "item": [ - { - "name": "Users", - "item": [ - { - "name": "Get User", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/users/{{userId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "users", - "{{userId}}" - ] - }, - "description": "Retrieves information about a specific user from the License Manager.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/license-manager/users/{{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"ad60c84ca72b44da8256a61058c0a4c6\",\n \"email\": \"emily.brown@email.com\",\n \"name\": \"Emily Brown\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the user. |\n| `email` | `string` | Email of the user. |\n| `name` | `string` | Name of the user. |\n\n---\n\n**Official Documentation**: [VTEX License Manager - Get User](https://developers.vtex.com/docs/api-reference/license-manager-api#get-/api/license-manager/users/-userId-)" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"Emily Brown\",\r\n \"email\": \"emily.brown@email.com\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "users" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "94" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:58:50 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "vlm-v5.54.7" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 a263c5e625088b97c5317725b2dccc7c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "4FtbmiXmqy1cnhZ3xpI7ittb8GIIKMkFa--j18MSKycgUtWEhEdiAw==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"ad60c84ca72b44da8256a61058c0a4c6\",\n \"email\": \"emily.brown@email.com\",\n \"name\": \"Emily Brown\"\n}" - } - ] - }, - { - "name": "Create User", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIDClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"Beneson Damasceno 2\",\r\n \"email\": \"beneson2010@gmail.com\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/users/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "users", - "" - ] - }, - "description": "Creates a new user in the License Manager.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/license-manager/users/`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Request Body\n\nThe request must include a JSON object in the body with the following parameters:\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| name | string | Yes | Name of the user. |\n| email | string | Yes | Email of the user |\n\n#### Example Request Body\n\n``` json\n{\n \"name\":\"{{name}}\"\n \"email\":\"{{email}}\"\n}\n\n ```\n\n### Response\n\n#### Success Response\n\n- **Status Code:** `200 OK`\n \n- **Body:**\n \n\n``` json\n{\n\"id\": \"16eec272115a4ee8b0063977fa90f904\",\n\"email\": \"lois.lane@company.com\",\n\"name\": \"Lois Lane\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | string | ID of the created user. |\n| name | string | Name os the user. |\n| email | string | Email of the user. |\n\nOfficial Documentation: [VTEX License Manager - Create User](https://developers.vtex.com/docs/api-reference/license-manager-api#post-/api/license-manager/users)" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIDClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"{{name}}\",\r\n \"email\": \"{{email}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/users/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "users", - "" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"id\": \"16eec272115a4ee8b0063977fa90f904\",\n \"email\": \"lois.lane@company.com\",\n \"name\": \"Lois Lane\"\n}" - } - ] - }, - { - "name": "Delete User", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/license-manager/users/{{userId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "users", - "{{userId}}" - ] - }, - "description": "Deletes a user from the License Manager.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/license-manager/users/{{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `userId` | `string` | Yes | The ID of the user to be deleted. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: `null` (Empty response body indicates successful deletion)\n \n\n---\n\n**Official Documentation**: [VTEX License Manager - Delete User](https://developers.vtex.com/docs/api-reference/license-manager-api#delete-/api/license-manager/users/-userId-)" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"Emily Brown\",\r\n \"email\": \"emily.brown@email.com\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/users/{{id}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "users", - "{{id}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Length", - "value": "94" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:58:50 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "vlm-v5.54.7" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 a263c5e625088b97c5317725b2dccc7c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "4FtbmiXmqy1cnhZ3xpI7ittb8GIIKMkFa--j18MSKycgUtWEhEdiAw==" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Get Scope by User", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/users/{{userId}}/scopes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "users", - "{{userId}}", - "scopes" - ] - }, - "description": "Retrieves the scopes of a user within the specified account.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/users/{{userId}}/scopes`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `accountName` | `string` | Yes | The VTEX account name. |\n| `userId` | `string` | Yes | The unique identifier of the user. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"contractIds\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `contractIds` | `string[]` | A list of contract IDs representing user scopes. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/users//scopes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "users", - "", - "scopes" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 28 Mar 2025 21:37:04 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "10" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "e59e5294-aa08-41d1-a539-d00693d99022" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 f3927a57c758d8bb98768c87c3fc924c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "-gdoA1p3g8FSe6oVesvtRc6uJUAFMpOAlifyId_g9gwRtdnVRneTXQ==" - } - ], - "cookie": [], - "body": "{\n \"contractIds\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}" - } - ] - }, - { - "name": "Get Unit by User", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{userId}}/unit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{userId}}", - "unit" - ] - }, - "description": "Retrieves the organization unit assigned to a specific user.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{userId}}/unit`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `accountName` | `string` | Yes | The VTEX account name. |\n| `userId` | `string` | Yes | The ID of the user. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:07.190377Z\",\n \"name\": \"{{unit_name}}\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"names\": \"\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit assignment was created. |\n| `updatedAt` | `string` | Timestamp when the unit assignment was last updated. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | The full ID path of the unit. |\n| `path.names` | `string` | The full name path of the unit (may be empty). |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{userId}}/unit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{userId}}", - "unit" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:07.190377Z\",\n \"name\": \"{{unit_name}}\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"names\": \"\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Get User ID by Email", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/pvt/user/id?usuario={{url-encoded-email-address}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "vtexid", - "pvt", - "user", - "id" - ], - "query": [ - { - "key": "usuario", - "value": "{{url-encoded-email-address}}", - "description": "URL-encoded email address" - } - ] - }, - "description": "This request allows you to retrieve a shopper's information by their email address.\n\n### Example request\n\n```\ncurl -L 'https://mystore.vtexcommercestable.com.br/api/vtexid/pvt/user/id?usuario=clark.kent+buyer@vtex.com' \\\n-H 'VtexIdclientAutCookie: {{vault:VtexIdclientAutCookie}}'\n\n ```\n\n### Response\n\nThe response to this request is just the user ID in plain text, like the example below:\n\n```\n\"80479899c9d-a34c-437d-92c5-1d774db2dd40\"\n```" - }, - "response": [] - } - ], - "description": "Users are individuals within tha buyer organization that have access to the platform via unique email address. Users belong to an organizational unit and have role-based permissions for purchasing, approvals, or management.\n\n> Each user is tied to a single email and cannot belong to multiple organizational units. \n \n\nUsers actions are limited by scopes inherited from the unit they belong to." - }, - { - "name": "Units", - "item": [ - { - "name": "Scopes", - "item": [ - { - "name": "Contracts", - "item": [ - { - "name": "Create Scope Contracts in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "contractIds" - ] - }, - "description": "This endpoint adds specific scope Contract IDs to a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{scopeId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "contractIds" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Contracts from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "contractIds" - ] - }, - "description": "Remove a contract type of scope from a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "contractIds" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Remove Value from Scope Contracts in Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "contractIds", - "remove" - ] - }, - "description": "Removes specific scope Contract IDs from a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds/remove", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "contractIds", - "remove" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" - } - ] - }, - { - "name": "Update Scope Contracts in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/contractIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "contractIds" - ] - }, - "description": "This endpoint replaces all Contract IDs in the scope of a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/contractIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{contractId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{scopeId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/contractIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "contractIds" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Addresses", - "item": [ - { - "name": "Create Scope Addresses in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "addresses" - ] - }, - "description": "This endpoint adds specific Addresses IDs to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "addresses" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Addresses from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "addresses" - ] - }, - "description": "Removes all addresses from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "addresses" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Remove Value from Scope Addresses in Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "addresses", - "remove" - ] - }, - "description": "Removes specific Addresses from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"66664b68-74da-4fc4-b51a-9ddcb8baf29a\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "addresses", - "remove" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" - } - ] - }, - { - "name": "Update Scope Addresses in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/addresses", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "addresses" - ] - }, - "description": "This endpoint replaces all Addresses for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/addresses`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{addressId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/addresses", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "addresses" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"addresses\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Payment Systems", - "item": [ - { - "name": "Create Scope Payment Systems in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "paymentSystemIds" - ] - }, - "description": "Adds specific payment systems to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"4d128b79-5d4b-44d4-bb0f-6d86e2c33317\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "paymentSystemIds" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"4d128b79-5d4b-44d4-bb0f-6d86e2c33317\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Payment Systems from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "paymentSystemIds" - ] - }, - "description": "Removes all payment systems from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "paymentSystemIds" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Remove Value from Scope Payment Systems in Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "paymentSystemIds", - "remove" - ] - }, - "description": "Removes specific payment systems from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"4d128b79-5d4b-44d4-bb0f-6d86e2c33317\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "paymentSystemIds", - "remove" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" - } - ] - }, - { - "name": "Update Scope Payment Systems in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "paymentSystemIds" - ] - }, - "description": "This endpoint replaces all Addresses for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/paymentSystemIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{paymentSystemId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/paymentSystemIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "paymentSystemIds" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"paymentSystemIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Price Tables", - "item": [ - { - "name": "Create Scope Price Tables in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "priceTables" - ] - }, - "description": "Adds specific price tables to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/priceTables`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"863ae2fc-10eb-4468-973a-fe63243dc8c2\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "priceTables" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"863ae2fc-10eb-4468-973a-fe63243dc8c2\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Price Tables from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "priceTables" - ] - }, - "description": "Removes all price tables from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/priceTables`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "priceTables" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Remove Value from Scope Price Tables in Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "priceTables", - "remove" - ] - }, - "description": "Removes specific price tables from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/priceTables/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"863ae2fc-10eb-4468-973a-fe63243dc8c2\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "priceTables", - "remove" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a,\n \"scope\": \"priceTables\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" - } - ] - }, - { - "name": "Update Scope Price Tables in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{priceTable}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/priceTables", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "priceTables" - ] - }, - "description": "This endpoint replaces all price tables for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/{{scopeType}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n| `scopeType` | `string` | The scope to be replaced. Accepted values: `contractIds`, `addresses`, `paymentSystemIds`, `priceTables`, `collectionIds`, `creditCards`, `customFields`. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{scopeId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"contractIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/priceTables", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "priceTables" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"priceTables\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Collections", - "item": [ - { - "name": "Create Scope Collections in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "collectionIds" - ] - }, - "description": "Adds specific collections to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"7d3566c8-c761-4cbf-a347-c94ea6e9985d\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/collectionIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "collectionIds" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"7d3566c8-c761-4cbf-a347-c94ea6e9985d\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Collections from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "collectionIds" - ] - }, - "description": "Removes all collections from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/collectionIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", - "scopes", - "collectionIds" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Remove Value from Scope Collections in Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{collectionId}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "collectionIds", - "remove" - ] - }, - "description": "Removes specific collections from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"7d3566c8-c761-4cbf-a347-c94ea6e9985d\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "collectionIds", - "remove" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" - } - ] - }, - { - "name": "Update Scope Collections in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/collectionIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "collectionIds" - ] - }, - "description": "This endpoint replaces all collections for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/collectionIds`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{collectionId}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/collectionIds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", - "scopes", - "collectionIds" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"collectionIds\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Credit Cards", - "item": [ - { - "name": "Create Scope Credit Cards in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "creditCards" - ] - }, - "description": "Adds specific credit cards to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be added to the scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | List of successfully added scope IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"eae94554-5452-4b0f-9eba-901dd8b3512e\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/creditCards", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "creditCards" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"eae94554-5452-4b0f-9eba-901dd8b3512e\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Credit Cards from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "creditCards" - ] - }, - "description": "Removes all credit cards from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/creditCards", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", - "scopes", - "creditCards" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Remove Value from Scope Credit Cards in Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "creditCards", - "remove" - ] - }, - "description": "Removes specific credit cards from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards/remove`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"3\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs to be removed from scope. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope type from which IDs were removed. |\n| `ids` | `string[]` | List of IDs successfully removed. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"eae94554-5452-4b0f-9eba-901dd8b3512e\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/creditCards/remove", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", - "scopes", - "creditCards", - "remove" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"2fec79e2-29e0-11f0-b37f-a3ab2fa6b35d\"\n ]\n}" - } - ] - }, - { - "name": "Update Scope Credit Cards in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/creditCards", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "creditCards" - ] - }, - "description": "This endpoint replaces all credit cards for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/creditCards`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{{creditCard}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Array of IDs that will replace the current ones. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | List of scope IDs now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/creditCards", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", - "scopes", - "creditCards" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"creditCards\",\n \"ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Custom Fields", - "item": [ - { - "name": "Create Scope Custom Fields in Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\"]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "customFields" - ] - }, - "description": "Adds specific custom fields to a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/customFields`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\"]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Custom fields and ids in a single item of the array to be added to the scope. The string is a JSON-serialized object. The keys are custom field names, and the values are objects with an ids array containing UUIDs. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\"]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope to which IDs were added. |\n| `ids` | `string[]` | A single item array with custom fields and its ids successfully added to the scope. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"ids\": [\r\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes", - "customFields" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:34:04 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "2f4ccabe-585d-46c8-8c76-31ae4d9a98de" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "124" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "69Wc4OfFGlXCfRT84msjLNZ87MrIVK8cSNENx7O2z4anpG8XDbt1iA==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}" - } - ] - }, - { - "name": "Delete Scope Custom Fields from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "customFields" - ] - }, - "description": "Removes all custom fields from a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/customFields`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\n| Path Parameter | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd/scopes/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd", - "scopes", - "customFields" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Update Scope Custom Fields in Unit", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "customFields" - ] - }, - "description": "This endpoint replaces all custom fields for a given organization unit's scope.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes/customFields`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Path Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `unitId` | `string` | The ID of the organization unit. |\n\n#### Request Body\n\n``` json\n{\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ids` | `string[]` | Yes | Custom fields and ids in a single item of the array to be added to the scope. The string is a JSON-serialized object. The keys are custom field names, and the values are objects with an ids array containing UUIDs. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"{{customFieldName}}\\\":{\\\"ids\\\":[]},\\\"{{anotherCustomFieldName}}\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]}}\"\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scope` | `string` | The scope for which the IDs were updated. |\n| `ids` | `string[]` | Custom fields and ids in a single item of the array that are now assigned. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes", - "customFields" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"organizationUnitId\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"scope\": \"customFields\",\n \"ids\": [\n \"{\\\"poNumber\\\":{\\\"ids\\\":[\\\"59768df9-afeb-45c8-93e6-db3635c885af\\\",\\\"572bca72-4699-4426-a562-889606a77e8e\\\"]},\\\"CostCenter\\\":{\\\"ids\\\":[\\\"b46a2029-fa4f-425b-92a1-ca845cc18691\\\"]},\\\"Release\\\":{\\\"ids\\\":[]},\\\"Location\\\":{\\\"ids\\\":[]}}\"\n ]\n}" - } - ] - } - ] - }, - { - "name": "Delete All Scopes from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes" - ] - }, - "description": "Removes all scope assignments from a given organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes`\n \n- **Authentication**: Requires `VtexIdClientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp of unit creation. |\n| `updatedAt` | `string` | Timestamp of last update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Hierarchical path identifier. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | Associated customer contract IDs. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdClientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.815188Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Get Scopes by Unit", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/scopes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "scopes" - ] - }, - "description": "Retrieves all scopes assigned to a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/scopes`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scopes\": [\n {\n \"scope\": \"creditCards\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | The ID of the organization unit. |\n| `scopes` | `array` | A list of scope objects assigned to the unit. |\n| `scopes[].scope` | `string` | The type of the scope (e.g., `creditCards`). |\n| `scopes[].ids` | `string[]` | Array of IDs associated with the given scope type (e.g., credit card IDs). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/92264b68-74da-4fc4-b51a-9ddcb8baf29a/scopes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "92264b68-74da-4fc4-b51a-9ddcb8baf29a", - "scopes" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 27 Mar 2025 14:29:50 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "26" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "b42c8836-6254-4d56-b6a0-51ed8bf5baee" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b93e1df8c9b030e62bc95fcea82dd72a.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "etbSAbhWxYn4v02bfBURid6a_gLTW9roNvm2jMO1vJCjEVgLSf2UQQ==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"scopes\": [\n {\n \"scope\": \"creditCards\",\n \"ids\": [\n \"21770434-1061-4ac5-bb4c-fce528aefbd1\"\n ]\n }\n ]\n}" - } - ] - } - ], - "description": "You can use scopes to restrict access to resources related to the purchase flow. To do this, use the requests below to assign scopes to units. Users belonging to a unit will only be able to access the resources included in that unit's scopes.\n\nThese resources are:\n\n- Contracts\n \n- Addresses\n \n- Payment Systems\n \n- Price Tables\n \n- Collections\n \n- Credit Cards\n \n- Custom Fields\n \n\nSee the sections below to learn more about how to manage scopes for different resources.\n\n### Session\n\nThe enforcing of the scopes during the purchase flow depends on the `vtex_session` cookie. Learn more:\n\n- [Sessions System Overview](https://developers.vtex.com/docs/guides/sessions-system-overview)\n \n- [Session Manager API](https://developers.vtex.com/docs/api-reference/session-manager-api)" - }, - { - "name": "Create Unit", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"{{unitName}}\"\r\n}\r\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1" - ] - }, - "description": "Creates a new organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"name\": \"{{unitName}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | The name of the unit to be created. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-03-19T21:27:15.2275104Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"nationa-chamber\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the newly created unit. |\n| `path.ids` | `string` | The full ID path of the unit. |\n| `id` | `string` | ID of the created organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"nationa-chamber\"\r\n}\r\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Wed, 19 Mar 2025 21:27:15 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "84" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "1fbd3f92-82a2-4008-b7c0-010b58ae3877" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 bea03c5dc8c5155adf8c603f739f7c60.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "K3GeHgCG1s2Rv2lvcPirv6MFdI8mlRFF2bLt7Q8wTow09UZqx1zK6w==" - } - ], - "cookie": [], - "body": "{\n \"createdAt\": \"2025-03-19T21:27:15.2275104Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"nationa-chamber\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Get Unit", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - }, - "description": "Retrieves the details of a specific organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-name\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"names\": \"unit-name\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `path.names` | `string` | Full name path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:37:10 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "67" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" - } - ], - "cookie": [], - "body": "{\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-name\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"names\": \"unit-name\"\n },\n \"id\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Get all Units from Scope Value", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "{{scopeName}}", - "value", - "{{scopeValue}}" - ] - }, - "description": "This endpoint retrieves data related to a scope associated with organizational units.\n\n---\n\n| **Variables** | Required | Type | **Description** | **Example** |\n| --- | --- | --- | --- | --- |\n| `{{accountName}}` | Yes | `string` | The name of the VTEX account. | `myaccount` |\n| `{{scopeName}}` | Yes | `string` | The name of the scope category for which data should be retrieved. Supported values are:
\\- `creditCards`
\\- `installmentOptions`
\\- `collectionIds`
\\- `priceTables`
\\- `paymentSystemIds`
\\- `addresses` | `contractIds` |\n| `{{scopeValue}}` | Yes | `string` | The unique identifier within the given scope: For `contractIds`, use the contract ID. | `\"9025fbdd-6271-11f0-b37f-f5b4d28a6ca2\"` |\n\n### Examples\n\nSee below for example routes for each scope:\n\n| **Scope** | **Route** |\n| --- | --- |\n| `creditCards` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/creditCards/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `contractIds` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/creditCards/value/9025fbdd-6271-11f0-b37f-f5b4d28a6ca2 |\n| `installmentOptions` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/installmentOptions/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `collectionIds` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/collectionIds/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `priceTables` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/priceTables/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `paymentSystemIds` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/paymentSystemIds/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n| `addresses` | https://{{accountName}}.myvtex.com/api/organization-units/v1/scope/addresses/value/1b542f8b-61bf-11f0-b37g-f28c76628364 |\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: StartFragment{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}EndFragment\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Permission:** You must have the `View_Unit` or `View_Organization_Unit` permission.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\nThe structure and content of the response body follows the pattern below:\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"guid\",\n \"name\": \"string\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the organizational unit. |\n| `name` | `string` | The name of the organizational unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "{{scopeName}}", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:37:10 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "67" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Sales Department Northeast\"\n }\n]" - }, - { - "name": "Success No Content", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "{{scopeName}}", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Error Response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "{{scopeName}}", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Error Response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/{{scopeName}}/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "{{scopeName}}", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Get all Units from Scope Value - customField", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "customField", - "value", - "{{scopeValue}}" - ] - }, - "description": "This endpoint retrieves data related to scope `customField` associated with organizational units.\n\n---\n\n| **Variables** | Required | Type | **Description** | **Example** |\n| --- | --- | --- | --- | --- |\n| `{{accountName}}` | Yes | `string` | The name of the VTEX account. | `myaccount` |\n| `{{scopeValue}}` | Yes | `string` | The unique identifier for `customField`: Use a stringified JSON object, where keys are field names and values are objects containing an array of `ids`. | `{\"PO Number\":{\"ids\":[\"9025fbdd-6271-11f0-b37f-f5b4d28a6ca2\"]}}` |\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: StartFragment{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}EndFragment\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Permission:** You must have the `View_Unit` or `View_Organization_Unit` permission.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\nThe structure and content of the response body follows the pattern below:\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"guid\",\n \"name\": \"string\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the organizational unit. |\n| `name` | `string` | The name of the organizational unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "customField", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:37:10 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "67" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Sales Department Northeast\"\n }\n]" - }, - { - "name": "Success No Content", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "customField", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Error Response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "customField", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Error Response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "description": "VTEX authentication token", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/scope/customField/value/{{scopeValue}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "scope", - "customField", - "value", - "{{scopeValue}}" - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Rename Unit", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"{{unitName}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - }, - "description": "Updates the name of a specific organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"name\": \"{{unitName}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | New name for the unit. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.8151882Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was originally created. |\n| `updatedAt` | `string` | Timestamp of the most recent update. |\n| `name` | `string` | Updated name of the organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"{{unitName}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"createdAt\": \"2025-05-17T06:54:07.190377Z\",\n \"updatedAt\": \"2025-05-17T06:54:38.8151882Z\",\n \"name\": \"New Unit to Test Updating names\",\n \"path\": {\n \"ids\": \"qastore/3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\"\n },\n \"id\": \"3e378a60-f4f1-4e0b-ab6a-03ebee95a5fd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Delete Unit", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - }, - "description": "Deletes a specific organization unit identified by the unit ID.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a body.\n\n#### Path Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `unitId` | `string` | Yes | The unique identifier of the unit to delete. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: Empty (indicates successful deletion)" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:37:10 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "67" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Search Units", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/?name={{term}}&page=1&pageSize=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "" - ], - "query": [ - { - "key": "name", - "value": "{{term}}" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "10" - } - ] - }, - "description": "Retrieves a list of organization units based on the provided query parameters.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/?name={{term}}&page=1&pageSize=10`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | No | A term to filter units by name. |\n| `page` | `number` | No | The page number of the results. |\n| `pageSize` | `number` | No | The number of results per page. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"names\": \"unit-a\"\n },\n \"id\": \"b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-18T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-18T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"names\": \"unit-b\"\n },\n \"id\": \"b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `path.names` | `string` | Full name path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:37:10 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "67" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "6c4360e9-c324-455e-8953-9cdc7c20cf7e" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 22c77dfd553d2a30a61b0b86e2a8d5f0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "GmyXAIWjybZVXLyNqt7Nhi_Zogh84QYfXL_j1adBM8FMlgm1LeJE-g==" - } - ], - "cookie": [], - "body": "[\n {\n \"createdAt\": \"2025-03-19T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-19T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"names\": \"unit-a\"\n },\n \"id\": \"b13211bb-8242-43fd-80f5-3263fr4e9cdd\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-18T21:27:15.22751Z\",\n \"updatedAt\": \"2025-03-18T21:27:15.227511Z\",\n \"name\": \"unit-b\",\n \"path\": {\n \"ids\": \"account/b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"names\": \"unit-b\"\n },\n \"id\": \"b13531xc-8242-43fd-23f5-3263dd4e9xer\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n" - } - ] - }, - { - "name": "Move Unit", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"parentId\": \"{{parentId}}\"\r\n}\r\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/path", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "path" - ] - }, - "description": "Updates the path of a specific organization unit, by passing the ID of the unit you wish to be the new parent.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/path`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"parentId\": \"{{parentId}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `parentId` | `string` | Yes | The ID of the new parent unit. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.5957585Z\",\n \"name\": \"hub-365\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp of the most recent update. |\n| `name` | `string` | Name of the organization unit. |\n| `path.ids` | `string` | Updated full ID path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"parentId\": \"{{unitNationaChamberId}}\"\r\n}\r\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/path", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "path" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Wed, 19 Mar 2025 21:28:17 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "140" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "1b917ac5-3755-4930-acc1-8d7753d3ad78" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 bea03c5dc8c5155adf8c603f739f7c60.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "2cRVKSqtJIlzumKgHQfb1ajRMcIWmgQHtsau9Q9dEp1_e9hv7U8GeQ==" - } - ], - "cookie": [], - "body": "{\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.5957585Z\",\n \"name\": \"hub-365\",\n \"path\": {\n \"ids\": \"qastore/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n}" - } - ] - }, - { - "name": "Get Unit Children", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/{{unitId}}/children", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "{{unitId}}", - "children" - ] - }, - "description": "Retrieves the children of a specific organization unit identified by the provided ID.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/{{unitId}}/children`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"createdAt\": \"2025-03-19T21:44:33.468045Z\",\n \"updatedAt\": \"2025-03-19T21:44:49.331893Z\",\n \"name\": \"unit-1\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\"\n },\n \"id\": \"40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.595758Z\",\n \"name\": \"unit-2\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the child unit was created. |\n| `updatedAt` | `string` | Timestamp when the child unit was last updated. |\n| `name` | `string` | Name of the child organization unit. |\n| `path.ids` | `string` | Full ID path of the child unit. |\n| `id` | `string` | ID of the child organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/b13531bb-8242-43fd-80f5-3263dd4e9cdd/children", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "b13531bb-8242-43fd-80f5-3263dd4e9cdd", - "children" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:40:20 GMT" - }, - { - "key": "x-envoy-upstream-service-time", - "value": "31" - }, - { - "key": "x-envoy-decorator-operation", - "value": "units.units-stable.svc.cluster.local:80/*" - }, - { - "key": "Cache-Control", - "value": "public,max-age=60" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "units-v1.0.0" - }, - { - "key": "x-vtex-operation-id", - "value": "7614c399-6f03-413f-930d-470a4e7611ec" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 0adea8307e9600470efc145509ab5c2e.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "Qt24-cU6kAm7-lUwFvE8l7Pro8ree2ziJQKKC1lSDm2y-z-pX9v30g==" - } - ], - "cookie": [], - "body": "[\n {\n \"createdAt\": \"2025-03-19T21:44:33.468045Z\",\n \"updatedAt\": \"2025-03-19T21:44:49.331893Z\",\n \"name\": \"unit-1\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\"\n },\n \"id\": \"40f71ee2-9036-41e2-ac9b-f9ec7ca9df49\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n },\n {\n \"createdAt\": \"2025-03-19T21:28:13.103978Z\",\n \"updatedAt\": \"2025-03-19T21:28:17.595758Z\",\n \"name\": \"unit-2\",\n \"path\": {\n \"ids\": \"account/b13531bb-8242-43fd-80f5-3263dd4e9cdd/92264b68-74da-4fc4-b51a-9ddcb8baf29a\"\n },\n \"id\": \"92264b68-74da-4fc4-b51a-9ddcb8baf29a\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]" - } - ] - }, - { - "name": "Get Root Units", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/roots", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "roots" - ] - }, - "description": "Retrieves all root organization units within the specified account, meaning the first level in the organization unit tree.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/organization-units/v1/roots`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"createdAt\": \"2025-05-07T21:01:51.588949Z\",\n \"updatedAt\": \"2025-05-07T21:01:51.588949Z\",\n \"name\": \"{{unitName}}\",\n \"path\": {\n \"ids\": \"qastore/0aac12d6-6b22-4483-bd83-eb086c42888e\"\n },\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `createdAt` | `string` | Timestamp when the unit was created. |\n| `updatedAt` | `string` | Timestamp when the unit was last updated. |\n| `name` | `string` | Name of the root organization unit. |\n| `path.ids` | `string` | Full ID path of the unit. |\n| `id` | `string` | ID of the organization unit. |\n| `customerGroup.customerIds` | `array` | List of associated customer IDs (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/organization-units/v1/roots", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "organization-units", - "v1", - "roots" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "[\n {\n \"createdAt\": \"2025-05-07T21:01:51.588949Z\",\n \"updatedAt\": \"2025-05-07T21:01:51.588949Z\",\n \"name\": \"{{unitName}}\",\n \"path\": {\n \"ids\": \"qastore/0aac12d6-6b22-4483-bd83-eb086c42888e\"\n },\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"customerGroup\": {\n \"customerIds\": []\n }\n }\n]" - } - ] - }, - { - "name": "Add User to Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{ \"userIds\": [\"{{userId}}\"]}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users?force=false", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{unitId}}", - "users" - ], - "query": [ - { - "key": "force", - "value": "false" - } - ] - }, - "description": "Adds one or more users to a specific organization unit.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/vtexid/organization-units/{{unitId}}/users?force=false`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n- **Query parameter** `force`: Indicates whether user should be forcefully moved to the unit in the case they are already assigned to another unit. If the `force` query parameter is set to `true`, users already assigned to the unit will be returned in `addedUserIds`. If set to `false`, those users will appear in `failedUserIds` instead.\n \n\n#### Request Body\n\n``` json\n{\n \"userIds\": [\"{{userId}}\"]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `userIds` | `string[]` | Yes | List of user IDs to add to the organization unit. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"organizationUnitId\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"addedUserIds\": [\n \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\"\n ],\n \"failedUserIds\": []\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `organizationUnitId` | `string` | ID of the organization unit. |\n| `addedUserIds` | `string[]` | List of user IDs that were successfully added. |\n| `failedUserIds` | `string[]` | List of user IDs that failed to be added (can be empty). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{ \"userIds\": [\"{{userEmmaHarris}}\"]}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitNationaChamberId}}/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{unitNationaChamberId}}", - "users" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "157" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 18:50:03 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "vid-v4.181.2" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 6c3d5e1500c1992bef942fe7ee78a09c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "lCW9nAuCQbSDa5WXq55YlywaZUFc4YaukfstlLgf3glA8la6HfIh_Q==" - } - ], - "cookie": [], - "body": "{\n \"organizationUnitId\": \"b13531bb-8242-43fd-80f5-3263dd4e9cdd\",\n \"addedUserIds\": [\n \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\"\n ],\n \"failedUserIds\": []\n}" - } - ] - }, - { - "name": "Remove User from Unit", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{ \"userIds\": [\"{{userId}}\"]}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{unitId}}", - "users" - ] - }, - "description": "Removes users from a specific organization unit in the VTEX ID API.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/vtexid/organization-units/{{unitId}}/users`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request Body\n\n``` json\n{\n \"userIds\": [\"{{userId}}\"]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `userIds` | `string[]` | Yes | List of user IDs to remove from the unit. |\n\n---\n\n### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: Empty (indicates successful removal)" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{ \"userIds\": [\"{{userEmmaHarris}}\"]}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{unitId}}", - "users" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "157" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 18:50:03 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "vid-v4.181.2" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 6c3d5e1500c1992bef942fe7ee78a09c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "lCW9nAuCQbSDa5WXq55YlywaZUFc4YaukfstlLgf3glA8la6HfIh_Q==" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "List Users from Unit", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{unitId}}", - "users" - ] - }, - "description": "Retrieves or removes users from a specific organization unit in the VTEX ID API.\n\n> ⚠️ Deprecation Notice > The `api/units/v1` prefix is being deprecated in favor of the new `api/organization-units/v1` prefix. Both prefixes will be supported until June 30, 2025, after which the old prefix will be removed on July 1, 2025. Please update your integrations accordingly.\n\n---\n\n### Get Users from Organization Unit\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/vtexid/organization-units/{{unitId}}/users`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n#### Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n```\n{\n \"users\": [\n {\n \"userId\": \"860cf3ed-1c50-4054-b367-99c8f6138fcc\",\n \"login\": \"daniel.white@email.com\"\n },\n {\n \"userId\": \"37eba317-9154-4844-8ecd-afc5ffb0bf23\",\n \"login\": \"john.thomas@email.com\"\n },\n {\n \"userId\": \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\",\n \"login\": \"emma.harris@email.com\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `userId` | `string` | Unique identifier of the user. |\n| `login` | `string` | Email or login identifier of user. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/vtexid/organization-units/{{unitId}}/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{unitId}}", - "users" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "17" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 19:35:26 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "vid-v4.181.2" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 c19ece6c416a0e3e3d5938f317467888.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "p8rzoXkLoW66rBHuRfkBYJl0c6Mt0e1tBq7FuTrHtXRxawqvtT-SPA==" - } - ], - "cookie": [], - "body": "{\n \"users\": [\n {\n \"userId\": \"860cf3ed-1c50-4054-b367-99c8f6138fcc\",\n \"login\": \"daniel.white@email.com\"\n },\n {\n \"userId\": \"37eba317-9154-4844-8ecd-afc5ffb0bf23\",\n \"login\": \"john.thomas@email.com\"\n },\n {\n \"userId\": \"468cc9c0-e8bd-4826-b7a6-13dce147dc26\",\n \"login\": \"emma.harris@email.com\"\n }\n ]\n}" - } - ] - } - ], - "description": "Units are an organizational resource that enables hierarchical and exclusive grouping of users. The Top-level organizational unit is typically associated with a contract and serves as the highest entity.\n\nChild organizational units exist within this hierarchy, each with its own users and administrators. If a child organization admin user is assigned, they can manage their unit and any subordinate units below it.\n\nYou can apply scopes at the root level and narrow them down in child units.\n\n## Configure User and Contract Scope for Purchase Flow\n\nThis tutorial outlines the steps needed to create a user, assign the correct permissions, and complete a purchase flow using contract scopes in the new login flow.\n\n### Permissions\n\nA user or appKey must have the `Save user` resource. For testing, you may temporarily assign the Access `Manager - Full Access` role, but ideally, the user or appKey should only have the specific `Save user` permission.\n\n> Learn more about [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) and [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). \n \n\n### Step-by-Step Process\n\nThe relevant APIs are linked in each step of the process.\n\n#### Phase 1: Set Up User and Organization Structure\n\n1. Log in with a user that belongs to the organization and has the required permissions (`Save user`).\n \n2. [Create Unit/Child Unit](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/folder/24701542-eb7eb3f2-34ef-438d-96ae-f8de589958fa?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n3. Create a user. You can use the [Conversation Tracker API](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-a802379f-3db8-402b-8765-86cc9a6ecbbe?action=share&source=copy-link&creator=45103573&ctx=documentation) to do it dynamically.\n \n4. Generate a VTEX ID user and password in VTEX ID for the newly created user. To do this, use the [requests 1-3 in this folder](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/folder/24701542-9fab615c-ff39-4899-9025-2d1f2e143b9f?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n5. [Register the user in License Manager (LM) with the necessary organization associations](https://vtex-apis.postman.co/workspace/ODP~29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-5003f882-dd7d-47ec-9f2b-00ec80ca9203?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n\n#### Phase 2: Configure Contract and Complete Flow\n\n1. [Create a contract](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-b7f83de6-5caa-477a-bb6e-067cf63d90ee?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n2. [Link the desired scope to the contract](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-652181da-7ca8-4917-9037-2aab2e0969d9?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n3. [Associate the newly created user with the Unit](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/request/24701542-84625d81-7e16-4eb9-a3ae-4ecdaf062708?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n4. [Log in as the new user](https://vtex-apis.postman.co/workspace/29141c52-b503-4c3c-8e46-1f3fe49bdc5d/folder/24701542-8317a373-d626-46c3-acda-46eb2b0700fa?action=share&source=copy-link&creator=45103573&ctx=documentation).\n \n5. Complete the user's profile by filling in all required fields. This step is necessary for the checkout process.\n \n\nAfter completing these steps, you should be able to proceed with the purchase flow using the new user and contract scope." - }, - { - "name": "Shopper Data", - "item": [ - { - "name": "Get Shopper Schema", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/schemas/v1", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "dataentities", - "shopper", - "schemas", - "v1" - ] - }, - "description": "This endpoint retrieves a shopper entity [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) with shopper personal data.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/schemas/v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n---\n\n### Response body\n\n``` json\n[\n {\n \"name\": \"v1\",\n \"schema\": {\n \"title\": \"shopper\",\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"document\": {\n \"type\": \"string\"\n },\n \"documentType\": {\n \"type\": \"string\"\n },\n \"phone\": {\n \"type\": \"string\"\n },\n \"cards\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"cardId\": {\n \"type\": \"string\"\n },\n \"paymentSystem\": {\n \"type\": \"string\"\n },\n \"paymentSystemName\": {\n \"type\": \"string\"\n },\n \"cardNumber\": {\n \"type\": \"string\",\n \"pattern\": \"^[\\\\*]{12}[0-9]{4}$\"\n },\n \"bin\": {\n \"type\": \"string\"\n },\n \"expirationDate\": {\n \"type\": \"string\"\n },\n \"useCvvForAuthorization\": {\n \"type\": \"boolean\"\n },\n \"cardLabel\": {\n \"type\": \"string\"\n },\n \"isCardToken\": {\n \"type\": \"boolean\"\n },\n \"availableAddresses\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"additionalProperties\": false\n }\n }\n },\n \"additionalProperties\": false,\n \"required\": [\n \"userId\",\n \"firstName\",\n \"lastName\"\n ],\n \"v-indexed\": [\n \"userId\",\n \"unitId\",\n \"firstName\",\n \"lastName\",\n \"document\",\n \"phone\"\n ]\n }\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `name` | `string` | Schema name. |\n| `schema` | `string` | Object with schema properties. |\n| `schema.title` | `string` | Schema title. |\n| `schema.type` | `string` | Schema type. |\n| `schema.properties` | `string` | Object containing schema properties. |\n| `schema.properties.type` | `string` | Type of property. Allowed types: `array`, `boolean`, `integer`, `number`, `object` and `string`. |\n| `schema.properties.userId` | `string` | Unique shopper identifier. |\n| `schema.properties.email` | `string` | Shopper’s email. |\n| `schema.properties.firstName` | `string` | Shopper’s first name. |\n| `schema.properties.lastName` | `string` | Shoppers last name. |\n| `schema.properties.document` | `string` | Shopper’s document number (e.g., CPF). |\n| `schema.properties.documentType` | `string` | Type of document (e.g., `cpf`). |\n| `schema.properties.phone` | `string` | Shopper’s phone number. |\n| `schema.properties.unitId` | `string` | Unique ID of the Organization Unit. |\n| `schema.properties.cards` | `array` | Array of saved credit cards. |\n| `schema.properties.cards.cardId` | `string` | Unique identifier of the card. |\n| `schema.properties.cards.paymentSystem` | `string` | Payment system code (e.g., `2` for Visa). |\n| `schema.properties.cards.paymentSystemName` | `string` | Name of the payment system (e.g., `Visa`). |\n| `schema.properties.cards.cardNumber` | `string` | Masked card number. |\n| `schema.properties.cards.bin` | `string` | Bank Identification Number – the first digits of the card. |\n| `schema.properties.cards.expirationDate` | `string` | Card expiration date in `MM/YYYY` format. |\n| `schema.properties.cards.useCvvForAuthorization` | `boolean` | Whether CVV is required for authorization. |\n| `schema.properties.cards.cardLabel` | `string` | Label or nickname for the card. |\n| `schema.properties.cards.isCardToken` | `boolean` | Indicates if the card is tokenized. |\n| `schema.properties.cards.availableAddresses` | `array` | List of address IDs available for this card. |\n| `schema.properties.additionalProperties` | `boolean` | Additional properties. |\n| `schema.additionalProperties` | `boolean` | Schema additional properties. |\n| `schema.required` | `array` | Required properties fields. |\n| `schema.v-indexed` | `array` | Indexed properties fields. |" - }, - "response": [] - }, - { - "name": "Create Shopper Document", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n\t\"userId\": \"8a9c86b3-3325-4770-bce0-fb6dda4dd942\",\n \"email\": \"fernando.barros+buyer3@vtex.com\",\n\t\"firstName\": \"Fernando\",\n\t\"lastName\": \"Barros\",\n\t\"document\": \"259.559.448-69\",\n\t\"documentType\": \"cpf\",\n\t\"cards\": [],\n \"phone\": \"11917118990\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1", - "protocol": "http", - "host": [ - "{{account}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "dataentities", - "shopper", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - } - ] - }, - "description": "This endpoint creates a shopper entity document.\n\n---\n\n## Request\n\n- **Method**: `POST`\n \n- **URL**: `http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n---\n\n### Request body\n\n``` json\n{\n \"userId\": \"8abea412-4702-46fb-b835-3edb29d8a261\",\n \"email\": \"john@vtex.com\"\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"514.427.690-33\",\n \"documentType\": \"cpf\",\n \"cards\": [],\n \"phone\": \"11917118990\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `userId` | `string` | Yes | Unique identifier for the shopper. |\n| `email` | `string` | No | Shopper's email. |\n| `firstName` | `string` | Yes | Shopper's first name. |\n| `lastName` | `string` | Yes | Shopper's last name. |\n| `document` | `string` | Yes | Shopper's document number (e.g., CPF number). |\n| `documentType` | `string` | Yes | Type of the document provided (e.g., `cpf`). |\n| `cards` | `array` | No | List of cards associated with the user. It must be an empty array. This field will be populated by another API. |\n| `phone` | `string` | No | Shopper’s phone number. |\n| `unitId` | `string` | No | Unique ID of the Organization Unit. |\n\n---\n\n### Response body\n\n``` json\n{\n \"Id\": \"shopper-a26301e6-1a1e-11f0-b37f-e46d3d0578c6\",\n \"Href\": \"\",\n \"DocumentId\": \"a26301e6-1a1e-11f0-b37f-e46d3d0578c6\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the document, often prefixed with the entity name. |\n| `Href` | `string` | URL to access the document. May be empty if not applicable. |\n| `DocumentId` | `string` | Same as `Id`, used internally to identify the document. |" - }, - "response": [] - }, - { - "name": "Get Shopper Document by User ID", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "url": { - "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/documents/{{userId}}", - "protocol": "http", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "dataentities", - "shopper", - "documents", - "{{userId}}" - ] - }, - "description": "This endpoint retrieves a shopper entity document by User ID.\n\n---\n\n## Request\n\n- **Method**: `GET`\n \n- **URL**: `http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/documents/{{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `userId` | `string` | Yes | Unique identifier for the shopper. |\n\n---\n\n### Response\n\n``` json\n{\n \"userId\": \"8abea412-4702-46fb-b835-3edb29d8a261\",\n \"email\": \"john@vtex.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"514.427.690-33\",\n \"documentType\": \"cpf\",\n \"phone\": \"11917118990\"\n \"cards\": [\n{\n \"cardId\": \"D05881AD4F424A6C93D8536C9F7F992E\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************3232\",\n \"bin\": \"22343333\",\n \"availableAddresses\": [\n \"12345\"\n ],\n \"expirationDate\": \"02/2029\",\n \"useCvvForAuthorization\": true,\n \"isCardToken\": false\n }\n ]\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `userId` | `string` | Unique identifier for the shopper. |\n| `email` | `string` | Shopper's email. |\n| `firstName` | `string` | Shopper's first name. |\n| `lastName` | `string` | Shopper's last name. |\n| `document` | `string` | Shopper's document number (e.g., CPF number). |\n| `documentType` | `string` | Type of the document provided (e.g., `cpf`). |\n| `phone` | `string` | Shopper’s phone number. |\n| `unitId` | `string` | Unique ID of the Organization Unit. |\n| `cards` | `array` | List of cards associated with the shopper. |\n| `cards.cardId` | `string` | Unique identifier of the saved card. |\n| `cards.paymentSystem` | `string` | Code representing the payment system (e.g., `2` for Visa). |\n| `cards.paymentSystemName` | `string` | Name of the payment system (e.g., `Visa`). |\n| `cards.cardNumber` | `string` | Masked credit card number. |\n| `cards.bin` | `string` | Bank Identification Number – the first digits of the card. |\n| `cards.availableAddresses` | `array` | Array of address IDs the card is associated with. |\n| `cards.expirationDate` | `string` | Expiry date of the card in `MM/YYYY` format. |\n| `cards.useCvvForAuthorization` | `boolean` | Indicates if CVV is required for authorization. |\n| `cards.isCardToken` | `boolean` | Indicates whether the card data is tokenized. |" - }, - "response": [] - }, - { - "name": "Search Shopper Document", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "url": { - "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/AD/search?_schema=v1&_where=userId={{userId}}&_fields=id,addressName,addressLabel,postalCode,geoCoordinate", - "protocol": "http", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "dataentities", - "AD", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_where", - "value": "userId={{userId}}" - }, - { - "key": "_fields", - "value": "id,addressName,addressLabel,postalCode,geoCoordinate" - } - ] - }, - "description": "This endpoint search a shopper entity document by User ID.\n\n---\n\n## Request\n\n- **Method**: `GET`\n \n- **URL**: `http://{{account}}.vtexcommercestable.com.br/api/dataentities/shopper/search?_schema=v1&_where=userId={{userId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Query\n\n| Query | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `_where` | `string` | No | Unique identifier for the shopper. Use the `userId={{userId}}` value. |\n| `_schema` | `string` | No | Schema name. The value must be `v1`. |\n\n---\n\n### Response\n\n``` json\n[\n {\n \"userId\": \"8abea412-4702-46fb-b835-3edb29d8a261\",\n \"email\": \"john@vtex.com\",\n \"fistName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"514.427.690-33\",\n \"documentType\": \"cpf\",,\n \"phone\": \"11917118990\"\n \"cards\": [\n{\n \"cardId\": \"D05881AD4F424A6C93D8536C9F7F992E\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************3232\",\n \"bin\": \"22343333\",\n \"availableAddresses\": [\n \"12345\"\n ],\n \"expirationDate\": \"02/2029\",\n \"useCvvForAuthorization\": true,\n \"isCardToken\": false\n }\n]\n}\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `userId` | `string` | Unique identifier for the shopper. |\n| `email` | `string` | Shopper's email. |\n| `firstName` | `string` | Shopper's first name. |\n| `lastName` | `string` | Shopper's last name. |\n| `document` | `string` | Shopper's document number (e.g., CPF number). |\n| `documentType` | `string` | Type of the document provided (e.g., `cpf`). |\n| `phone` | `string` | Shopper’s phone number. |\n| `unitId` | `string` | Unique identifier for the unit. |\n| `cards` | `array` | List of cards associated with the shopper. |\n| `cards.cardId` | `string` | Unique identifier of the saved card. |\n| `cards.paymentSystem` | `string` | Code representing the payment system (e.g., `2` for Visa). |\n| `cards.paymentSystemName` | `string` | Name of the payment system (e.g., `Visa`). |\n| `cards.cardNumber` | `string` | Masked credit card number. |\n| `cards.bin` | `string` | Bank Identification Number – the first digits of the card. |\n| `cards.availableAddresses` | `array` | Array of address IDs the card is associated with. |\n| `cards.expirationDate` | `string` | Expiry date of the card in `MM/YYYY` format. |\n| `cards.useCvvForAuthorization` | `boolean` | Indicates if CVV is required for authorization. |\n| `cards.isCardToken` | `boolean` | Indicates whether the card data is tokenized. |" - }, - "response": [] - } - ], - "description": "These endpoints will create, update, and retrieve shopper personal information stored in a Master Data entity. These endpoints are complementary to the Units endpoints." - } - ] - }, - { - "name": "Storefront Permissions", - "item": [ - { - "name": "Granted Auth Cookie and Token", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{value:X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{value:X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "users", - "{{userId}}", - "resources", - "{{resourceKey}}", - "granted" - ] - }, - "description": "## Check User Permission on Resource\n\nThis endpoint checks whether a specific user has been granted access to a particular resource in the VTEX License Manager.\n\n> Learn more about permissions in VTEX with [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#). \n \n\n### **Authentication**\n\nThis endpoint accepts `VtexIdclientAutCookie` or `X-VTEX-API-AppKey/X-VTEX-API-AppToken` in the headers.\n\n### Request\n\n**Method:** `GET` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted\n\n ```\n\n**Path Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The ID of the user. |\n| `resourceKey` | string | The key representing the resource. |\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n| `X-VTEX-API-AppKey` | `{{value:X-VTEX-API-AppKey}}` |\n| `X-VTEX-API-AppToken` | `{{value:X-VTEX-API-AppToken}}` |\n\n**Request Body:**\n\nNo request body is required.\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\nReturns `true` if the user has access to the resource, otherwise `false`.\n\n``` json\ntrue\n\n ```" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "users", - "{{userId}}", - "resources", - "{{resourceKey}}", - "granted" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "true" - } - ] - }, - { - "name": "Granted Auth Cookie Only", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie_{tenantName}", - "value": "{{webstore-token}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/bff/users/{{userId}}/resources/{{resourceKey}}/granted/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "bff", - "users", - "{{userId}}", - "resources", - "{{resourceKey}}", - "granted", - "" - ] - }, - "description": "## Check User Permission on Resource\n\nThis endpoint checks whether a specific user has been granted access to a particular resource in the VTEX License Manager.\n\n> Learn more about permissions in VTEX with [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#). \n \n\n### **Authentication**\n\nThis endpoint requires the `VtexIdclientAutCookie_{{tenantName}}={{webstore-token}}` in the headers.\n\n### Request\n\n**Method:** `GET` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted\n\n ```\n\n**Path Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The ID of the user. |\n| `resourceKey` | string | The key representing the resource. |\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie_{{tenantName}}` | `{{webstore-token}}` |\n\n**Request Body:**\n\nNo request body is required.\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\nReturns `true` if the user has access to the resource, otherwise `false`.\n\n``` json\ntrue\n\n ```\n\n> Tenants that call this endpoint without the storefront permissions feature flag enabled will receive a `200 OK` response with `true` in the response body, any combination of `userId` and `resourceKeyId` provided will be considered valid." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/users/{{userId}}/resources/{{resourceKey}}/granted", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "users", - "{{userId}}", - "resources", - "{{resourceKey}}", - "granted" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "true" - } - ] - }, - { - "name": "Assign", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/roles/assign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "roles", - "assign" - ] - }, - "description": "## Assign Role to User\n\nThis endpoint assigns a role to a specific user in the VTEX License Manager. This request can be called by [VTEX IO apps](https://developers.vtex.com/docs/vtex-io-apps) to perform role assignments.\n\n> Roles are groupings of [resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#) that can be assigned to users. Learn more abour [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). \n \n\n### Request\n\n**Method:** `POST` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/roles/assign\n\n ```\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n| `Content-Type` | `application/json` |\n\n**Body Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The user's ID. |\n| `roleId` | integer | The role's ID. |\n\n**Example Body:**\n\n``` json\n{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}\n\n ```\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\n``` json\ntrue\n\n ```\n\nIndicates that the role was successfully assigned to the user." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/roles/assign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "roles", - "assign" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "true" - } - ] - }, - { - "name": "Revoke", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/roles/revoke", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "roles", - "revoke" - ] - }, - "description": "## Revoke Role from User\n\nThis endpoint revokes a role from a specific user in the VTEX License Manager.\n\n> Roles are groupings of [resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?&utm_source=autocomplete#) that can be assigned to users. Learn more abour [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). \n \n\n### Request\n\n**Method:** `DELETE` \n**URL:**\n\n```\nhttps://{{accountName}}.myvtex.com/api/license-manager/storefront/roles/revoke\n\n ```\n\n**Headers:**\n\n| Header | Value |\n| --- | --- |\n| `VtexIdclientAutCookie` | `{{vault:VtexIdclientAutCookie}}` |\n| `Content-Type` | `application/json` |\n\n**Body Parameters:**\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `userId` | string | The user's ID. |\n| `roleId` | integer | The role's ID. |\n\n**Example Body:**\n\n``` json\n{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}\n\n ```\n\n---\n\n### Response\n\n**Status Code:** `200 OK` \n**Content-Type:** `text/plain`\n\n**Response Body:**\n\n``` json\ntrue\n\n ```\n\nIndicates that the role was successfully revoked from the user." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userId\": \"{{userId}}\",\n \"roleId\": {{roleId}}\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/license-manager/storefront/roles/revoke", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "license-manager", - "storefront", - "roles", - "revoke" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "true" - } - ] - } - ], - "description": "Handles the storefront permissions attributed to users.\n\n## Roles and Permissions\n\nBelow you can learn more abour the different **user roles** available in the procurement and organizational management system, along with their corresponding **permissions**. Each role has specific capabilities tailored to common business functions like purchasing, order approval, and account management. Use this table to understand which role fits your needs and what each user type is allowed to do.\n\n> Each role is associated with a unique **Role ID**, which is used in the API to programmatically assign and manage user roles within the system. \n \n\n| **Permission** | **Organizational Unit Admin** | **Order Approver** | **Order Modifier** | **Buyer** | **Personal Cards User** | **Contract Manager** | **Buyer Organization Manager** | **Contract Viewer** | **Address Manager** |\n| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |\n| _RoleID_ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 |\n| Manage Organization & Contract | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Place Orders | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| View My Contract Orders | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ |\n| View My Org Unit Orders | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ |\n| Modify Orders | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Approve Orders | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Manage Addresses | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |\n| Use ad hoc credit card | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |\n| Manage Authentication | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |\n| View My Cards | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |\n| View Addresses | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |\n| View Budget | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Manage Budget | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| View Buying Policies | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n| Manage Buying Policies | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |\n\n### Role descriptions\n\n- **Organizational Unit Admin:** Manages the structure, budget, and policies of an organizational unit.\n \n- **Order Approver:** Reviews and aproves orders placed by others.\n \n- **Order Modifier:** Has permission to adjust orders before final approval or placement.\n \n- **Buyer:** Can place new orders but cannot approve or modify them.\n \n- **Personal Cards User:** Proposed role for users allowed to make purchases using personal or ad hoc credit cards.\n \n- **Contract Manager:** Views and tracks all orders made under a specific contract.\n \n- **Buyer Organization Manager:** Oversees order activity across the entire organization unit.\n \n- **Contract Viewer:** Views authentication, card, and address information.\n \n- **Address Manager:** Manages shipping and billing address records used during order placement.\n \n\n### API Access Requirements\n\nTo use the Storefront Permissions APIs described below, any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). Otherwise they will receive a status code \\`403\\` error. These are the applicable resources for this endpoint:\n\n| Product | Category | Resource |\n| --- | --- | --- |\n| License Manager | Services access control | View Storefront User Permissions |\n| License Manager | Services access control | Edit Storefront User Permissions |\n\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 the resources above in order to use this endpoint.\n\n> To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). \n \n> To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." - }, - { - "name": "Budgets", - "item": [ - { - "name": "Budgets", - "item": [ - { - "name": "Create Budget", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - }, - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "noauth" - }, - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"{{$randomCompanyName}}\",\n \"description\": \"{{$randomCurrencyName}}\",\n \"amount\": {{$randomInt}},\n \"cycleConfiguration\": {\n \"startDate\": \"{{startDate}}\",\n \"endDate\": \"{{endDate}}\",\n \"autoResetOnPeriodEnd\": {{boolean}},\n \"carryOverBalance\": {{boolean}}\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"{{$randomUUID}}\",\n \"type\": \"{{linkedEntityType}}\"\n },\n \"amount\": {{$randomInt}},\n \"referenceId\": \"{{referenceId}}\",\n \"notificationSettings\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 90,\n \"recipients\": [\n {\n \"email\": \"user2@email.com\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}" - ] - }, - "description": "This endpoint creates a new budget with optional allocations and cycle configuration.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"name\": \"Parker and Sons\",\n \"description\": \"Bermudian Dollar (customarily known as Bermuda Dollar)\",\n \"amount\": 956,\n \"cycleConfiguration\": {\n \"startDate\": \"2025-04-01T00:00:00.0000000Z\",\n \"endDate\": \"2025-04-08T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"4de8235f-ff2d-451b-bfcf-9873aeb9feee\",\n \"type\": \"{{linkedEntityType}}\"\n },\n \"amount\": 639,\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the budget. |\n| `description` | `string` | Yes | Description of the budget. |\n| `amount` | `number` | Yes | Total amount allocated to the budget. |\n| `cycleConfiguration` | `object` | No | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Yes | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | Yes | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Yes | Enable (`true`) or disable (`false`) the autoreset period. |\n| └─ `carryOverBalance` | `boolean` | Yes | Defines wether to carry over balance (`true`) or not (`false`). |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n| `allocations` | `array of objects` | No | Optional list of initial allocations to create with the budget. |\n| └─ `linkedEntity` | `object` | Yes | Information about the entity to which the allocation is linked. |\n| └── `id` | `string` | Yes | Identifier of the entity. If `type` is `User` or `Address`, this should be the ID of the user or address, respectively. If `type` is a custom field (e.g., `PO Number`, `Cost Center`, etc), this should be the **value** of that custom field. |\n| └── `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `amount` | `number` | Yes | Amount allocated. |\n| └─ `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"totalUtilized\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created budget. |\n| `name` | `string` | Name of the budget. |\n| `description` | `string` | Description of the budget. |\n| `balance` | `object` | Budget balance information. |\n| └─ `amount` | `number` | Total amount in the budget. |\n| └─ `totalUtilized` | `number` | Amount already utilized. |\n| └─ `remaining` | `number` | Remaining budget. |\n| `cycleConfiguration` | `object` | Configuration for budget cycle. |\n| └─`startDate` | `string` | Start date of the budget cycle (ISO format). |\n| └─`endDate` | `string` | End date of the budget cycle (ISO format). |\n| └─`autoResetOnPeriodEnd` | `boolean` | Condition if the period will auto reset when ended. |\n| └─`carryOverBalance` | `boolean` | Condition if the remain balance will be transferred to the next cycle. |\n| └─`nextRenewal` | `string` | Next cycle renewal date. |\n| `status` | `string` | Current status of the budget (e.g., `ACTIVE`, `INACTIVE`). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `allocations` | `array of objects` | Optional list of initial allocations to create with the budget. |\n| `id` | `string` | Unique identifier of the allocation. |\n| `budgetId` | `string` | ID of the associated budget. |\n| `linkedEntity` | `object` | Information about the entity to which the allocation is linked. |\n| └── `id` | `string` | Identifier of the entity. If type is `User` or `Address`, this should be the ID of the user or address, respectively. If type is a custom field (e.g., `PO Number`, `Cost Center`, etc), this should be the value of that custom field. |\n| └── `type` | `string` | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `balance` | `object` | Financial details of the allocation. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └── `remaining` | `number` | Remaining balance. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of the context (e.g., `UNIT`, `COSTCENTER`). |\n| `contextId` | `string` | Identifier for the specific context. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Zieme - Bernier\",\n \"description\": \"Czech Koruna\",\n \"amount\": 557,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"contextType\": \"{{context_type}}\",\n \"contextId\": \"{{context_id}}\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"15846e02-2a70-4045-91c3-5ca0d8ada1d5\",\n \"type\": \"PONumber\"\n },\n \"amount\": 451,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - }, - { - "key": "Content-Length", - "value": "404" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 14:58:16 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-5d7dc706948faf117de062d72b9c171b-d9ab20f8fe016e27-01" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 4a23445212082dc63ad3e6d8ddfcfff8.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "geaNK2sqJRKdHxeMTcr1bLJCH9rNkpPCHhvLUgZbjDS9KDiWoddLHg==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"totalUtilized\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Budget", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Jones - Lebsack\",\n \"description\": \"Pataca\",\n \"amount\": 783,\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2055-01-01\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint updates an existing budget.\n\n> Note that you can't update the fields `contextType` and `contextId`. You must send the original values, as they are used to validate the request. \n \n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be updated. |\n\n#### Request Body\n\n``` json\n{\n \"name\": \"Graham, O'Reilly and Predovic\",\n \"description\": \"Syrian Pound\",\n \"amount\": 355,\n \"cycleConfiguration\": {\n \"startDate\": \"2025-03-27T00:00:00.0000000Z\",\n \"endDate\": \"2025-04-18T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the budget. |\n| `description` | `string` | Yes | Description of the budget. |\n| `amount` | `number` | Yes | Updated budget amount. |\n| `cycleConfiguration` | `object` | No | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Yes | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | Yes | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Yes | Condition if the period will auto reset when ended. |\n| └─ `carryOverBalance` | `boolean` | Yes | Condition if the remain balance will be transferred to the next cycle. |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"Walker - Waelchi\",\n \"description\": \"Codes specifically reserved for testing purposes\",\n \"balance\": {\n \"amount\": 381,\n \"balanceAdjustment\": 0,\n \"remaining\": 381\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the updated budget. |\n| `name` | `string` | Name of the budget. |\n| `description` | `string` | Description of the budget. |\n| `balance` | `object` | Bugdet balance information. |\n| └─ `amount` | `number` | Total amount in the budget. |\n| └─ `balanceAdjustment` | `number` | Amount already utilized. |\n| └─ `remaining` | `number` | Remaining budget. |\n| `cycleConfiguration` | `object` | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Condition if the period will auto reset when ended. |\n| └─ `carryOverBalance` | `boolean` | Condition if the remain balance will be transferred to the next cycle. |\n| `status` | `string` | Current status of the budget (e.g., `ACTIVE`, `INACTIVE`). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `allocations` | `array of objects` | Optional list of initial allocations to create with the budget. |\n| └─ `id` | `string` | Unique identifier of the allocation. |\n| └─ `budgetId` | `string` | ID of the associated budget. |\n| └─ `linkedEntity` | `object` | Information about the entity to which the allocation is linked. |\n| └── `id` | `string` | Identifier of the entity. If type is `User` or `Address`, this should be the ID of the user or address, respectively. If type is a custom field (e.g., `PO Number`, `Cost Center`, etc), this should be the value of that custom field. |\n| └── `type` | `string` | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `balance` | `object` | Financial details of the allocation. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └── `remaining` | `number` | Remaining balance. |\n| └─ `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| └─ `status` | `string` | Current status of the allocation (e.g., `ACTIVE`). |\n| └─ `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| └─ `contextType` | `string` | Type of the context (e.g., `UNIT`, `COSTCENTER`). |\n| └─ `contextId` | `string` | Identifier for the specific context. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Tromp - Kassulke\",\n \"description\": \"Yen\",\n \"amount\": 490,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"unit\": \"{{unit}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.budget+json" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 14:59:54 GMT" - }, - { - "key": "trace-id", - "value": "00-493d5d793f8c22c08da4baf8396120b5-6f3dc09a51bb94f2-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8925b71bb3654008054231e03eaa658c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "8LjHQy7gWI0W8hzmXNzl7OBNpX8XzAL7qJCNnl00S_PZjVsTwv702g==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"Walker - Waelchi\",\n \"description\": \"Codes specifically reserved for testing purposes\",\n \"balance\": {\n \"amount\": 381,\n \"balanceAdjustment\": 0,\n \"remaining\": 381\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": false,\n \"carryOverBalance\": true\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": []\n}\n" - } - ] - }, - { - "name": "Update Budget Status", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}accept:*/*", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"INACTIVE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "status" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint updates the status of a specific budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/status`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be updated. |\n\n#### Request Body\n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `status` | `string` | Yes | New status value for the budget (e.g., `ACTIVE` or `INACTIVE`). |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `status` | `string` | The updated budget status (e.g., `ACTIVE` or `INACTIVE`). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"ACTIVE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/status", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "status" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.update-budget-activation+json" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 15:01:12 GMT" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-e5d00c476c44c49289159a1ec5ce022b-8762e42545b8ad33-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8925b71bb3654008054231e03eaa658c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "oo1TsBeC0Np82ARzIp_1dX8pAgNjAJTxTKTslFmLWNkZNIhcNfML2w==" - } - ], - "cookie": [], - "body": "{\n \"status\": \"ACTIVE\"\n}" - } - ] - }, - { - "name": "Get Budget", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint retrieves the details of a specific budget.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be retrieved. |\n\n> ℹ️ This endpoint does not require a request body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Budget ID. |\n| `name` | `string` | Name of the budget. |\n| `description` | `string` | Description of the budget. |\n| `balance` | `object` | Balance information. |\n| └─ `amount` | `number` | Budget amount. |\n| └─ `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └─ `remaining` | `number` | Remaining balance. |\n| `cycleConfiguration` | `object` | Configuration for budget cycle. |\n| └─ `startDate` | `string` | Start date of the budget cycle (ISO format). |\n| └─ `endDate` | `string` | End date of the budget cycle (ISO format). |\n| └─ `autoResetOnPeriodEnd` | `boolean` | Condition if the period will auto reset when ended. |\n| └─ `carryOverBalance` | `boolean` | Condition if the remain balance will be transferred to the next cycle. |\n| └─ `nextRenewal` | `boolean` | Condition if the next cycle will be renewal. |\n| `status` | `string` | Current status of the budget (e.g., `ACTIVE`). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `allocations` | `array of objects` | Optional list of initial allocations to create with the budget. |\n| └─ `id` | `string` | Unique identifier of the allocation. |\n| └─ `budgetId` | `string` | ID of the associated budget. |\n| └─ `linkedEntity` | `object` | Entity to which the allocation is linked. |\n| └── `id` | `string` | ID of the linked entity (e.g., user or unit). |\n| └── `type` | `string` | Type of the entity (e.g., `USER`, `UNIT`). |\n| └─ `balance` | `object` | Financial details of the allocation. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Amount already used from the allocation. |\n| └── `remaining` | `number` | Remaining balance. |\n| └─ `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE`). |\n| `referenceId` | `string` | ID of the related contract. |\n| `contextType` | `string` | Type of the context (e.g., `UNIT`, `COSTCENTER`). |\n| `contextId` | `string` | Identifier for the specific context. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.budget+json" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:34:57 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.004" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.008" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-4d1d81c147ba52eacabcdf134c359936-6b7dfd491b14189d-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-53-209" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.010" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 fc69aa762ce53e7ffff1543dcab64112.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG52-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "rPVRa0Js1FdKT7eDAE3wSpGk96e0L7HfjiM0bdhCa4rte_ZlX15wMA==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"name\": \"USER 1\",\n \"description\": \"USER 1\",\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"cycleConfiguration\": {\n \"startDate\": \"2025-01-01T00:00:00.0000000Z\",\n \"endDate\": \"2055-01-01T00:00:00.0000000Z\",\n \"autoResetOnPeriodEnd\": true,\n \"carryOverBalance\": true,\n \"nextRenewal\": \"2055-01-01T00:00:00.0000000Z\"\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\",\n \"allocations\": [\n {\n \"id\": \"0197c1e3-a82f-7747-8534-2aed2ba95417\",\n \"budgetId\": \"0197c1e3-a82f-7746-8614-bf518e625a92\",\n \"linkedEntity\": {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"USER\"\n },\n \"balance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n" - } - ] - }, - { - "name": "List Budgets", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}?page=1&pageSize=20&minAmount=0&maxAmount=500&status=ACTIVE&name=Marketing Budget 2024", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "minAmount", - "value": "0" - }, - { - "key": "maxAmount", - "value": "500" - }, - { - "key": "status", - "value": "ACTIVE" - }, - { - "key": "name", - "value": "Marketing Budget 2024" - } - ] - }, - "description": "Retrieves a paginated list of budgets filtered by context and amount range.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | Yes | Page number to retrieve. |\n| `pageSize` | `integer` | Yes | Number of results per page. |\n| `minAmount` | `float` | No | Minimum budget amount for filtering. |\n| `maxAmount` | `float` | No | Maximum budget amount for filtering. |\n| `status` | `string` | No | Filter by status (e.g., `ACTIVE`, `INACTIVE`). |\n| `name` | `string` | No | Budget name. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 2\n },\n \"items\": [\n {\n \"id\": \"ffc4575e-5e5c-420e-bcb7-bf4a271f5d60\",\n \"name\": \"Graham, O'Reilly and Predovic\",\n \"startDate\": \"2025-03-27T00:00:00.0000000Z\",\n \"endDate\": \"2025-04-18T00:00:00.0000000Z\",\n \"balance\": {\n \"amount\": 657,\n \"balanceAdjustment\": 0,\n \"remaining\": 657\n },\n \"status\": \"ACTIVE\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"unit123\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination information. |\n| └─ `current` | `integer` | Current page number. |\n| └─ `pages` | `integer` | Total number of pages. |\n| └─ `results` | `integer` | Total number of results. |\n| `items` | `array of objects` | Array of budget summaries. |\n| └─`id` | `string` | Identifier of the budget. |\n| └─`name` | `string` | Name of the budget. |\n| └─`startDate` | `string` | Start date of the budget. |\n| └─`endDate` | `string` | End date of the budget. |\n| └─`balance` | `object` | Bugdet balance information. |\n| └──`amount` | `number` | Total budget amount. |\n| └──`balanceAdjustment` | `number` | Amount already used. |\n| └──`remaining` | `number` | Remaining budget. |\n| └─ `status` | `string` | Current status of the allocation (`ACTIVE` or `INACTIVE`). |\n| └─ `contextType` | `string` | Context type. |\n| └─ `contextId` | `string` | Identification of the context type. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets?page=1&pageSize=20&contextType={{context_type}}&minAmount=0&maxAmount=500&status=ACTIVE&contextId={{context_id}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "contextType", - "value": "{{context_type}}" - }, - { - "key": "minAmount", - "value": "0" - }, - { - "key": "maxAmount", - "value": "500" - }, - { - "key": "status", - "value": "ACTIVE" - }, - { - "key": "contextId", - "value": "{{context_id}}" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.list-budgets+json" - }, - { - "key": "Content-Length", - "value": "506" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:35:49 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.104" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-7baa2ccd2bb222add075f6bee525ac35-50c4c614b4ef0645-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-21-30" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.107" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 fc69aa762ce53e7ffff1543dcab64112.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG52-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "pdyB7xtrrcX6gdTVNTn81DIsMgvoH28Imdo-rvVFvgPiwM7rJPzM_A==" - } - ], - "cookie": [], - "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 2\n },\n \"items\": [\n {\n \"id\": \"ffc4575e-5e5c-420e-bcb7-bf4a271f5d60\",\n \"name\": \"Graham, O'Reilly and Predovic\",\n \"startDate\": \"03/27/2025 00:00:00\",\n \"endDate\": \"04/18/2025 00:00:00\",\n \"balance\": {\n \"amount\": 657,\n \"balanceAdjustment\": 0,\n \"remaining\": 657\n },\n \"notifyThresholds\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 75\n }\n ],\n \"status\": \"INACTIVE\"\n },\n {\n \"id\": \"a523928a-2124-40a1-b9a1-675c8f15fe04\",\n \"name\": \"Thompson and Sons\",\n \"startDate\": \"04/01/2025 00:00:00\",\n \"endDate\": \"04/08/2025 00:00:00\",\n \"balance\": {\n \"amount\": 642,\n \"balanceAdjustment\": 0,\n \"remaining\": 642\n },\n \"notifyThresholds\": [\n {\n \"type\": \"AMOUNT\",\n \"threshold\": 215.80\n }\n ],\n \"status\": \"ACTIVE\"\n }\n ]\n}" - } - ] - }, - { - "name": "Reset Budget", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"origin\": \"Conversion\",\r\n \"reference\": \"6787190b-1a55-46cb-b95e-f677f1fdfbc7\",\r\n \"amount\": 505,\r\n \"type\": \"Debit\",\r\n \"requestedBy\": \"user1@email.com\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationID}}/usage", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationID}}", - "usage" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint resets the budget to a specified value.\n\nYou can define the usage amount whenever needed. For example, suppose you set a budget and record an initial debit of USD 500. After 10 days, the new usage is USD 900. In this case, you don’t need to review all the individual transactions — you can simply update the usage amount directly to USD 900.\n\n> Note that you can't update the fields contextType and contextId. You must send the original values, as they are used to validate the request. \n \n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/usage`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the overall budget being updated. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"Conversion\",\n \"reference\": \"6787190b-1a55-46cb-b95e-f677f1fdfbc7\",\n \"amount\": 505,\n \"type\": \"Debit\",\n \"requestedBy\": \"user1@email.com\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | Describes the origin or reason for the adjustment. |\n| `reference` | `string` | Yes | A reference ID tied to the transaction (e.g., order ID). |\n| `amount` | `number` | Yes | The amount of budget used for this allocation. When set to `0`, your budget will correspond to USD 0. |\n| `type` | `string` | Yes | Operation type, which can be `Credit` or `Debit`. |\n| `requestedBy` | `string` | Yes | Indicates who triggered the request — it can be a username, system name, or business process name. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: There is no response body." - }, - "response": [] - }, - { - "name": "Delete Budget", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint deletes a specific budget.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to be retrieved. |\n\n> ℹ️ This endpoint does not require a request body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body:** There is no response body." - }, - "response": [] - } - ], - "description": "With these endpoints you can create and manage budgets, which represent the main financial container.\n\n### Budget and Allocation\n\nEach Budget can have one or more **Allocations**, which are subdivisions of the total balance within that budget.\n\nEach **Budget** and **Allocation** has its own **amount**, **start date**, and **end date**. When funds are added to or removed from an Allocation, the corresponding Budget’s total amount is updated accordingly to reflect the change.\n\n### Transactions and Reservations\n\nTo move funds from an Allocation, there are two options:\n\n- **Direct Transaction** \n Used when you want to actually consume the balance. This creates a definitive entry that appears in the **Statements** (transaction history).\n \n- **Reservation** \n Used to temporarily reserve funds without consuming them immediately. Later, you can either:\n \n - **Confirm the reservation**, which automatically creates a transaction.\n \n - **Delete the reservation**, which simply releases the reserved balance without generating any transaction (it does not appear in the Statements).\n \n\n### Refunds\n\nTransactions cannot be deleted. If you need to undo a transaction, you must create a **Refund**, which is a new transaction with the type. Both the original transaction and the refund will appear in the Statements, with a net effect of zero.\n\n### Transaction types\n\nWhen you get a budget or allocation statement, each transaction contains a `type` field, which can carry two values:\n\n- `DEBIT`: Regular transactions, subtracting funds from the budget or allocation.\n \n- `CREDIT`: Associated with refunds, meaning it adds funds to the budget or allocation.\n \n\n### Typical API Call Order\n\n1. Create the **Budget**\n \n2. Create one or more **Allocations**\n \n3. Perform a **Transaction** or a **Reservation**\n \n4. Retrieve the transaction history using the **Statements** endpoints\n \n\n> In a typical purchase flow, we do not use Reservations. We create direct Transactions and use Refunds when needed." - }, - { - "name": "Allocations", - "item": [ - { - "name": "Create Allocation", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - }, - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"linkedEntity\": {\n \"id\": \"f07c85ed-ea1f-443e-953d-0f1b094ed012\",\n \"type\": \"CostCenter\"\n },\n \"referenceId\": \"4d00d477-e4fe-4345-b5cd-ba2ef1725cc8\",\n \"amount\": 658,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations" - ] - }, - "description": "This endpoint creates a new allocation within a specific VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to create an allocation. |\n\n#### Request Body\n\n``` json\n{\n \"linkedEntity\": {\n \"id\": \"f07c85ed-ea1f-443e-953d-0f1b094ed012\",\n \"type\": \"CostCenter\"\n },\n \"referenceId\": \"4d00d477-e4fe-4345-b5cd-ba2ef1725cc8\",\n \"amount\": 658,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `linkedEntity` | `object` | Yes | Linked entity information. |\n| └─ `id` | `string` | Yes | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| `amount` | `number` | Yes | Amount allocated. |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"3bfdafe0-a111-4ce9-9205-1dd5f872b44e\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 358,\n \"balanceAdjustment\": 0,\n \"remaining\": 358\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"67c9779d-b9a8-4512-a746-5f41361c7270\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created allocation. |\n| `budgetId` | `string` | Identifier of the budget. |\n| `linkedEntity` | `object` | Linked entity information. |\n| └─ `id` | `string` | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `balance` | `object` | Bugdet balance information. |\n| └─ `amount` | `number` | Total amount in the budget. |\n| └─ `balanceAdjustment` | `number` | Amount already utilized. |\n| └─ `remaining` | `number` | Remaining budget. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE` or `INACTIVE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of context (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"linkedEntity\": {\n \"id\": \"528b4e1f-b69d-463d-ae3c-42cf5fbeabc0\",\n \"type\": \"Cont\"\n },\n \"amount\": 868,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"referenceId\": \"67c9779d-b9a8-4512-a746-5f41361c7270\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.allocation+json" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:37:09 GMT" - }, - { - "key": "trace-id", - "value": "00-5343aeed0311c4e04a8cd15dabe8ca98-cf9e7818d1aaff67-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 06208dccf6b8f2d31c71f7b12d1e4bae.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG52-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "Z1vgzK7z7eODhSwU-a754H8Pti9pCYbkxPwXehRZ_iDz_bU69tP-EQ==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"3bfdafe0-a111-4ce9-9205-1dd5f872b44e\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 358,\n \"balanceAdjustment\": 0,\n \"remaining\": 358\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"67c9779d-b9a8-4512-a746-5f41361c7270\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}" - } - ] - }, - { - "name": "Create Batch of Allocations", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - }, - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040\n },\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/batch", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "batch" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoints creates one or more budget allocations in batch under a specific VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/batch`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget to create a batch of allocation. |\n\n#### Request Body\n\n``` json\n{\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"contractId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040\n },\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040,\n \"notificationSettings\": [\n {\n \"type\": \"Amount\",\n \"threshold\": 121,\n \"recipients\": [\n {\n \"email\": \"user1@email.com\"\n }\n ]\n }\n ]\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `allocations` | `array of objects` | Yes | List of allocation objects to be created. |\n| └─ `linkedEntity` | `object` | Yes | Linked entity information. |\n| └── `id` | `string` | Yes | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └── `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| └─ `amount` | `number` | Yes | Amount allocated. |\n| └─ `notificationSettings` | `object` | No | List of thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └── `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └── `threshold` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └── `recipients` | `array of objects` | No | List of recipients to notify. |\n| └─── `email` | `string` | No | Email address of the recipient. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n``` json\n{\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"allocations\": [\n {\n \"id\": \"0197c1f8-082a-776a-ade2-992badbcc96a\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"balanceAdjustment\": 0,\n \"remaining\": 2040\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n },\n {\n \"id\": \"0197c1f8-082a-776b-9eb4-f9d4822f6c34\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"balanceAdjustment\": 0,\n \"remaining\": 2040\n },\n \"notificationSettings\": [\n {\n \"type\": \"AMOUNT\",\n \"threshold\": 121,\n \"recipients\": [\n {\n \"email\": \"user1@email.com\"\n }\n ]\n }\n ],\n \"status\": \"ACTIVE\",\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `budgetId` | `string` | Unique identifier of the budget. |\n| `allocations` | `array of objects` | List of allocation objects to be created. |\n| └─ `id` | `string` | Allocation ID. |\n| └─ `budgetId` | `string` | Budget ID. |\n| └─ `linkedEntity` | `object` | Linked entity information. |\n| └── `id` | `string` | Identifier of the entity linked to the allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └── `type` | `string` | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| └─ `balance` | `object` | Allocation balance information. |\n| └── `amount` | `number` | Amount allocated. |\n| └── `balanceAdjustment` | `number` | Allocation balance adjustments. |\n| └── `remaining` | `number` | Balance remaining. |\n| └─ `notificationSettings` | `object` | List of thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └── `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └── `threshold` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └── `recipients` | `array of objects` | List of recipients to notify. |\n| └─── `email` | `string` | Email address of the recipient. |\n| └─ `status` | `string` | Current status of the allocation (e.g., `ACTIVE` or `INACTIVE`). |\n| └─ `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| └─ `contextType` | `string` | Type of context (`UNIT`). |\n| └─ `contextId` | `string` | Identifier of the context entity. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"ef3a32c3-4984-44cf-820b-ae864f41d95b\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 215,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"referenceId\": {{referenceId}},\n \"notifyThresholds\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 75\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/batch", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "batch" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"allocations\": [\n {\n \"id\": \"0197c1f8-082a-776a-ade2-992badbcc96a\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"totalUtilized\": 0,\n \"remaining\": 2040\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n },\n {\n \"id\": \"0197c1f8-082a-776b-9eb4-f9d4822f6c34\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"balance\": {\n \"amount\": 2040,\n \"totalUtilized\": 0,\n \"remaining\": 2040\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"contractId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Allocation", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"linkedEntity\": {\n \"id\": \"5ae133af-ea31-44b4-a74e-9e14752673c4\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 40,\n \"referenceId\": \"50e7cb46-ec05-441c-b558-78160798ceb6\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 90\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}" - ] - }, - "description": "This endpoint updates an exiting budget allocation within a specific VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"linkedEntity\": {\n \"id\": \"5ae133af-ea31-44b4-a74e-9e14752673c4\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 40,\n \"contractId\": \"50e7cb46-ec05-441c-b558-78160798ceb6\",\n \"allocations\": [\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-001-01\",\n \"type\": \"PO Number\"\n },\n \"contractId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040\n },\n {\n \"linkedEntity\": {\n \"id\": \"PO-number-2025-002-02\",\n \"type\": \"PO Number\"\n },\n \"referenceId\": \"21795f6f-5378-11f0-b37f-842fce820b77\",\n \"amount\": 2040,\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"EMAIL\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `linkedEntity` | `string` | Yes | Linked entity information. |\n| └─ `id` | `string` | Yes | Identifier of the entity linked to this allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Yes | Type of the linked entity Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `amount` | `number` | Yes | Budget amount allocated. |\n| `referenceId` | `string` | Yes | ID of the related entity (e.g., ID of a contract or promotion). |\n| `notificationSettings` | `object` | No | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | No | Enables notifications. |\n| └─ `threshold` | `array of objects` | No | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | No | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | No | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | No | List of user emails. |\n| └─ `type` | `string` | No | Type notifications. |\n| └── `email` | `string` | No | Identifier to send notifications. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"99805a66-143c-4409-a674-600b77e10fe9\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 51,\n \"balanceAdjustment\": 0,\n \"remaining\": 51\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"EMAIL\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"2c817a12-fafd-4fc9-becb-727dd7777d5f\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the updated allocation. |\n| `budgetId` | `string` | ID of the budget. |\n| `linkedEntity` | `string` | Linked entity information. |\n| └─ `id` | `string` | Identifier of the entity linked to this allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `balance` | `number` | Budget balance information. |\n| └─ `amount` | `number` | Allocated amount. |\n| └─ `balanceAdjustment` | `number` | Total utilized amount. |\n| └─ `remaining` | `number` | Remaining balance. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE` or `INACTIVE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"linkedEntity\": {\n \"id\": \"09140d1b-878f-4f2f-8850-8e16819bee7e\",\n \"type\": \"CostCenter\"\n },\n \"amount\": 484,\n \"cycleConfiguration\": {\n \"startDate\": \"{{start_date}}\",\n \"endDate\": \"{{end_date}}\"\n },\n \"contractId\": \"123\",\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.allocation+json" - }, - { - "key": "Content-Length", - "value": "427" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:39:23 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-013dbc4cf691d503f3f58cd3ac3bf150-16eee697b09e0860-01" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 90c491496585980aceb1033cb1612270.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "VMOHdH8YFqJG6vbq_mMJbuvd7c9ov3hZBUo7L-Ss1k9JZ2XLYOY3Yg==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"0197c1f6-eca5-7553-bbf1-34d3cc4ccf2d\",\n \"budgetId\": \"0197c1eb-3f62-73e1-93a2-6fa5d37b74f1\",\n \"linkedEntity\": {\n \"id\": \"99805a66-143c-4409-a674-600b77e10fe9\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 51,\n \"balanceAdjustment\": 0,\n \"remaining\": 51\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 90\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"2c817a12-fafd-4fc9-becb-727dd7777d5f\"\n}" - } - ] - }, - { - "name": "Delete Allocation", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}" - ] - }, - "description": "This endpoint deletes a specific allocation from a budget.\n\n> Allocations are not definitively deleted, they are maintained for the sake of record keeping. When looking at statements you will be able to see transaction history for deleted allocations. \n \n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n> ℹ️ This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n> ℹ️ The allocation was successfully deleted. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.empty+json" - }, - { - "key": "Content-Length", - "value": "2" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:55:56 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-9699de70be9e180c3dd01a24cfa995b6-a3848bf333d50796-01" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 06208dccf6b8f2d31c71f7b12d1e4bae.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG52-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "yp-RGr5nOPflfYT37NR6RLl3ynXqFgtQEg8_K0Y3VPDT7nJZTJueZA==" - } - ], - "cookie": [], - "body": "{}" - } - ] - }, - { - "name": "Get Allocation", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint retrieves a specific allocation within a VTEX budget by its ID.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n> ℹ️This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"0197c65e-1012-70f3-9fef-52bd7fe66a13\",\n \"budgetId\": \"0197c251-5b00-707b-9023-4f3d386be220\",\n \"linkedEntity\": {\n \"id\": \"d5c996af-455e-4b76-a36d-43376e96d82a\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 864,\n \"balanceAdjustment\": 0,\n \"remaining\": 864\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"cd1e8e85-bc9e-479e-b2a5-8d916a33618f\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the allocation. |\n| `budgetId` | `string` | ID of the budget. |\n| `linkedEntity` | `string` | Linked entity information. |\n| └─ `id` | `string` | Identifier of the entity linked to this allocation. If linked entity is a custom field, this ID is the custom field `value`. |\n| └─ `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `balance` | `number` | Budget balance information. |\n| └─ `amount` | `number` | Allocated amount. |\n| └─ `balanceAdjustment` | `number` | Total utilized amount. |\n| └─ `remaining` | `number` | Remaining balance. |\n| `notificationSettings` | `object` | Thresholds that trigger a notification based on usage. Applies to both Budgets and Allocations. |\n| └─ `enable` | `boolean` | Enables notifications. |\n| └─ `threshold` | `array of objects` | Object of the threshold. |\n| └─ `type` | `\"PERCENT\"` or `\"AMOUNT\"` | Defines whether the threshold is based on percentage of usage or a fixed amount. |\n| └─ `value` | `number` | The value of the threshold. For `\"PERCENT\"`, 100 means fully used (0 available); values above 100 indicate overuse. |\n| └─ `recipients` | `array of objects` | List of user emails. |\n| └─ `type` | `string` | Type notifications. |\n| └── `email` | `string` | Identifier to send notifications. |\n| `status` | `string` | Current status of the allocation (e.g., `ACTIVE`, `INACTIVE` or `DELETE`). |\n| `referenceId` | `string` | ID of the related entity (e.g., ID of a contract or promotion). |\n| `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - }, - { - "key": "Content-Length", - "value": "427" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:44:26 GMT" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-8d877e1d30d92b259e76a351900595aa-da324a4415ecca3f-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-36-99" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.033" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.032" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 d32fe7eed019f3eb6d4b418469d9db02.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "irSLzixo-kdsaMnXe4FvItwGJdKD_J7APxBi0VDUcOfVD54iQPSZig==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"0197c65e-1012-70f3-9fef-52bd7fe66a13\",\n \"budgetId\": \"0197c251-5b00-707b-9023-4f3d386be220\",\n \"linkedEntity\": {\n \"id\": \"d5c996af-455e-4b76-a36d-43376e96d82a\",\n \"type\": \"CostCenter\"\n },\n \"balance\": {\n \"amount\": 864,\n \"balanceAdjustment\": 0,\n \"remaining\": 864\n },\n \"notificationSettings\": {\n \"enable\": false,\n \"thresholds\": [\n {\n \"type\": \"PERCENT\",\n \"Value\": 99\n }\n ],\n \"recipients\": [\n {\n \"type\": \"Email\",\n \"identifier\": \"user1@email.com\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"referenceId\": \"cd1e8e85-bc9e-479e-b2a5-8d916a33618f\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}" - } - ] - }, - { - "name": "Query Allocations", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\": [\n {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/allocations/query", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "allocations", - "query" - ] - }, - "description": "This endpoint queries budget allocations by context and linked entities.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/allocations/query`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"items\": [\n {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `items` | `array of objects` | Yes | List of linked entities to query allocations for. |\n| └─ `id` | `string` | Yes | Identifier of the linked entity. |\n| └─ `type` | `string` | Yes | Type of the linked entity. Currently, the accepted values are: `User`, `Address`, and any custom field name, such as `PO Number`, `Cost Center`, `Release`, `Location`. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"items\": [\n {\n \"budgetId\": \"0197c65f-a1d3-71e8-ab11-013cc2f7f023\",\n \"allocationId\": \"0197c65f-bfb3-7452-8ae2-edf9f83624ae\",\n \"linkedEntity\": {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n },\n \"budgetBalance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"budgetEndDate\": \"2055-01-01T00:00:00.0000000\",\n \"allocationBalance\": {\n \"amount\": 13,\n \"balanceAdjustment\": 0,\n \"remaining\": 13\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `items` | `array of objects` | List of matching allocation entries. |\n| └─ `budgetId` | `string` | Identifier of the budget to which the allocation belongs. |\n| └─ `allocationId` | `string` | Identifier of the specific allocation. |\n| └─ `linkedEntity` | `object` | Linked entity object containing `id` and `type`. |\n| └── `id` | `string` | Identifier of the linked entity. |\n| └── `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release`, or `Location`). |\n| └─ `budgetBalance` | `object` | Budget balance information. |\n| └── `amount` | `number` | Total budget amount. |\n| └── `balanceAdjustment` | `number` | Total amount utilized from the budget. |\n| └── `remaining` | `number` | Remaining amount in the budget. |\n| └─ `budgetEndDate` | `string` (date-time) | Date when the budget ends, in ISO 8601 format. |\n| └─ `allocationBalance` | `object` | Allocation balance information. |\n| └── `amount` | `number` | Total allocation amount. |\n| └── `balanceAdjustment` | `number` | Total amount utilized from the allocation. |\n| └── `remaining` | `number` | Remaining amount in the allocation. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"contextType\": \"Organizaztion\",\n \"contextId\": \"{{contextId}}\",\n \"Items\": [\n {\n \"Id\": \"565db6d8-e125-404d-8d9d-20d96dce10c6\",\n \"Type\": \"Cont\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/allocations/query", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "allocations", - "query" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.query-allocation+json" - }, - { - "key": "Content-Length", - "value": "192" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:54:04 GMT" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-fff9603a54d5e92a21c477565fa772dc-aa828b4c3343fc7e-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b1466e95160a8d47be45fa76e640b0ec.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "fmAT8PB39_P3hHdWtzpeZpei7A1q5n-p1sv7KGzLl1CTgS5NguTPOA==" - } - ], - "cookie": [], - "body": "{\n \"items\": [\n {\n \"budgetId\": \"0197c65f-a1d3-71e8-ab11-013cc2f7f023\",\n \"allocationId\": \"0197c65f-bfb3-7452-8ae2-edf9f83624ae\",\n \"linkedEntity\": {\n \"id\": \"41b9ec1e-af0a-45f6-b3fb-351f700a63aa\",\n \"type\": \"CostCenter\"\n },\n \"budgetBalance\": {\n \"amount\": 1000,\n \"balanceAdjustment\": 0,\n \"remaining\": 1000\n },\n \"budgetEndDate\": \"2055-01-01T00:00:00.0000000\",\n \"allocationBalance\": {\n \"amount\": 13,\n \"balanceAdjustment\": 0,\n \"remaining\": 13\n }\n }\n ]\n}" - } - ] - }, - { - "name": "List Budget Allocations", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/?type={{type}}&page={{page}}&pageSize={{pageSize}}&status={{status}}&referenceId={{referenceId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "" - ], - "query": [ - { - "key": "type", - "value": "{{type}}" - }, - { - "key": "page", - "value": "{{page}}" - }, - { - "key": "pageSize", - "value": "{{pageSize}}" - }, - { - "key": "status", - "value": "{{status}}" - }, - { - "key": "referenceId", - "value": "{{referenceId}}" - } - ] - }, - "description": "### Endpoint Summary\n\nThis endpoints retrieves the allocations for a specific budget, with optional filtering by entity type.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/?Type={{type}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n\n> ℹ️ This request does not require a body. \n \n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `type` | `string` | No | Filters the allocations by linked entity type. (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| `page` | `integer` | No | |\n| `pageSize` | `integer` | No | |\n| `status` | `string` | No | Filters the allocations by status. |\n| `contractId` | `string` | No | Filters the allocations by contract ID. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 3\n },\n \"items\": [\n {\n \"id\": \"f8dc5da1-bac5-4d5c-8907-b29f8dda4e18\",\n \"budgetId\": \"d5793a13-c453-483b-8fc3-d17d96282c15\",\n \"linkedEntity\": {\n \"id\": \"565db6d8-e125-404d-8d9d-20d96dce10c6\",\n \"type\": \"Cont\"\n },\n \"balance\": {\n \"amount\": 26,\n \"balanceAdjustment\": 0,\n \"remaining\": 26\n },\n \"status\": \"DELETED\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination information. |\n| └─ `current` | `number` | Current page number. |\n| └─ `pages` | `number` | Total number of available pages. |\n| └─ `results` | `number` | Total number of results. |\n| `items[]` | `array of objects` | List of budget allocations. |\n| └─ `id` | `string` | Identifier of the allocation. |\n| └─ `budgetId` | `string` | Identifier of the budget to which the allocation belongs. |\n| └─ `linkedEntity` | `object` | Linked entity information. |\n| └── `id` | `string` | Identifier of the linked entity. |\n| └── `type` | `string` | Type of the linked entity (e.g., `User`, `Address`, `PO Number`, `Cost Center`, `Release` or `Location`). |\n| └─ `balance` | `object` | Budget balance information. |\n| └── `amount` | `number` | Total amount allocated. |\n| └── `balanceAdjustment` | `number` | Total amount used. |\n| └── `remaining` | `number` | Remaining balance. |\n| └─ `status` | `string` | Status of the allocation (e.g., `ACTIVE`, `INACTIVE` or `DELETE`). |\n| └─ `contextType` | `string` | Type of context for the budget (`UNIT`). |\n| └─ `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/?Type=CoNt", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "" - ], - "query": [ - { - "key": "Type", - "value": "CoNt" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.list-allocation+json" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 17:57:03 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.044" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-88fab764e47381b1cc029b784a59c4a3-ed961835c94236f7-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-30-248" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.049" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 06208dccf6b8f2d31c71f7b12d1e4bae.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG52-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "1dCNP2IeyrQr9qIh7y3ynXoD1ImIkbdvNlSCI-Mf8HlztrOFBX-M-w==" - } - ], - "cookie": [], - "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 3\n },\n \"items\": [\n {\n \"id\": \"f8dc5da1-bac5-4d5c-8907-b29f8dda4e18\",\n \"budgetId\": \"d5793a13-c453-483b-8fc3-d17d96282c15\",\n \"linkedEntity\": {\n \"id\": \"565db6d8-e125-404d-8d9d-20d96dce10c6\",\n \"type\": \"Cont\"\n },\n \"balance\": {\n \"amount\": 26,\n \"balanceAdjustment\": 0,\n \"remaining\": 26\n },\n \"notifyThresholds\": [\n {\n \"type\": \"PERCENT\",\n \"threshold\": 75\n }\n ],\n \"startDate\": \"03/26/2025 00:00:00\",\n \"endDate\": \"04/12/2025 00:00:00\",\n \"status\": \"DELETED\"\n }\n ]\n}" - } - ] - }, - { - "name": "Change Allocation Status", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"ACTIVE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/status/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "status", - "" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint updates the status of a specific allocation within a budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/status/`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `status` | `string` | Yes | The new status value to apply to allocation (e.g., `ACTIVE` or `INACTIVE` ). |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"status\": \"ACTIVE\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `status` | `string` | The updated status of the allocation (e.g., `ACTIVE`, `INACTIVE`). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"ACTIVE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/status/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "status", - "" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.vtex.update-allocation-activation+json" - }, - { - "key": "Content-Length", - "value": "19" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Thu, 10 Apr 2025 18:00:11 GMT" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "budget-v0.1.11" - }, - { - "key": "Cache-Control", - "value": "private, no-store" - }, - { - "key": "trace-id", - "value": "00-e9f3ed52afe43e076de29155baa48191-3991ba2f0afa33b7-01" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 7d30be9f6840d1673dd31a7f323a018c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG52-P1" - }, - { - "key": "X-Amz-Cf-Id", - "value": "sm8UVyeVTnX4Za0n2CqtzwjPMbF1FeyxYkVLF3ZWXCzOw1Vnl2w1lA==" - } - ], - "cookie": [], - "body": "{\n \"status\": \"ACTIVE\"\n}" - } - ] - }, - { - "name": "Update Allocation Usage", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"origin\": \"manual-adjustment\",\r\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\r\n \"amount\": 150.0,\r\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\r\n \"type\": \"Debit\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}//budgets/{{contextType}}/{{contextId}}/{{budgetId}}/allocations/{{allocationId}}/usage", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "", - "budgets", - "{{contextType}}", - "{{contextId}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "usage" - ] - }, - "description": "This endpoint updates the usage of a specific allocation within a budget.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/usage/`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": 150.0,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"type\": \"CREDIT\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | Describes the origin or reason for the adjustment. |\n| `reference` | `string` | No | Reference ID or note for tracking the adjustment. |\n| `amount` | `number` | Yes | Amount to adjust (positive or negative). |\n| `requestedBy` | `string` | Yes | Identifier or name of the system requesting the change. |\n| `type` | `string` | Yes | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n\n---\n\n### Response\n\n`200 - OK`\n\n``` json\n{}\n\n ```\n\nℹ️ This request returns an empty response." - }, - "response": [] - } - ], - "description": "Allocations are subdivisions of the main budget allocated to categories, projects, or departments.\n\nWith these endpoints you can create and manage the budget allocation of your store." - }, - { - "name": "Reservations", - "item": [ - { - "name": "Create Reservation", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"origin\": \"{{origin}}\",\n \"reference\": \"{{reference}}\",\n \"amount\": {{amount}},\n \"requestedBy\": \"{{requestedBy}}\",\n \"reservationId\": \"{{reservationId}}\",\n \"type\": \"{{type}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint creates a temporary reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"reservationId\": \"c3722334-3892-418c-a099-b13e9c562c7e\",\n \"type\": \"DEBIT\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Yes | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Yes | Amount to be reserved. |\n| `requestedBy` | `string` | Yes | Email of the user initiating the reservation. |\n| `reservationId` | `string` | Yes | Client-defined identifier for the reservation. |\n| `type` | `string` | Yes | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created reservation. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved. |\n| `requestedBy` | `string` | Email of the user who requested the reservation. |\n| `date` | `string` | Reservation date (ISO format). |\n| `type` | `string` | Adjustment type. |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"origin\": \"{{origin}}\",\n \"reference\": \"{{reference}}\",\n \"amount\": {{amount}},\n \"requestedBy\": \"{{requestedBy}}\",\n \"reservationId\": \"{{reservationId}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"budgetBalance\": {\n \"amount\": 475,\n \"balanceAdjustment\": 528,\n \"remaining\": -53\n },\n \"allocationBalance\": {\n \"amount\": 31,\n \"balanceAdjustment\": 528,\n \"remaining\": -497\n },\n \"status\": \"RESERVED\"\n}" - } - ] - }, - { - "name": "Confirmation Reservation", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}/confirmation", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations", - "{{reservationId}}", - "confirmation" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint confirms a reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}/confirmation`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n#### Request Body\n\n``` json\n{\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `requestedBy` | `string` | Yes | Email of the user confirming the reservation. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the created reservation. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved. |\n| `requestedBy` | `string` | Email of the user who requested the reservation. |\n| `date` | `string` | Reservation date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}/confirmation", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations", - "{{reservationId}}", - "confirmation" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"status\": \"CONFIRMED\"\n}" - } - ] - }, - { - "name": "Delete Reservation", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations", - "{{reservationId}}" - ] - }, - "description": "### Endpoint Summary\n\nThis enpoint cancels a reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `requestedBy` | `string` | Yes | Email of the user canceling the reservation. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Identifier of the canceled reservation. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the canceled reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the canceled reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved which was canceled. |\n| `requestedBy` | `string` | Email of the user who requested the cancellation. |\n| `date` | `string` | Canceled eservation date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations", - "{{reservationId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"id\": \"db09af7d-c39b-47c4-8724-d693c41e7715\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"status\": \"CANCELLED\"\n}" - } - ] - }, - { - "name": "Get Reservation", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations", - "{{reservationId}}" - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint retrieves a reservation under a specific allocation in a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n> ℹ️ This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"6a2d99e3-76e6-46ec-9764-49e0a7b71331\",\n \"amount\": -150,\n \"requestedBy\": \"Dean.Hegmann96@yahoo.com\",\n \"date\": \"2025-07-22T20:43:56.8455190Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Reservation identifier. |\n| `budgetId` | `string` | Identifier of the associated budget. |\n| `allocationId` | `string` | Identifier of the associated allocation. |\n| `origin` | `string` | The origin of the reservation (e.g., order system). |\n| `reference` | `string` | Reference tied to the reservation (e.g., order ID). |\n| `amount` | `number` | Amount reserved. |\n| `requestedBy` | `string` | Email of the user who requested the reservation. |\n| `date` | `string` | Reservation date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (UNIT). |\n| `contextId` | `string` | Identifier of the corresponding Unit. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations/{{reservationId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations", - "{{reservationId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"id\": \"db09af7d-c39b-47c4-8724-d693c41e7715\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"TEST\",\n \"reference\": \"1234\",\n \"amount\": 525,\n \"requestedBy\": \"Brennan_Rice@hotmail.com\",\n \"status\": \"CANCELLED\"\n}" - } - ] - }, - { - "name": "List Reservations", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations?page=1&pageSize=20&status=RESERVED", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "status", - "value": "RESERVED" - } - ] - }, - "description": "### Endpoint Summary\n\nThis endpoint retrieves a list of reservations under a specific allocation in a VTEX budget, optionally filtered by status.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/reservations?page=1&pageSize=20&status=RESERVED`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n| `reservationId` | `string` | Yes | Identifier of the reservation. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | No | Page number of the paginated result. |\n| `pageSize` | `integer` | No | Number of reservations per page. |\n| `status` | `string` | No | Filter by reservation status (e.g., `RESERVED`, `CONFIRMED`, or `CANCELED`). |\n\n> ℹ️ This request does not require a body. \n \n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"items\": [\n {\n \"id\": \"299a291e-65bf-4c4c-9209-bdaa6f620d07\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"type\": \"DEBIT\",\n \"amount\": -726,\n \"date\": \"2025-07-22 20:43:43\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ],\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\" \n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination information. |\n| └─ `current` | `number` | Current page number. |\n| └─ `pages` | `number` | Total number of pages available. |\n| └─ `results` | `number` | Total number of reservations available. |\n| `items` | `array of objects` | List of reservation objects. |\n| └─ `id` | `string` | Identifier of the reservation. |\n| └─ `budgetId` | `string` | Identifier of the associated budget. |\n| └─ `allocationId` | `string` | Identifier of the associated allocation. |\n| └─ `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| └─ `amount` | `number` | Amount reserved. |\n| └─ `date` | `string` | Reservation date (ISO format). |\n| └─ `contextType` | `string` | Context type. |\n| └─ `contextId` | `string` | Identification of the context type. |\n| `contextType` | `string` | Context type. |\n| `contextId` | `string` | Identification of the context type. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/reservations?page=1&pageSize=20&status=RESERVED", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "reservations" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "status", - "value": "RESERVED" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"items\": [\n {\n \"id\": \"299a291e-65bf-4c4c-9209-bdaa6f620d07\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"origin\": \"TEST\",\n \"reference\": \"1234\",\n \"amount\": 596,\n \"requestedBy\": \"Brandt83@hotmail.com\",\n \"status\": \"RESERVED\"\n }\n ]\n}" - } - ] - } - ], - "description": "Reservations are temporary holds on part of the available balance (budget or allocation) to ensure funds are committed before becoming a definitive transaction.\n\nWith these endpoints you can create and manage budget reservations." - }, - { - "name": "Statements", - "item": [ - { - "name": "Get Budget Statements", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/statements?page=1&pageSize=20", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "statements" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ] - }, - "description": "Retrieves the list of transactions (statement) for a specific budget within the VTEX Budget API.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/statements?page=1&pageSize=20`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a body.\n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | No | Page number of the results. |\n| `pageSize` | `integer` | No | Number of items per page. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"019833db-27ad-7264-b104-dfed7c0fcbac\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ] \n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination infor |\n| `pagination.current` | `number` | Current page number. |\n| `pagination.pages` | `number` | Total number of pages available. |\n| `pagination.results` | `number` | Total number of results across all pages. |\n| `transactions[]` | `array of objects` | List of transaction entries. |\n| `transactions[].id` | `string` | ID of the transaction. |\n| `transactions[].budgetId` | `string` | Identifier of the budget. |\n| `transactions[].allocationId` | `string` | ID of the associated allocation. |\n| `transactions[].type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `transactions[].amount` | `number` | Amount involved in the transaction. |\n| `transactions[].date` | `string` | ISO timestamp when the transaction occurred. |\n| `transactions[].contextType` | `string` | Context type. |\n| `transactions[].contextId` | `string` | Identification of the context type. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/statements?page=1&pageSize=20", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "statements" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\"\n }\n ]\n}" - } - ] - }, - { - "name": "Get Allocation Statements", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets//{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/statements?page=1&pageSize=20", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "statements" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ] - }, - "description": "Retrieves the list of transactions (statement) for a specific allocation within a VTEX budget.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/statements?page=1&pageSize=20`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a body.\n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Identifier of the budget. |\n| `allocationId` | `string` | Yes | Identifier of the allocation. |\n\n#### Query Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `page` | `integer` | No | Page number of the results. |\n| `pageSize` | `integer` | No | Number of items per page. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"budgetId\": \"019833db-27ad-7264-b104-dfed7c0fcbac\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n }\n ] \n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `pagination` | `object` | Pagination infor |\n| `pagination.current` | `number` | Current page number. |\n| `pagination.pages` | `number` | Total number of pages available. |\n| `pagination.results` | `number` | Total number of results across all pages. |\n| `transactions[]` | `array of objects` | List of transaction entries. |\n| `transactions[].id` | `string` | ID of the transaction. |\n| `transactions[].budgetId` | `string` | Identifier of the budget. |\n| `transactions[].allocationId` | `string` | ID of the associated allocation. |\n| `transactions[].type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `transactions[].amount` | `number` | Amount involved in the transaction. |\n| `transactions[].date` | `string` | ISO timestamp when the transaction occurred. |\n| `transactions[].contextType` | `string` | Context type. |\n| `transactions[].contextId` | `string` | Identification of the context type. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/statements?page=1&pageSize=20", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "statements" - ], - "query": [ - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"pagination\": {\n \"current\": 1,\n \"pages\": 1,\n \"results\": 1\n },\n \"transactions\": [\n {\n \"id\": \"b0e55425-a981-4d00-b6a2-9c7294d3d2b3\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"type\": \"DEBIT\",\n \"amount\": 528,\n \"date\": \"2025-05-17T07:01:44.0196090Z\"\n }\n ]\n}" - } - ] - } - ], - "description": "With these endpoints you can retrieve the transactions history for a given budget or allocation." - }, - { - "name": "Transactions", - "item": [ - { - "name": "Create Transaction", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"origin\": \"ecommerce\",\n \"reference\": \"093c891a-84a7-42cb-8a23-eb6dcf6607d4\",\n \"amount\": 50.0,\n \"requestedBy\": \"clara.dalle@email.com\",\n \"type\": \"DEBIT\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "transactions" - ] - }, - "description": "Creates a new transaction which subtracts funds from the specified budget allocation.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | ID of the budget to which the adjustment applies. |\n| `allocationId` | `string` | Yes | ID of the specific allocation being adjusted. |\n\n#### Request Body\n\n``` json\n{\n \"origin\": \"ecommerce\",\n \"reference\": \"093c891a-84a7-42cb-8a23-eb6dcf6607d4\",\n \"amount\": 50.0,\n \"requestedBy\": \"clara.dalle@email.com\",\n \"type\": \"DEBIT\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `origin` | `string` | Yes | Describes the origin or reason for the adjustment. |\n| `reference` | `string` | No | Reference ID or note for tracking the adjustment. |\n| `amount` | `number` | Yes | Amount to adjust (positive or negative). |\n| `type` | `string` | Yes | Condition that defines how the transaction will impact the budget (e.g., `DEBIT` or `CREDIT`). If `type` is `DEBIT`, the amount will be subtracted from the budget. If `type` is `CREDIT`, the amount will be added to the budget. |\n| `requestedBy` | `string` | Yes | Email of the user requesting the change. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"880e8400-e29b-41d4-a716-446655440000\",\n \"budgetId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"allocationId\": \"660e8400-e29b-41d4-a716-446655440000\",\n \"origin\": \"ecommerce\",\n \"reference\": \"093c891a-84a7-42cb-8a23-eb6dcf6607d4\",\n \"amount\": 50.0,\n \"requestedBy\": \"clara.dalle@email.com\",\n \"date\": \"2025-01-20T10:15:00Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the created transaction. |\n| `budgetId` | `string` | ID of the associated budget. |\n| `allocationId` | `string` | ID of the allocation within the budget. |\n| `origin` | `string` | Source system or origin of the transaction. |\n| `reference` | `string` | Reference identifier tied to the transaction. |\n| `amount` | `number` | Amount committed in the transaction. |\n| `requestedBy` | `string` | Email of the user who created the transaction. |\n| `date` | `string` | Date and time of the transaction (ISO format). |\n| `type` | `string` | Condition that defines how the transaction will impact the budget (e.g., `DEBIT` or `CREDIT`). If `type` is `DEBIT`, the amount will be subtracted from the budget. If `type` is `CREDIT`, the amount will be added to the budget. |\n| `contextType` | `string` | Type of context (e.g., `PROMOTIONS`, `UNIT`, `USER`). |\n| `contextId` | `string` | Identifier for the context type. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"origin\": \"{{origin}}\",\n \"reference\": \"{{reference}}\",\n \"amount\": {{amount}},\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/budgets/{{budgetId}}/allocations/{{allocationId}}/transactions", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "transactions" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"id\": \"880e8400-e29b-41d4-a716-446655440000\",\n \"budgetId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"allocationId\": \"660e8400-e29b-41d4-a716-446655440000\",\n \"origin\": \"ecommerce\",\n \"reference\": \"order-123\",\n \"amount\": -50,\n \"requestedBy\": \"api-user\",\n \"date\": \"2024-01-20T10:15:00Z\",\n \"type\": \"DEBIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"unit123\"\n}" - } - ] - }, - { - "name": "Refund Transaction", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}/refund", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "transactions", - "{{transactionId}}", - "refund" - ] - }, - "description": "Refunds a specific transaction from a budget allocation by creating a new **`CREDIT`** statement item, which adds funds back to the specified budget allocation.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}/refund`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | ID of the budget to which the adjustment applies. |\n| `allocationId` | `string` | Yes | ID of the specific allocation being adjusted. |\n| `transactionId` | `string` | Yes | ID of the transaction being refunded. |\n\n---\n\n#### Request Body\n\n``` json\n{\n \"requestedBy\": \"{{requestedBy}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `requestedBy` | `string` | Yes | The email of the user initiating the refund. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"originalTransactionId\": \"b343e863-f558-4b53-b250-0ad819f06642\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the newly created refund transaction. |\n| `originalTransactionId` | `string` | The ID of the original transaction being refunded. |\n| `budgetId` | `string` | The ID of the associated budget. |\n| `allocationId` | `string` | The ID of the associated allocation within the budget. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"requestedBy\": \"{{requestedBy}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}/refund", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "transactions", - "{{transactionId}}", - "refund" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"originalTransactionId\": \"b343e863-f558-4b53-b250-0ad819f06642\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\"\n}" - } - ] - }, - { - "name": "Get Transaction", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{context_type}}", - "{{context_id}}", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "transactions", - "{{transactionId}}" - ] - }, - "description": "### Endpoint Summary\n\nRetrieves a specific transaction from a budget allocation in the VTEX Budget API.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/budgets/{{context_type}}/{{context_id}}/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n### Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contextType` | `string` | Yes | Type of context for the budget (`UNIT`). This field can't be updated, it is used for validation. You must send the original value. |\n| `contextId` | `string` | Yes | Identifier of the corresponding Unit. This field can't be updated, it is used for validation. You must send the original value. |\n| `budgetId` | `string` | Yes | Budget ID related to the given transaction. |\n| `allocationId` | `string` | Yes | Allocation ID related to the given transaction. |\n| `transactionId` | `string` | Yes | ID of the desired transaction. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"manual-adjustment\",\n \"reference\": \"f0e2b16b-ad4c-485d-adb2-84c78d9354e7\",\n \"amount\": 480,\n \"requestedBy\": \"Declan.McKenzie85@gmail.com\",\n \"date\": \"2025-07-22T20:41:49.8362594Z\",\n \"type\": \"CREDIT\",\n \"contextType\": \"UNIT\",\n \"contextId\": \"093f29ac-7a1b-4d6b-a79a-48f89cf73d14\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the transaction. |\n| `budgetId` | `string` | The ID of the associated budget. |\n| `allocationId` | `string` | The ID of the associated allocation within the budget. |\n| `origin` | `string` | The origin or source of the transaction. |\n| `reference` | `string` | A reference ID tied to the transaction (e.g., order ID). |\n| `amount` | `number` | The amount involved in the transaction. |\n| `requestedBy` | `string` | The email of the user who requested the transaction. |\n| `date` | `string` | Transaction date (ISO format). |\n| `type` | `string` | Type of transaction (`DEBIT`, meaning a regular transaction or `CREDIT` indicating a refund). |\n| `contextType` | `string` | Type of context (e.g., `PROMOTIONS`, `UNIT`, `USER`). |\n| `contextId` | `string` | Identifier of the corresponding context type. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/budgets/{{budgetId}}/allocations/{{allocationId}}/transactions/{{transactionId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "budgets", - "{{budgetId}}", - "allocations", - "{{allocationId}}", - "transactions", - "{{transactionId}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\n \"id\": \"1bd05512-e694-4f0e-b182-bbe30ba7b613\",\n \"budgetId\": \"137793ab-efb6-4af7-a287-dd864cda336b\",\n \"allocationId\": \"324b5750-c827-4a6b-a670-c9297c832f4e\",\n \"origin\": \"TEST\",\n \"reference\": \"f0e2b16b-ad4c-485d-adb2-84c78d9354e7\",\n \"amount\": 480,\n \"requestedBy\": \"Declan.McKenzie85@gmail.com\"\n}" - } - ] - } - ], - "description": "With these endpoints you can create and manage budget transactions." - } - ], - "description": "A budget is a financial management tool that enables organizations to plan and monitor expenses, ensuring resources are allocated efficiently and in compliance with strategic criteria.\n\nThe Budget API is a comprehensive budget management service that allows you to create, manage, and control budgets, allocations, transactions, and reservations.\n\nThis endpoints' collection manages the expenses of your store, promoting finantial transparency, traceability, and control." - }, - { - "name": "Custom Fields", - "item": [ - { - "name": "Settings (Legacy)", - "item": [ - { - "name": "Create Custom Field Settings (Legacy)", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\": \"{{contractId}}\",\r\n \"customFields\": [\r\n {\r\n \"name\": \"{{customFieldName}}\",\r\n \"enabled\": true,\r\n \"required\": true,\r\n \"level\": \"{{level}}\", // order | item | address\r\n \"type\": \"option\" // only support \"option\" for now\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents" - ] - }, - "description": "Creates a document containing custom fields' settings for a given contract. You can set up multiple custom fields by sending multiple objects in the `customFields` array.\n\nThere are four types of custom fields currently accepted. For each of them that you wish to configure, you must send the exact `name` from the list below:\n\n- `PO Number`\n \n- `Cost Center`\n \n- `Release`\n \n- `Location`\n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"id\": \"{{contractId}}\",\n \"customFields\": [\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\",\n \"type\": \"option\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | The ID of the contract. |\n| `customFields` | `array of objects` | Yes | An array of custom field settings. |\n| `customFields[].name` | `string` | Yes | The name of the custom field. Currently, the accepted values are: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `customFields[].enabled` | `boolean` | Yes | Indicates if the custom field is enabled. |\n| `customFields[].required` | `boolean` | Yes | Indicates if the custom field is required. |\n| `customFields[].level` | `string` | Yes | The level at which the custom field applies (`order`, `item`, `address`). |\n| `customFields[].type` | `string` | Yes | The field type. Although `option`, `number`, and `text` are supported in theory, currently **only** `option` **is accepted**. |\n\n**Note**:\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"DocumentId\": \"c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created document. |\n| `Href` | `string` | Direct URL to access the created document. |\n| `DocumentId` | `string` | The document ID without the data entity prefix. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\": \"{{contractBusinessKlubPortalId}}\",\r\n \"customFields\": [\r\n {\r\n \"name\": \"PO Number\",\r\n \"enabled\": true,\r\n \"required\": true,\r\n \"level\": \"order\",\r\n \"type\": \"option\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFields/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFields", - "documents" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "222" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:38:33 GMT" - }, - { - "key": "x-vtex-took", - "value": "165" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"DocumentId\": \"c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}" - } - ] - }, - { - "name": "Get Custom Field Settings (Legacy)", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - }, - "description": "Retrieves the settings of a given custom field.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n``` json\n{\n \"id\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFields\": [\n {\n \"id\": \"{{customFieldId}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"order|item|address\",\n \"type\": \"option\"\n }\n ],\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"tags\": [],\n \"dataInstanceId\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the custom field settings document. |\n| `dataEntityId` | `string` | The ID of the data entity. |\n| `accountId` | `string` | The ID of the VTEX account. |\n| `accountName` | `string` | The name of the VTEX account. |\n| `followers` | `array` | An array of followers. |\n| `schemas` | `array` | An array of schemas. |\n| `customFields` | `array of objects` | An array of custom field settings. |\n| `customFields[].name` | `string` | The name of the custom field. Currently, the accepted values are: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `customFields[].enabled` | `boolean` | Indicates if the custom field is enabled. |\n| `customFields[].required` | `boolean` | Indicates if the custom field is required. |\n| `customFields[].level` | `string` | The level at which the custom field applies (`order`, `item`, `address`). |\n| `customFields[].type` | `string` | Yes |\n| `createdBy` | `string` | The ID of the user who created the document. |\n| `createdBy_USER` | `object` | Information about the user who created the document. |\n| `createdIn` | `string` | Timestamp of when the document was created. |\n| `lastInteractionBy` | `string` | The ID of the user who last interacted with the document. |\n| `lastInteractionBy_USER` | `object` | Information about the user who last interacted with the document. |\n| `lastInteractionIn` | `string` | Timestamp of the last interaction with the document. |\n| `tags` | `array` | An array of tags. |\n| `dataInstanceId` | `string` | The ID of the data instance. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "814" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:22:00 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.052" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "trace-id", - "value": "00-bb16bf72e685ad9bc17b7a92ffefc376-e1badf7cbb89e9fc-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"76bf42f57385ebf6be7c3e74558c0cab\"" - }, - { - "key": "x-vtex-took", - "value": "46" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-21-30" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.052" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b292206350dba522c123bef9b189a056.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "kUvu6vUrE4wgNEILr0LM-8AGwQLZOQz2n4PN5-zoiOgPakZao5N8qA==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFields\": {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"order|item|address\",\n \"type\": \"text|number|option\"\n },\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:21:43.1059453Z\",\n \"tags\": [],\n \"dataInstanceId\": \"ccd899ec-1701-11f0-b37f-c823fcd1b41a\"\n}" - } - ] - }, - { - "name": "Delete Custom Field Settings (Legacy)", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ] - }, - "description": "Deletes all custom fields settings associated with a given contract.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The document was successfully deleted. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFields/documents/{{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFields", - "documents", - "{{contractId}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "222" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:38:33 GMT" - }, - { - "key": "x-vtex-took", - "value": "165" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Update Custom Field Settings (Legacy)", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\":\"{{contractId}}\",\n \"customFields\":[\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\", // order | item | address\n \"type\": \"option\" // only support \"option\" for now\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ] - }, - "description": "Updates the configuration of all custom fields for a specific contract in the VTEX Data Entity. This includes enabling/disabling a custom field, marking it as required, and defining its scope and type.\n\nThe entire list of custom field settings must be provided in the PATCH request — partial updates are not supported. Because of this, to update custom field settings, we recommend the following steps:\n\n1. Use the Get Custom Field Settings request described above to get the current settings.\n \n2. Copy the settings array and change the values you wish to update.\n \n3. Send this request with the complete updated settings.\n \n\n---\n\n### **Request**\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### **Request Body**\n\n``` json\n{\n \"id\": \"{{contractId}}\",\n \"customFields\": [\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\",\n \"type\": \"option\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | The ID of the profile (contract) to update. |\n| `customFields` | `array of objects` | Yes | List of custom field configuration objects. |\n| `customFields[].name` | `string` | Yes | The unique identifier (name) of the custom field. |\n| `customFields[].enabled` | `boolean` | Yes | Whether this custom field is active. |\n| `customFields[].required` | `boolean` | Yes | Whether this custom field must be filled. |\n| `customFields[].level` | `string` | Yes | The scope where the custom field is applied. One of: `order`, `item`, `address`. |\n| `customFields[].type` | `string` | Yes | The field type. Although `text`, `number`, and `option` are supported in theory, currently **only** `option` **is accepted**. |\n\n_Important Notes_:\n\n- Partial updates are not supported. You must submit the full list of custom field settings in every request.\n \n- The `type` field accepts only `option` for now, even if other values are theoretically supported.\n \n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created document. |\n| `Href` | `string` | Direct URL to access the created document. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\":\"{{contractId}}\",\n \"customFields\":[\n {\n \"name\": \"{{customFieldName}}\",\n \"enabled\": true,\n \"required\": true,\n \"level\": \"{{level}}\", // order | item | address\n \"type\": \"option\" // only support \"option\" for now\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ] - } - }, - "status": "Success", - "code": 200, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": "{\r\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\r\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\"\r\n}" - } - ] - } - ] - }, - { - "name": "Settings v2", - "item": [ - { - "name": "Create Custom Field Settings v2", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Id\": \"customFieldSettings-89f1da93-6917-4cbf-894e-1f1399682826c\",\r\n \"Href\": \"http://accountName.myvtex.com/api/dataentities/customFieldSettings/documents/89f1da93-6917-4cbf-894e-1f1399682826c?_schema=v2\",\r\n \"DocumentId\": \"89f1da93-6917-4cbf-894e-1f1399682826c\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Create and configure `customFields` for a specific contract.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents?_schema=v2`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `contractId` | string | Yes | The contract ID to which the custom field belongs. |\n| `name` | string | Yes | The custom field name. Accepted values: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `enabled` | boolean | Yes | Indicates whether the custom field is enabled (`true`) or not (`false`). |\n| `required` | boolean | Yes | Indicates whether the custom field is mandatory (`true`) or optional (`false`). |\n| `level` | string | Yes | The level at which the custom field applies. Possible values: `item`, `order`, `address`. |\n| `type` | string | Yes | The value type of the custom field. Possible values: `text`, `number`, `option`. |\n| `additionalData` | string | No | Extra data associated with the custom field . |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-89f1da93-6917-4cbf-894e-1f1399682826c\",\n \"Href\": \"http://accountName.myvtex.com/api/dataentities/customFieldSettings/documents/89f1da93-6917-4cbf-894e-1f1399682826c?_schema=v2\",\n \"DocumentId\": \"89f1da93-6917-4cbf-894e-1f1399682826c\"\n}\n\n ```\n\n| Field | Type | Description |\n| ------------ | ------ | ------------------------------------------------ |\n| `Id` | string | Auto-generated GUID for the custom field. |\n| `Href` | string | Direct URL to the created custom field document. |\n| `DocumentId` | string | Identifier of the custom field document. |\n" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{ \r\n\"contractId\": \"{{contractId}}\", \r\n\"name\": \"{{customFieldName}}\", \r\n\"enabled\": true, \r\n\"required\": false, \r\n\"level\": \"{{level}}\", \r\n\"type\": \"option\", \r\n\"additionalData\": \"{{additionalData}}\" \r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFields/documents?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFields", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "222" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:38:33 GMT" - }, - { - "key": "x-vtex-took", - "value": "165" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"customFieldSettings-89f1da93-6917-4cbf-894e-1f1399682826c\",\n \"Href\": \"http://accountName.myvtex.com/api/dataentities/customFieldSettings/documents/89f1da93-6917-4cbf-894e-1f1399682826c?_schema=v2\",\n \"DocumentId\": \"89f1da93-6917-4cbf-894e-1f1399682826c\"\n}" - } - ] - }, - { - "name": "Get Custom Field Settings v2", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/search/?_fields=_all&_where=contractId={{contractId}}&_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "search", - "" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_where", - "value": "contractId={{contractId}}" - }, - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Retrieves the settings of a given custom field.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accoountName}}.myvtex.com/api/dataentities/customFieldSettings/search/?_fields=_all&_where=contractId={{contractId}}&_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n``` json\n[\n {\n \"id\": \"34575ee8-80c1-458d-b75a-7492b36513e3\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"PO Number\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:32:08.6879184Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:32:08.6879204Z\",\n \"tags\": [],\n \"dataInstanceId\": \"34575ee8-80c1-458d-b75a-7492b36513e3\"\n },\n {\n \"id\": \"8b696650-bc80-40d8-807e-32d46b018863\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"Address\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:35:57.1214314Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:35:57.1214335Z\",\n \"tags\": [],\n \"dataInstanceId\": \"8b696650-bc80-40d8-807e-32d46b018863\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier of the custom field instance. |\n| dataEntityId | string | Identifier of the data entity to which the field belongs. |\n| accountId | string | Identifier of the account associated with the field. |\n| accountName | string | Name of the account associated with the field. |\n| followers | array | List of users following this field (usually empty). |\n| schemas | array | List of applicable schema versions for this field. |\n| contractId | string | Identifier of the contract associated with the field. |\n| name | string | Name of the custom field. |\n| enabled | boolean | Indicates whether the field is enabled. |\n| required | boolean | Indicates whether the field is mandatory. |\n| level | string | Level at which the field is applied (e.g., `item`). |\n| type | string | Type of the field (e.g., `option`). |\n| additionalData | string | Additional field for extra information. |\n| createdBy | string | ID of the user who created the field. |\n| createdBy_USER | object | Details of the user who created the field: Id, Login, Name. |\n| createdIn | string (ISO 8601 datetime) | Date and time when the field was created. |\n| lastInteractionBy | string | ID of the user who last interacted with the field. |\n| lastInteractionBy_USER | object | Details of the user who last interacted: Id, Login, Name. |\n| lastInteractionIn | string (ISO 8601 datetime) | Date and time of the last interaction with the field. |\n| tags | array | List of tags associated with the field (usually empty). |\n| dataInstanceId | string | Identifier of the data instance (usually equal to `id`). |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_fields=_all&_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "814" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:22:00 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.052" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "trace-id", - "value": "00-bb16bf72e685ad9bc17b7a92ffefc376-e1badf7cbb89e9fc-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"76bf42f57385ebf6be7c3e74558c0cab\"" - }, - { - "key": "x-vtex-took", - "value": "46" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-21-30" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.052" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 b292206350dba522c123bef9b189a056.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "kUvu6vUrE4wgNEILr0LM-8AGwQLZOQz2n4PN5-zoiOgPakZao5N8qA==" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"34575ee8-80c1-458d-b75a-7492b36513e3\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"PO Number\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:32:08.6879184Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:32:08.6879204Z\",\n \"tags\": [],\n \"dataInstanceId\": \"34575ee8-80c1-458d-b75a-7492b36513e3\"\n },\n {\n \"id\": \"8b696650-bc80-40d8-807e-32d46b018863\",\n \"dataEntityId\": \"customFieldSettings\",\n \"accountId\": \"6e41729c-a5ca-4f37-a46f-62315ef3a56a\",\n \"accountName\": \"connections\",\n \"followers\": [],\n \"schemas\": [\n \"v2\"\n ],\n \"contractId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"name\": \"Address\",\n \"enabled\": true,\n \"required\": false,\n \"level\": \"item\",\n \"type\": \"option\",\n \"additionalData\": \"teste\",\n \"createdBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"createdBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-09-24T12:35:57.1214314Z\",\n \"lastInteractionBy\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"6ce199d2-8a85-4e83-831c-389dcb64c0c1\",\n \"Login\": \"ana.barbosa@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-09-24T12:35:57.1214335Z\",\n \"tags\": [],\n \"dataInstanceId\": \"8b696650-bc80-40d8-807e-32d46b018863\"\n }\n]\n" - } - ] - }, - { - "name": "Delete Custom Field Settings v2", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Deletes all custom fields settings associated with a given contract.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The document was successfully deleted. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFields/documents/{{contractId}}?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFields", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "222" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:38:33 GMT" - }, - { - "key": "x-vtex-took", - "value": "165" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 2b8eb2197d483eb73a5419f545e62c0c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "NmZTBwP1GqRW1IkXgX30TUyUA6P3d7rJBlqppibB-cYRbSlawAwt7g==" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Update Custom Field Settings v2", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "This endpoint allows you to enable or disable a custom field, mark it as required, define the level (`item`, `order`or `address`), and set its type (`text`, `number` or `option`). \nYou can also provide optional `additionalData` for custom validations, allowed values, or integration rules. \nEach request handles a single `customField` configuration. The field is identified by the system through its auto-generated id, while the `contractId` defines the contract to which it belongs.\n\n---\n\n### **Request**\n\n- **Method**: `PATCH`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### **Request Body**\n\n``` json\n{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `contractId` | string | Yes | The contract ID to which the custom field belongs. |\n| `name` | string | Yes | The custom field name. Accepted values: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `enabled` | boolean | Yes | Indicates whether the custom field is enabled (`true`) or not (`false`). |\n| `required` | boolean | Yes | Indicates whether the custom field is mandatory (`true`) or optional (`false`). |\n| `level` | string | Yes | The level at which the custom field applies. Possible values: `item`, `order`, `address`. |\n| `type` | string | Yes | The value type of the custom field. Possible values: `text`, `number`, `option`. |\n| `additionalData` | string | No | Extra data associated with the custom field . |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 No Content`" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{ \n\"contractId\": \"{{contractId}}\", \n\"name\": \"{{customFieldName}}\", \n\"enabled\": true, \n\"required\": false, \n\"level\": \"{{level}}\", \n\"type\": \"option\", \n\"additionalData\": \"{{additionalData}}\" \n}\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/dataentities/customFieldSettings/documents/{{contractId}}?_schema=v2", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "dataentities", - "customFieldSettings", - "documents", - "{{contractId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "" - } - ] - } - ] - }, - { - "name": "Values Management (Legacy)", - "item": [ - { - "name": "Populate Custom Field Value (Legacy)", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\": \"{{customFieldName}}\",\r\n \"contractId\": \"{{contractId}}\",\r\n \"auxId\": null, // the address id for \"address\" custom fields\r\n \"value\": \"{{value}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents?_schema=v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - } - ] - }, - "description": "Creates a value for an existing custom field for a given contract.\n\n> If you are creating a value for a custom field configured with level `address`, you must send a valid address ID in the field `auxId`. \n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"name\": \"{{customFieldName}}\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | The name of the custom field. Currently, the accepted values are: `PO Number`, `Cost Center`, `Release`, `Location`. |\n| `contractId` | `string` | Yes | The ID of the contract associated with the field. |\n| `auxId` | `null` | No | Address ID. Required only if the configured custom field level is `address`. |\n| `value` | `string` | Yes | The value to be stored for the custom field. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created value. |\n| `Href` | `string` | Direct URL to access the value document created. |\n| `DocumentId` | `string` | The value ID without the data entity prefix. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"contractId\": \"{{contractId}}\",\r\n \"customFieldId\": \"{{customFieldId}}\",\r\n \"auxId\": null,\r\n \"value\": \"{{value}}\",\r\n \"description\": \"{{customField description}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFields/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFields", - "documents" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "222" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:47:22 GMT" - }, - { - "key": "x-vtex-took", - "value": "80" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 efc74c02ba53691bc09b84df59c7ac50.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "O_JjJfGs7w1KbuRxSeLdeKb-FIJv7NOTW6plMt9tYy9w-LkF3m_mNQ==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}" - } - ] - }, - { - "name": "Update Custom Field Value (Legacy)", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"value\":\"CC3\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ] - }, - "description": "Updates the value of a custom field for a given contract.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"value\": \"CC3\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `value` | `string` | Yes | The new value for the custom field. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully updated. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"value\":\"CC3\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": null - } - ] - }, - { - "name": "Get Custom Field Value (Legacy)", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v1" - } - ] - }, - "description": "Retrieves a specific custom field value document.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not contain a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"name\": \"PO Number\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the document. |\n| `dataEntityId` | `string` | The ID of the data entity. |\n| `accountId` | `string` | The ID of the account. |\n| `accountName` | `string` | The name of the VTEX account. |\n| `followers` | `array` | An array of followers. |\n| `schemas` | `array` | An array of schemas. |\n| `name` | `string` | The name of the document (custom field name). |\n| `contractId` | `string` | The ID of the contract. |\n| `auxId` | `string` | Address ID. Used only for custom fields configured with level `address`. |\n| `value` | `string` | The value of the custom field. |\n| `createdBy` | `string` | The ID of the user who created the document. |\n| `createdBy_USER` | `object` | Information about the creator (Id, Login, Name). |\n| `createdIn` | `string` | The timestamp of document creation. |\n| `lastInteractionBy` | `string` | The ID of the last user who interacted with the document. |\n| `lastInteractionBy_USER` | `object` | Information about the last interacting user (Id, Login, Name). |\n| `lastInteractionIn` | `string` | The timestamp of the last interaction. |\n| `tags` | `array` | An array of tags. |\n| `dataInstanceId` | `string` | The ID of the data instance. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "764" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:25:04 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.008" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "trace-id", - "value": "00-2a77c957a08926be0d80c7dd18d6ef85-3e6e8b4097808615-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"ed96eb09817a2a9f8c2e3a34547dd2be\"" - }, - { - "key": "x-vtex-took", - "value": "3" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-36-99" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.009" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "J3DmVzqKQfb6E282p4j9AlMlC2be4NAba3avyByi-lrotD4NwNMTSA==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"name\": \"PO Number\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}" - } - ] - }, - { - "name": "Delete Custom Field Value (Legacy)", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v1" - } - ] - }, - "description": "Deletes a specific custom field value.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully deleted. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "plain", - "header": [ - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:25:53 GMT" - }, - { - "key": "x-vtex-took", - "value": "103" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "trace-id", - "value": "00-bfc81a8ce737ec7f73a2a353c1289ff0-8b1e7fd071812569-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "JjCfTOGcmoM3a84X4_eiBHtIQ95VE-DTThihLJDSCf2bzAg0CWFWcw==" - } - ], - "cookie": [], - "body": null - } - ] - }, - { - "name": "Search Custom Field Specific Value (Legacy)", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%BA-" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"" - } - ] - }, - "description": "Retrieves custom field values, filtered by contract ID, field name, and field value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search`\n \n- **Query Parameters**:\n \n - `_schema=v1`\n \n - `_fields=id,contractId,name,auxId,value`\n \n - `_where=contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"name\": \"PO Number\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the custom field value document. |\n| `contractId` | `string` | The ID of the contract associated with the field. |\n| `name` | `string` | The name of the custom field. |\n| `auxId` | `string` | Address ID. Used only for custom fields configured with level `address`. |\n| `value` | `string` | The value stored in the custom field. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%3A-" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND name=\"{{customField}}\" AND value=\"{{customFieldValue}}\"" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"name\": \"PO Number\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]" - } - ] - }, - { - "name": "Search All Custom Field Values (Legacy)", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%3A-" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\"&_sort%20=value= name ASC", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND name=\"{{customField}}\"" - }, - { - "key": "_sort%20", - "value": "value= name ASC" - } - ] - }, - "description": "Retrieves all custom field values, filtered by contract ID and custom field name, and returns them sorted by value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search`\n \n- **Query Parameters**:\n \n - `_schema=v1`\n \n - `_fields=id,contractId,name,auxId,value`\n \n - `_where=contractId={{contractId}} AND name=\"{{customField}}\"`\n \n - `_sort=value=name ASC`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"name\": \"PO Number\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | The ID of the custom field value document. |\n| `contractId` | `string` | The ID of the contract associated with the field. |\n| `name` | `string` | The name of the custom field. |\n| `auxId` | `string` | Address ID. Used only for custom fields configured with level `address`. |\n| `value` | `string` | The value stored in the custom field. |" - }, - "response": [ - { - "name": "Search All Custom Field Values", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%3A-" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v1&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND name=\"{{customField}}\"&_sort%20=value= name ASC", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND name=\"{{customField}}\"" - }, - { - "key": "_sort%20", - "value": "value= name ASC" - } - ] - } - }, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"name\": \"PO Number\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"auxId\": null,\n \"value\": \"{{value}}\"\n }\n]" - } - ] - } - ], - "description": "Once you have set up a custom field, you can use the APIs below to manage their value for specific contracts.\n\nEvery custom field value is associated with a specific contract and may also be associated with a specific address, in case the defined custom field level is `address`. The address ID associated with the custom field value is represented in the field `auxId`." - }, - { - "name": "Values Management v2", - "item": [ - { - "name": "Populate Custom Field Value v2", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"contractId\": \"{{contractId}}\",\r\n \"customFieldId\": \"{{customFieldId}}\",\r\n \"auxId\": null,\r\n \"value\": \"{{value}}\",\r\n \"description\": \"{{customField description}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Creates a value for an existing custom field for a given contract.\n\n> If you are creating a value for a custom field configured with level `address`, you must send a valid address ID in the field `auxId`. \n \n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"contractId\": \"{{contractId}}\",\n \"customFieldId\": \"{{customFieldId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"{{customField description}}\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `contractId` | `string` | Yes | The ID of the contract associated with the field. |\n| `customFieldId` | `string` | Yes | The ID of the custom field. Which is automatically generated in Create Custom Field Settings. |\n| `auxId` | `null` | No | Address ID. Required only if the configured custom field level is `address`. |\n| `value` | `string` | Yes | The value to be stored for the custom field. |\n| `description` | `string` | No | Details what the value represents. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created value. |\n| `Href` | `string` | Direct URL to access the value document created. |\n| `DocumentId` | `string` | The value ID without the data entity prefix. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"contractId\": \"{{contractId}}\",\r\n \"customFieldId\": \"{{customFieldId}}\",\r\n \"auxId\": null,\r\n \"value\": \"{{value}}\",\r\n \"description\": \"{{customField description}}\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFields/documents?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFields", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "222" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Mon, 24 Mar 2025 17:47:22 GMT" - }, - { - "key": "x-vtex-took", - "value": "80" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 efc74c02ba53691bc09b84df59c7ac50.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "O_JjJfGs7w1KbuRxSeLdeKb-FIJv7NOTW6plMt9tYy9w-LkF3m_mNQ==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"customFields-07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFields/documents/07d12677-08d8-11f0-b37f-e1ae31409099\",\n \"DocumentId\": \"07d12677-08d8-11f0-b37f-e1ae31409099\"\n}" - } - ] - }, - { - "name": "Update Custom Field Value v2", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"contractId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": \"optionalAuxId\",\n \"value\": \"CC3\",\n \"description\": \"Details about the value\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Updates the value of a specific custom field for a given contract.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"contractId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": \"optionalAuxId\",\n \"value\": \"CC3\",\n \"description\": \"Details about the value\"\n}\n\n ```\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| `contractId` | string | Yes | The ID of the contract to which the custom field belongs. |\n| `customFieldId` | string | Yes | The ID of the custom field (from the customFieldSettings document). |\n| `auxId` | string (null) | No | Optional auxiliary ID to further specify the context. |\n| `value` | string | Yes | The new value for the custom field (max length 22). |\n| `description` | string | No | Optional description explaining what the value represents. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully updated. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": null - } - ] - }, - { - "name": "Get Custom Field Value v2", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Retrieves a specific custom field value document.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not contain a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Some details about the value\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | string | The ID of the custom field value document. |\n| `dataEntityId` | string | The ID of the data entity (`customFieldValues`). |\n| `accountId` | string | Unique identifier of the VTEX account. |\n| `accountName` | string | Name of the VTEX account. |\n| `followers` | array | Array of followers for this document. |\n| `schemas` | array | Array of schemas associated with this document. |\n| `customFieldId` | string | The ID of the custom field (from `customFieldSettings`). |\n| `contractId` | string | The ID of the contract to which this value belongs. |\n| `auxId` | string (null) | Optional auxiliary ID (e.g., address ID) used for fields with level `address`. |\n| `value` | string | The actual value of the custom field. |\n| `description` | string (null) | Optional description explaining what the value represents. |\n| `createdBy` | string | ID of the user who created the document. |\n| `createdBy_USER` | object | Metadata about the creator (Id, Login, Name). |\n| `createdIn` | string | Timestamp when the document was created. |\n| `lastInteractionBy` | string | ID of the last user who modified the document. |\n| `lastInteractionBy_USER` | object | Metadata about the last interacting user (Id, Login, Name). |\n| `lastInteractionIn` | string | Timestamp of the last modification. |\n| `tags` | array | Tags associated with the document. |\n| `dataInstanceId` | string | Unique identifier of the data instance. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "764" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:25:04 GMT" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.008" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-store, no-cache" - }, - { - "key": "trace-id", - "value": "00-2a77c957a08926be0d80c7dd18d6ef85-3e6e8b4097808615-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "If-None-Match", - "value": "\"ed96eb09817a2a9f8c2e3a34547dd2be\"" - }, - { - "key": "x-vtex-took", - "value": "3" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-36-99" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.009" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "J3DmVzqKQfb6E282p4j9AlMlC2be4NAba3avyByi-lrotD4NwNMTSA==" - } - ], - "cookie": [], - "body": "{\n \"id\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\",\n \"dataEntityId\": \"customFieldValues\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"followers\": [],\n \"schemas\": [],\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"contractId\": \"{{contractId}}\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Some details about the value\",\n \"createdBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"createdBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"createdIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"lastInteractionBy\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"lastInteractionBy_USER\": {\n \"Id\": \"c83ea7ed-f875-4a10-b0a0-98d96aedab06\",\n \"Login\": \"frederico.mourao@vtex.com\",\n \"Name\": null\n },\n \"lastInteractionIn\": \"2025-04-11T18:24:14.8763277Z\",\n \"tags\": [],\n \"dataInstanceId\": \"a50012d0-c01f-465d-b4bc-e33b38d7437a\"\n}" - } - ] - }, - { - "name": "Delete Custom Field Value v2", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v2" - } - ] - }, - "description": "Deletes a specific custom field value.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The custom field value was successfully deleted. No content is returned in the response body." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/documents/{{customFieldValueId}}?_fields=_all&_schema=v2", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "documents", - "{{customFieldValueId}}" - ], - "query": [ - { - "key": "_fields", - "value": "_all" - }, - { - "key": "_schema", - "value": "v2" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "plain", - "header": [ - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Fri, 11 Apr 2025 18:25:53 GMT" - }, - { - "key": "x-vtex-took", - "value": "103" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "trace-id", - "value": "00-bfc81a8ce737ec7f73a2a353c1289ff0-8b1e7fd071812569-01" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 104f9221df366bdf62e6703893c1efe0.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "JjCfTOGcmoM3a84X4_eiBHtIQ95VE-DTThihLJDSCf2bzAg0CWFWcw==" - } - ], - "cookie": [], - "body": null - } - ] - }, - { - "name": "Search Custom Field Specific Value v2", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%BA-" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"" - } - ] - }, - "description": "Retrieves custom field values, filtered by contract ID, field name, and field value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"\n \n- **Query Parameters**:\n \n - `_schema=v2`\n \n - `_fields=id,contractId,customFieldId,auxId,value`\n \n - `_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"CC3\",\n \"description\": \"Optional description\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | string | The unique ID of the custom field value document. |\n| `contractId` | string | The ID of the contract associated with the custom field. |\n| `customFieldId` | string | The ID of the custom field (from `customFieldSettings`). |\n| `auxId` | string (null) | Optional auxiliary |\n| `value` | string | The value stored in the custom field. |\n| `description` | string (null) | Optional text describing what the value represents. |" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%3A-" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\" AND value=\"{{customFieldValue}}\"" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"CC3\",\n \"description\": \"Optional description\"\n }\n]" - } - ] - }, - { - "name": "Search All Custom Field Values", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%3A-" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id, contractId, customFieldId, auxId, value&_where=contractId={{contractId}}&_sort%20=value= ASC", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - }, - { - "key": "_fields", - "value": "id, contractId, customFieldId, auxId, value" - }, - { - "key": "_where", - "value": "contractId={{contractId}}" - }, - { - "key": "_sort%20", - "value": "value= ASC" - } - ] - }, - "description": "Retrieves all custom field values, filtered by contract ID and custom field name, and returns them sorted by value.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: https://{{accountName}}.myvtex.com/api/dataentities/customFieldValues/search?_schema=v2&_fields=id, contractId, customFieldId, auxId, value&_where=contractId={{contractId}}&_sort =value= ASC\n \n- **Query Parameters**:\n \n - `_schema=v2`\n \n - `_fields=id,contractId,customFieldId,auxId,value`\n \n - `_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\"`\n \n - `_sort=value=ASC`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nNo body is required for this request.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Optional description\"\n },\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1564b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789audldef\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Optional description\"\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | string | The unique ID of the custom field value document. |\n| `contractId` | string | The ID of the contract associated with the custom field. |\n| `customFieldId` | string | The ID of the custom field (from `customFieldSettings`). |\n| `auxId` | string (null) | Optional auxiliary ID, e.g., address ID for fields with level `address`. |\n| `value` | string | The value stored in the custom field. |\n| `description` | string (null) | Optional text describing what the value represents. |" - }, - "response": [ - { - "name": "Search All Custom Field Values", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjJCM0EyQzBGQzJGMkQ5OTA3M0QwQTZDODUwNkNCOEZBQUZDNUI4QUMiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwYWJsby5wdXB1bGluQHZ0ZXguY29tIiwiYWNjb3VudCI6InFhc3RvcmUiLCJhdWRpZW5jZSI6ImFkbWluIiwic2VzcyI6IjEwMzJlMzdkLTA2MTctNDg4Mi1hNWU0LTcyNmJhMGMyMGQyYiIsImV4cCI6MTc0NzUyOTAwNSwidHlwZSI6InVzZXIiLCJ1c2VySWQiOiIxYzhkYmEwNC05NzkwLTQyODEtYjAyYy03NWEwZDM0YmMyYWUiLCJpYXQiOjE3NDc0NDI2MDUsImlzUmVwcmVzZW50YXRpdmUiOmZhbHNlLCJpc3MiOiJ0b2tlbi1lbWl0dGVyIiwianRpIjoiYzQ5NDRmYmEtYjVmNS00MzAxLTgyNTAtYTk1NmIwZGM3NGYwIn0.8a55OMKosS_YgEIHCo2913OjFHiZ62UXjhJT49Zcpsoqo7huE_4M_hTGCq9-_NIO1SUUXE46kwWU6wY58tAFEg" - }, - { - "key": "Cookie", - "value": "VtexWorkspace=master%3A-" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/customFieldValues/search?_schema=v2&_fields=id,contractId,name,auxId,value&_where=contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\"&_sort%20=value= name ASC", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "customFieldValues", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v2" - }, - { - "key": "_fields", - "value": "id,contractId,name,auxId,value" - }, - { - "key": "_where", - "value": "contractId={{contractId}} AND customFieldId=\"{{customFieldId}}\"" - }, - { - "key": "_sort%20", - "value": "value= name ASC" - } - ] - } - }, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"e5130781-32ed-11f0-b37f-942217c27f9b\",\n \"contractId\": \"1124b2d8-32eb-11f0-b37f-e2557e6b18d5\",\n \"customFieldId\": \"a7f2b3d4-5c6e-7f89-0123-456789abcdef\",\n \"auxId\": null,\n \"value\": \"{{value}}\",\n \"description\": \"Optional description\"\n }\n]" - } - ] - } - ], - "description": "Once you have set up a custom field, you can use the APIs below to manage their value for specific contracts.\n\nEvery custom field value is associated with a specific contract and may also be associated with a specific address, in case the defined custom field level is `address`. The address ID associated with the custom field value is represented in the field `auxId`." - }, - { - "name": "orderForm management", - "item": [ - { - "name": "Create or update custom field in orderForm", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"name\":\"Cost Center\",\r\n \"value\":\"CC3\",\r\n \"refId\":\"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "checkout", - "pub", - "orderForm", - "{{orderFormId}}", - "customFields", - "{{linkedEntity.type}}", - "{{linkedEntity.id}}" - ] - }, - "description": "### Request\n\n- **Method**: `PUT`\n \n- **URL**: `{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nCreates or updates a custom field in the orderForm.\n\n#### Path Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| orderFormId | integer | true | Unique identifier for a customer's shopping cart. |\n| linkedEntity.type | string | true | Data entity type, which can be one of the following: `order` `item` `address`. |\n| linkedEntity.id | string | false | Unique identifier of the entity value being included in the orderForm. Required only for `item` and `address` entity types, not for `order`. |\n\n### Request Body\n\n``` json\n{\n\"name\":\"Cost Center\",\n\"value\":\"CC3\",\n\"refId\":\"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| name | string | true | Custom field name. |\n| value | string | true | Custom field value, limited to 50 characters. |\n| refId | string | false | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: The response will be the orderForm updated.\n \n\n``` json\n{\n \"customData\":{\n ...,\n \"customFields\":[\n {\n \"linkedEntity\":{\n \"type\":\"item\",\n \"id\":\"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\":[\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n ]\n },\n ...\n}\n\n ```\n\n| Field | Type | Nullable | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | false | Data entity information. |\n| linkedEntity{ }.type | string | false | Data entity type, which can be one of the following: `order` `item` `address`. |\n| linkedEntity{ }.id | string | true | Data entity ID. This field is nullable when the entity type is `order`. |\n| fields\\[ \\] | array of objects | false | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | false | Custom field name. |\n| fields\\[ \\]{ }.value | string | false | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |" - }, - "response": [] - }, - { - "name": "Create or update custom fields in orderForm in batch", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\r\n {\r\n \"linkedEntity\": {\r\n \"type\": \"order\"\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"PO Number\",\r\n \"value\": \"PO1\",\r\n \"refId\": \"88c4c1e6-1db4-4a13-aa96-e79daba7772d\"\r\n }\r\n ]\r\n },\r\n {\r\n \"linkedEntity\": {\r\n \"type\": \"address\",\r\n \"id\": \"FCDEC51EDF2B4BBFA7E899CD4CA5333C\"\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Location\",\r\n \"value\": \"DSK1\",\r\n \"refId\": \"ff84f2fd-9fe1-48a0-aab2-1e0988e3e889\"\r\n }\r\n ]\r\n },\r\n {\r\n \"linkedEntity\": {\r\n \"type\": \"item\",\r\n \"id\": \"B2949D0A45244825B177D2F9F96DC711\"\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Cost Center\",\r\n \"value\": \"CC3\",\r\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\r\n }\r\n ]\r\n }\r\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "checkout", - "pub", - "orderForm", - "{{orderFormId}}", - "customFields" - ] - }, - "description": "### Request\n\n- **Method**: `PUT`\n \n- **URL**: `{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nCreates or updates custom fields in the orderForm in batch.\n\n#### Path Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| orderFormId | integer | true | Unique identifier for a customer's shopping cart. |\n\n### Request Body\n\n``` json\n[\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"88c4c1e6-1db4-4a13-aa96-e79daba7772d\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"FCDEC51EDF2B4BBFA7E899CD4CA5333C\"\n },\n \"fields\": [\n {\n \"name\": \"Location\",\n \"value\": \"DSK1\",\n \"refId\": \"ff84f2fd-9fe1-48a0-aab2-1e0988e3e889\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\": [\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n]\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | true | Data entity information. |\n| linkedEntity{ }.type | string | true | Data entity type. |\n| linkedEntity{ }.id | string | false | Data entity ID. It is required when the entity type is `address`, but can be omitted for `item` and `order`, because the system considers the current values in the orderForm. |\n| fields\\[ \\] | array of objects | true | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | true | Custom field name. |\n| fields\\[ \\]{ }.value | string | true | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: The response will be the orderForm updated.\n \n\n``` json\n{\n \"customData\":{\n ...,\n \"customFields\":[\n {\n \"linkedEntity\":{\n \"type\":\"item\",\n \"id\":\"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\":[\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n ]\n },\n ...\n}\n\n ```\n\n| Field | Type | Nullable | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | false | Data entity information. |\n| linkedEntity{ }.type | string | false | Data entity type, which can be one of the following: `order` `item` `address` |\n| linkedEntity{ }.id | string | true | Data entity ID. This field is nullable when the entity type is `order`. |\n| fields\\[ \\] | array of objects | false | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | false | Custom field name. |\n| fields\\[ \\]{ }.value | string | false | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |" - }, - "response": [] - }, - { - "name": "Delete custom field in orderForm", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}//api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}/{{fieldName}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "", - "api", - "checkout", - "pub", - "orderForm", - "{{orderFormId}}", - "customFields", - "{{linkedEntity.type}}", - "{{linkedEntity.id}}", - "{{fieldName}}" - ] - }, - "description": "## Request\n\n- **Method**: `DELETE`\n \n- **URL**: `{{baseUrl}}/api/checkout/pub/orderForm/{{orderFormId}}/customFields/{{linkedEntity.type}}/{{linkedEntity.id}}/{fieldName}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nRemoves a field from a custom field in an orderForm given a field name.\n\nThis endpoint doesn’t require a request body.\n\n### Path Parameters\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| orderFormId | integer | true | Unique identifier for a customer's shopping cart. |\n| linkedEntity.type | string | true | Data entity type, which can be one of the following: `order` `item` `address`. |\n| linkedEntity.id | string | false | Unique identifier of the entity value being included in the orderForm. Required only for `item` and `address` entity types, not for `order`. |\n| fieldName | string | true | Custom field name. |\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**: The response will be the orderForm updated.\n \n\n``` json\n{\n \"customData\":{\n ...,\n \"customFields\":[\n {\n \"linkedEntity\":{\n \"type\":\"item\",\n \"id\":\"B2949D0A45244825B177D2F9F96DC711\"\n },\n \"fields\":[\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC3\",\n \"refId\": \"1dd9eeb8-23ed-42b3-8028-dc7745c01ada\"\n }\n ]\n }\n ]\n },\n ...\n}\n\n ```\n\n| Field | Type | Nullable | Description |\n| --- | --- | --- | --- |\n| linkedEntity | object | false | Data entity information. |\n| linkedEntity{ }.type | string | false | Data entity type, which can be one of the following: `order` `item` `address` |\n| linkedEntity{ }.id | string | true | Data entity ID. This field is nullable when the entity type is `order`. |\n| fields\\[ \\] | array of objects | false | List with information about the custom field created or updated in the orderForm. |\n| fields\\[ \\]{ }.name | string | false | Custom field name. |\n| fields\\[ \\]{ }.value | string | false | Custom field value. |\n| fields\\[ \\]{ }.refId | string | true | A reference ID that can be used to tie the custom field to external providers. For example, a Cost Center ID. |" - }, - "response": [] - } - ] - } - ], - "description": "You can configure custom fields to collect additional data during checkout, improving order tracking and compliance." - }, - { - "name": "Default Values", - "item": [ - { - "name": "Create Default Values", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\":\"orgUnitId-{{unitId}}\",\r\n \"defaultValues\":[\r\n {\r\n \"entity\":\"address/shipping\",\r\n \"entityValueId\":\"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"address/billing\",\r\n \"entityValueId\":\"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"creditCard\",\r\n \"entityValueId\":\"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "defaultValues", - "documents" - ] - }, - "description": "Creates a document with a set of default values for a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"id\": \"orgUnitId-{{unit-id}}\",\n \"defaultValues\": [\n {\n \"entity\": \"address/shipping\",\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"address/billing\",\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"creditCard\",\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | ID of the organizational Unit prefixed with `orgUnitId-`. |\n| `defaultValues` | `array` | Yes | An array of default value objects. |\n| `defaultValues[].entity` | `string` | Yes | The name of the entity (e.g., `address/shipping`, `creditCard`). |\n| `defaultValues[].entityValueId` | `string` | Yes | The ID of the entity value associated to the entity. |\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"customFieldSettings-c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/customFieldSettings/documents/c90354e8-08d6-11f0-b37f-daebda928cfa\",\n \"DocumentId\": \"c90354e8-08d6-11f0-b37f-daebda928cfa\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `Id` | `string` | Unique identifier of the created document. |\n| `Href` | `string` | Direct link to the created document. |\n| `DocumentId` | `string` | The document ID (same value as in `Id` without prefix). |" - }, - "response": [] - }, - { - "name": "Get Default Values", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}?_schema=v1&_fields=id,defaultValues", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "defaultValues", - "documents", - "orgUnitId-{{unitId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_fields", - "value": "id,defaultValues" - } - ] - }, - "description": "Retrieves the default values for a specific organization unit in the VTEX Data Entity by making a GET request.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents/orgUnitId-{{unit}}?_schema=v1&_fields=id,defaultValues`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis request does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `200 OK`\n \n\n```json\n{\n \"id\": \"a6d958c2-25ba-4f4d-9a0a-6b56e458426c\",\n \"defaultValues\": [\n {\n \"entity\": \"address/shipping\",\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"address/billing\",\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"creditCard\",\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\n }\n ]\n}\n\n ```" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}?_schema=v1&_fields=id,defaultValues", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "defaultValues", - "documents", - "orgUnitId-{{unitId}}" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_fields", - "value": "id,defaultValues" - } - ] - } - }, - "_postman_previewlanguage": "", - "header": [], - "cookie": [ - { - "expires": "Invalid Date" - } - ], - "body": "{\r\n \"id\": \"a6d958c2-25ba-4f4d-9a0a-6b56e458426c\",\r\n \"defaultValues\": [\r\n {\r\n \"entity\": \"address/shipping\",\r\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\": \"address/billing\",\r\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\": \"creditCard\",\r\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\r\n }\r\n ]\r\n}" - } - ] - }, - { - "name": "Update Default Values", - "request": { - "method": "PATCH", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\":\"orgUnitId-{{unit}}\",\r\n \"defaultValues\":[\r\n {\r\n \"entity\":\"address/shipping\",\r\n \"entityValueId\":\"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"address/billing\",\r\n \"entityValueId\":\"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\r\n },\r\n {\r\n \"entity\":\"creditCard\",\r\n \"entityValueId\":\"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "defaultValues", - "documents", - "orgUnitId-{{unitId}}" - ] - }, - "description": "Updates the default values for a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `PATCH`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents/orgUnitId-{{unit}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\n#### Request Body\n\n``` json\n{\n \"id\": \"orgUnitId-{{unit}}\",\n \"defaultValues\": [\n {\n \"entity\": \"address/shipping\",\n \"entityValueId\": \"cf6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"address/billing\",\n \"entityValueId\": \"f6b85ab9-8e0a-4e49-9f1a-b48286c913a4\"\n },\n {\n \"entity\": \"creditCard\",\n \"entityValueId\": \"e5a80ff0-c243-4258-a2b1-f93492af46ec\"\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | ID of the organizational Unit prefixed with `orgUnitId-`. |\n| `defaultValues` | `array` | Yes | A list of default value entries. |\n| `defaultValues[].entity` | `string` | Yes | The name of the entity (e.g., `address/shipping`, `creditCard`). |\n| `defaultValues[].entityValueId` | `string` | Yes | The unique ID of the associated entity value. |\n\n**Note**: You must provide the complete list of default values. Partial updates are not supported.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `204 No Content`\n \n- **Description**: The default values were successfully updated. No content is returned in the response body." - }, - "response": [] - }, - { - "name": "Delete Default Values", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/defaultValues/documents/orgUnitId-{{unitId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "defaultValues", - "documents", - "orgUnitId-{{unitId}}" - ] - }, - "description": "Deletes all default values for a specific organization unit.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/defaultValues/documents/orgUnitId-{{unit}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n\nThis endpoint does not require a request body.\n\n---\n\n### Response\n\n#### Success Response\n\n- **Status Code**: `201 Created`\n \n- **Description**: The default values document for the specified organization unit has been successfully deleted.\n \n\n#### Error Responses\n\n- **404 Not Found**: The document with the specified organization unit ID does not exist." - }, - "response": [] - } - ], - "description": "Default values are purchase details, such as addresses and credit cards, that you can configure for an organizational unit to be automatically pre-filled at checkout." - }, - { - "name": "Contact Information", - "item": [ - { - "name": "Create New Contact Information", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "••••••" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n\t\"email\": \"rafael.silva@example.com\",\n\t\"firstName\": \"Rafael\",\n\t\"lastName\": \"Silva\",\n\t\"profileId\": \"878fa807-7c7b-4ad3-aaa6-e3ef4fb22b8f\",\n \"phone\": \"+1 212 555 1234\",\n \"phoneExtension\": \"123\",\n \"document\": \"112-3456789\",\n \"documentType\": \"EIN\",\n \"addressIds\": [\n \"1ded2836-2061-4545-96d3-58f5338627c5\",\n \"a3e103fc-d074-44fb-941a-949f1bca937c\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/contact_information/documents?_schema=v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "contact_information", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - } - ] - }, - "description": "This endpoint creates new contact information.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/dataentities/contact_information/documents?_schema=v1`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Query\n\n| **Parameter** | **Type** | Required | **Description** |\n| --- | --- | --- | --- |\n| `_schema` | `string` | Yes | Schema version. |\n\n---\n\n### Request body\n\n``` json\n{\n \"email\": \"rafael.silva@example.com\",\n \"firstName\": \"Rafael\",\n \"lastName\": \"Silva\",\n \"profileId\": \"878fa807-7c7b-4ad3-aaa6-e3ef4fb22b8f\",\n \"phone\": \"+1 212 555 1234\",\n \"phoneExtension\": \"123\",\n \"document\": \"112-3456789\",\n \"documentType\": \"EIN\",\n \"addressIds\": [\"1ded2836-2061-4545-96d3-58f5338627c5\", \"a3e103fc-d074-44fb-941a-949f1bca937c\"]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `email` | `string` | No | User email. |\n| `firstName` | `string` | Yes | User first name. |\n| `lastName` | `string` | Yes | User last name. |\n| `profileId` | `string (UUID)` | No | References a Customer entity by its UUID. |\n| `phone` | `string` | No | Main phone number. |\n| `PhoneExtension` | `string` | No | Internal phone extension if applicable. |\n| `document` | `string` | No | Identification document. |\n| `documentType` | `string` | No | Type of document. |\n| `addressIds` | `array (UUID)` | No | References to address entities. |\n\n---\n\n### Response\n\n- **Status Code**: `201 Created`\n \n- **Body**:\n \n\n``` json\n{\n \"Id\": \"contact_information-dd4a6849-58e2-11f0-b37f-d93b9c481b34\",\n \"Href\": \"http://{{account}}.myvtex.com/api/dataentities/contact_information/documents/dd4a6849-58e2-11f0-b37f-d93b9c481b34?_schema=v1\",\n \"DocumentId\": \"dd4a6849-58e2-11f0-b37f-d93b9c481b34\"\n}\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `Id` | `string` | Contact information identifier. |\n| `Href` | `string` | Contact information store path. |\n| `DocumentId` | `string` | Contact information document identifier. |" - }, - "response": [ - { - "name": "Success Response", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}" - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"rafael.silva@example.com\",\r\n \"firstName\": \"Rafael\",\r\n \"lastName\": \"Silva\",\r\n \"profileId\": \"878fa807-7c7b-4ad3-aaa6-e3ef4fb22b8f\",\r\n \"phone\": \"+1 212 555 1234\",\r\n \"phoneExtension\": \"123\",\r\n \"document\": \"112-3456789\",\r\n \"documentType\": \"EIN\",\r\n \"addressIds\": [\"1ded2836-2061-4545-96d3-58f5338627c5\", \"a3e103fc-d074-44fb-941a-949f1bca937c\"]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/contact_information/documents?_schema=v1", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "contact_information", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"contact_information-dd4a6849-58e2-11f0-b37f-d93b9c481b34\",\n \"Href\": \"http://{{account}}.myvtex.com/api/dataentities/contact_information/documents/dd4a6849-58e2-11f0-b37f-d93b9c481b34?_schema=v1\",\n \"DocumentId\": \"dd4a6849-58e2-11f0-b37f-d93b9c481b34\"\n}" - } - ] - }, - { - "name": "Search Contact Information", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/contact_information/search?_where=profileId={{profileIdValue}}&_fields=firstName, lastName, email&_schema=v1 ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "contact_information", - "search" - ], - "query": [ - { - "key": "_where", - "value": "profileId={{profileIdValue}}", - "description": "Data entities information." - }, - { - "key": "_fields", - "value": "firstName, lastName, email", - "description": "Data entities fields." - }, - { - "key": "_schema", - "value": "v1 ", - "description": "Master Data version." - } - ] - }, - "description": "This endpoint will search contacts information based in the query parameters.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/a`pi/dataentitites/contact_information/search?_where=profileId={{profileIdValue}}&_fields=firstName, lastName, email&_schema=v1\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Query\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `_where` | `string` | Yes | Data entities information. |\n| `_fields` | `string` | Yes | Data entities fields. |\n| `profileIdValue` | `string` | Yes | Customer profile ID used to retrieve their contact information. |\n| `_schema` | `string` | Yes | Master Data version. |\n\n> ℹ️ It is also possible to use Pagination and Sort as described in the [Master Data V2 Search API](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/search) documentation. \n \n\n---\n\n### Response\n\n``` json\n[\n {\n \"firstName\": \"Rafael\",\n \"lastName\": \"Silva\",\n \"email\": \"rafael.silva@example.com\"\n },\n {\n \"firstName\": \"Carolina\",\n \"lastName\": \"Mendes\",\n \"email\": \"carolina.mendes@example.com\"\n },\n {\n \"firstName\": \"Lucas\",\n \"lastName\": \"Oliveira\",\n \"email\": \"lucas.oliveira@example.com\"\n }\n]\n\n ```\n\n| **Field** | Type | **Description** |\n| --- | --- | --- |\n| `firstName` | `string` | User first name. |\n| `lastName` | `string` | User last name. |\n| `email` | `string` | User email. |" - }, - "response": [] - } - ], - "description": "Contacts is a list of the people who receive store's shipments. The contact for each order is distinct from the person who placed the order, so when a shopper is placing the order, they need to inform who will be the receiver from the aforementioned contacts.\n\nThese endpoints manage contact information." - }, - { - "name": "Buying Policies", - "item": [ - { - "name": "Dimensions", - "item": [ - { - "name": "Create Dimension", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{appKey}}" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{appToken}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions" - ] - }, - "description": "This endpoint creates a new authorization dimension with its associated rules.\n\nDimensions contain an `unitId` field that allows grouping of dimensions by units or business areas, enabling more granular authorization control. This field is automatically filled based on the unit relative to the user creating the dimension.\n\nIf you make this request using an appKey/appToken pair, you must explicitly send the `unitId` field in the request body root.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Request body\n\n``` json\n{\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the dimension. |\n| `requireAllRulesAcceptance` | `boolean` | Yes | Whether all listed rules must be accepted. If false, the first rule aproval would cause the dimension to be aproved. Always `true` for ODP. |\n| `unitId` | `string` | No | Identifier of the organization unit this dimension belongs to. Each unit can have one dimension. This field is required when using `appKey/appToken` authentication. |\n| `priority` | `number` | Yes | Priority of the dimension. Defines the order of application: lower numbers are evaluated first. Since each unit has a single dimension, this value is fixed as 1 by default. |\n| `ruleCollection` | `array of objects` | Yes | List of rules that define conditions and actions. |\n| └─ `name` | `string` | Yes | Name of the rule. |\n| └─ `priority` | `number` | Yes | Rule priority. Lower numbers are evaluated first. evaluation. |\n| └─ `trigger` | `object` | Yes | Defines the condition and effect that trigger the rule. |\n| └─ `condition` | `object` | Yes | Condition that must be met to trigger the rule. |\n| └─── `conditionType` | `number` | Yes | Type of condition. For ODP, type `2` is recommended, because it can deal with many different use cases. Type `2` defines that the rule condition is set by an expression (see field `expression`). |\n| └─── `description` | `string` | Yes | Description of the condition. |\n| └─── `expression` | `string` | Yes | Expression that defines the condition logic. |\n| └── `effect` | `object` | Yes | Effect to apply when the condition is met. |\n| └─── `description` | `string` | Yes | Description of the effect. |\n| └─── `effectType` | `number` | Yes | Type of effect Possible values are: `0` (approve), `1` (deny) or `2` (pending, which means it require manual aproval/denial). |\n| └`scoreInterval` | `object` | Yes | Defines acceptance and denial thresholds. The values are fixed as accept: 10 and deny: 5. |\n| └── `accept` | `number` | Yes | Minimum score required to accept the rule. Fixed at `10`. |\n| └── `deny` | `number` | Yes | Maximum score to deny the rule. Fixed at `5`. |\n| └─ `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. Supports both `Unit` and `User` authorizers. |\n| └── `requireAllApprovals` | `boolean` | Yes | Condition that makes all authorizers approvals to be required. |\n| └── `authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| └─── `type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| └─── `id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response Example\n\n``` json\n{\n \"id\": \"c20ececf-660f-4656-a802-9ba607e3585b\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - api.vtexinternal.com.br\",\n \"unitId\": \"Tech\",\n \"status\": null,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"ad7742c2-8916-4bd1-86b3-b81f21f9db7e\",\n \"name\": \"Rule Monitoring test\",\n \"status\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Condition Description\",\n \"lessThan\": 90,\n \"greatherThan\": 10,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Efect Description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-10T19:11:14.7103786Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the created dimension. |\n| `name` | `string` | Name of the authorization dimension. |\n| `unitId` | `string` | Identifier of the business unit this dimension belongs to. |\n| If this field is not provided in the request body, the value will default to the business unit associated with the user token from the `VtexIdclientAutCookie`. | | |\n| `status` | `string` | Current status of the dimension (`null`, `accepted`, `denied`, `pending` and `ignored`). |\n| `priority` | `integer` | Execution priority of the dimension. Lower numbers are evaluated first. Since all dimensions must be evaluated either way, priority may be hardcoded to `1` for all dimensions. |\n| `shouldSimulate` | `boolean` | If true, the dimension is simulated and not enforced. |\n| `ruleCollection` | `array` | Collection of rules contained in this dimension. |\n| └─ `name` | `string` | Rule name. |\n| └─ `status` | `string` | Rule status (can be null). |\n| └─ `doId` | `string` | Optional ID of a Decision Object. |\n| └─ `priority` | `integer` | Evaluation priority for the rule. |\n| └─ `trigger` | `object` | Contains the trigger condition and effect logic. |\n| └── `conditionType` | `integer` | Type of condition (e.g., `threshold`, `expression`). |\n| └── `description` | `string` | Description of the condition. |\n| └── `lessThan` | `number` | Optional upper threshold value. |\n| └── `greatherThan` | `number` | Optional lower threshold value. |\n| └─ `effect` | `integer` | Timeout in milliseconds for the rule. |\n| └── `description` | `string` | Description of the effect. |\n| └── `effectType` | `integer` | Type of effect (e.g., `accept`, `deny`, `pending`). |\n| └── `funcPath` | `string` | Optional function path for custom effect logic. |\n| └─ `timeout` | `integer` | Timeout in milliseconds for the rule. |\n| └─ `notification` | `boolean` | Whether this rule should trigger a notification. |\n| └─ `scoreInterval` | `object` | Score range for accepting or denying the rule. |\n| `creationDate` | `string` | Date and time of dimension creation. |\n| `creationVersion` | `string` | Version of the system that created the dimension. |\n| `creationEnvironment` | `string` | Environment (e.g., `stable`, `beta`) where the dimension was created. |" - }, - "response": [] - }, - { - "name": "Update Dimension Information", - "request": { - "method": "PUT", - "header": [ - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "jCEtqueIsYSjKiSEW03PsdBi_ImtNSgodLOn70uhKy6FBcsa0jIsITJkdQxIQgIL4Dyc9yM_HfQtrDZOjrH-GidkiEpkenZtiqhLzkSp1C7917HlEDpIYwW4lMeZFKu2nOEmGd9u-jopZYa5n0sRV0f_G_VVkzmfUa4bQEwl2BU" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "vtexappkey-appvtex" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions", - "{{dimensionId}}" - ] - }, - "description": "This endpoint updates information about a specific dimension by its ID.\n\nDimensions contain an `unitId` \nfield that allows grouping of dimensions by units or business areas, \nenabling more granular authorization control. This field is \nautomatically filled based on the unit relative to the user creating the \ndimension.\n\nIf you make this request using an appKey/appToken pair, you must explicitly send the `unitId` field in the request body root.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Dimension identifier. |\n\n---\n\n#### Request body\n\n``` json\n{\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dynamic dimension with OpenTextField vtexcommercestable\",\n \"requireAllRulesAcceptance\": true,\n \"unitId\": \"654c12d6-6b22-4483-rt83-eb0865sdf88e\",\n \"priority\": 1,\n \"ruleCollection\": [\n {\n \"name\": \"Approve title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Approve condition description\",\n \"expression\": \"openTextField.value = '\\''approved'\\''\"\n },\n \"effect\": {\n \"description\": \"Approve condition description\",\n \"effectType\": 0\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Deny title\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Deny condition description\",\n \"expression\": \"openTextField.value = '\\''denied'\\''\"\n },\n \"effect\": {\n \"description\": \"Deny condition description\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Pending title\",\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"type\": \"unit\",\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\"\n }\n ]\n },\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"expression\": \"openTextField.value = '\\''pending'\\''\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Sequential approval title\",\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Sequential approval condition description\",\n \"expression\": \"openTextField.value = '\\''sequential-approval'\\''\"\n },\n \"effect\": {\n \"description\": \"Sequential approval condition description\",\n \"effectType\": 2\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n },\n {\n \"id\": \"5c969024-5c87-40f6-a89a-01172c5ae363\",\n \"type\": \"User\"\n }\n ]\n }\n }\n ]\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | ID of the dimension. |\n| `name` | `string` | Yes | Name of the dimension. |\n| `requireAllRulesAcceptance` | `boolean` | Yes | Whether all listed rules must be accepted. If false, the first rule aproval would cause the dimension to be aproved. Always `true` for ODP. |\n| `unitId` | `string` | No | Identifier of the business unit this dimension belongs to. This field is required when using `appKey/appToken` authentication. |\n| `priority` | `number` | Yes | Execution priority of the dimension. Lower numbers are evaluated first. Since all dimensions must be evaluated either way, priority may be hardcoded to `1` for all dimensions. |\n| `ruleCollection` | `array of objects` | Yes | List of rules that define conditions and actions. |\n| └─ `name` | `string` | Yes | Name of the rule. |\n| └─ `priority` | `number` | Yes | Rule priority. Lower numbers are evaluated first. evaluation. |\n| └─ `trigger` | `object` | Yes | Defines the condition and effect that trigger the rule. |\n| └─ `condition` | `object` | Yes | Condition that must be met to trigger the rule. |\n| └─── `conditionType` | `number` | Yes | Type of condition. For ODP, type `2` is recommended, because it can deal with many different use cases. Type `2` defines that the rule condition is set by an expression (see field `expression`). |\n| └─── `description` | `string` | Yes | Description of the condition. |\n| └─── `expression` | `string` | Yes | Expression that defines the condition logic. |\n| └── `effect` | `object` | Yes | Effect to apply when the condition is met. |\n| └─── `description` | `string` | Yes | Description of the effect. |\n| └─── `effectType` | `number` | Yes | Type of effect Possible values are: `0` (approve), `1` (deny) or `2` (pending, which means it require manual aproval/denial). |\n| └`scoreInterval` | `object` | Yes | Defines acceptance and denial thresholds. |\n| └── `accept` | `number` | Yes | Minimum score required to accept the rule. |\n| └── `deny` | `number` | Yes | Maximum score to deny the rule. |\n| └─ `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| └── `requireAllApprovals` | `boolean` | Yes | Condition that makes all authorizers approvals to be required. |\n| └── `authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| └─── `type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| └─── `id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response Example\n\n``` json\n{\n \"id\": \"c20ececf-660f-4656-a802-9ba607e3585b\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - api.vtexinternal.com.br\",\n \"unitId\": \"Tech\",\n \"status\": null,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"ad7742c2-8916-4bd1-86b3-b81f21f9db7e\",\n \"name\": \"Rule Monitoring test\",\n \"status\": null,\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Condition Description\",\n \"lessThan\": 90,\n \"greatherThan\": 10,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Efect Description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-10T19:11:14.7103786Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | ID of the created dimension. |\n| `name` | `string` | Name of the authorization dimension. |\n| `unitId` | `string` | Identifier of the business unit this dimension belongs to. |\n| If this field is not provided in the request body, the value will default to the business unit associated with the user token from the `VtexIdclientAutCookie`. | | |\n| `status` | `string` | Current status of the dimension (`null`, `accepted`, `denied`, `pending` and `ignored`). |\n| `priority` | `integer` | Execution priority of the dimension. Lower numbers are evaluated first. |\n| `shouldSimulate` | `boolean` | If true, the dimension is simulated and not enforced. |\n| `ruleCollection` | `array` | Collection of rules contained in this dimension. |\n| └─ `name` | `string` | Rule name. |\n| └─ `status` | `string` | Rule status (can be null). |\n| └─ `doId` | `string` | Optional ID of a Decision Object. |\n| └─ `priority` | `integer` | Evaluation priority for the rule. |\n| └─ `trigger` | `object` | Contains the trigger condition and effect logic. |\n| └── `conditionType` | `integer` | Type of condition (e.g., `threshold`, `expression`). |\n| └── `description` | `string` | Description of the condition. |\n| └── `lessThan` | `number` | Optional upper threshold value. |\n| └── `greatherThan` | `number` | Optional lower threshold value. |\n| └─ `effect` | `integer` | Timeout in milliseconds for the rule. |\n| └── `description` | `string` | Description of the effect. |\n| └── `effectType` | `integer` | Type of effect (e.g., `accept`, `deny`, `pending`). |\n| └── `funcPath` | `string` | Optional function path for custom effect logic. |\n| └─ `timeout` | `integer` | Timeout in milliseconds for the rule. |\n| └─ `notification` | `boolean` | Whether this rule should trigger a notification. |\n| └─ `scoreInterval` | `object` | Score range for accepting or denying the rule. |\n| `creationDate` | `string` | Date and time of dimension creation. |\n| `creationVersion` | `string` | Version of the system that created the dimension. |\n| `creationEnvironment` | `string` | Environment (e.g., `stable`, `beta`) where the dimension was created. |" - }, - "response": [] - }, - { - "name": "Get Dimensions Information", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-OANE}}" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-OANE}}" - } - ], - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions" - ] - }, - "description": "This endpoint retrieves a list with dimensions information.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n---\n\n### Response body\n\n``` json\n[\n {\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test\",\n \"unitId\": null,\n \"status\": null,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"36f6fa52-231c-4a16-963d-f2347cebae60\",\n \"name\": \"Rule Monitoring 1 - Rule CRUD test\",\n \"status\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Rule Monitoring 1 - Rule CRUD test- Description\",\n \"lessThan\": 30.0,\n \"greatherThan\": 0.01,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Rule Monitoring 1 - Rule CRUD test - Effect Description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 5000,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"id\": \"a2cd4605-1765-4e95-80e8-018a3223e2be\",\n \"name\": \"Rule Monitoring test\",\n \"status\": null,\n \"priority\": 2,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Condition Description\",\n \"lessThan\": 90.0,\n \"greatherThan\": 10.0,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Efect Description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-16T17:01:42.0989019Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the dimension. |\n| `name` | `string` | Name of the dimension. |\n| `unitId` | `string` | Identifier of the organizational unit this dimension belongs to. |\n| `status` | `string` | Status of the dimension. Can be used to control activation. |\n| `priority` | `number` | Execution priority of the dimension. Lower numbers are evaluated first. |\n| `shouldSimulate` | `boolean` | Indicates if the rules should be simulated instead of enforced. |\n| `ruleCollection` | `array of objects` | List of rules contained within the dimension. |\n| `ruleCollection.id` | `string` | Unique identifier of the rule. |\n| `ruleCollection.name` | `string` | Name of the rule. |\n| `ruleCollection.status` | `string` | Current status of the rule. |\n| `ruleCollection.priority` | `number` | Rule execution priority within the dimension. |\n| `ruleCollection.trigger.condition.conditionType` | `number` | Type of the condition logic (e.g., numerical range, expression). |\n| `ruleCollection.trigger.condition.description` | `string` | Description of the condition being evaluated. |\n| `ruleCollection.trigger.condition.lessThan` | `number` | Maximum value allowed for validation. |\n| `ruleCollection.trigger.condition.greatherThan` | `number` | Minimum value allowed for validation. |\n| `ruleCollection.trigger.condition.expression` | `string` | Expression to evaluate if applicable. |\n| `ruleCollection.trigger.effect.description` | `string` | Description of the effect applied if condition is met. |\n| `ruleCollection.trigger.effect.effectType` | `number` | Type of effect to apply (e.g., accept, deny, pending). |\n| `ruleCollection.timeout` | `number` | Time in milliseconds to wait for rule evaluation. |\n| `ruleCollection.notification` | `boolean` | Whether a notification should be triggered. |\n| `ruleCollection.scoreInterval.accept` | `number` | Minimum score required to accept the order. Default is `51`. |\n| `ruleCollection.scoreInterval.deny` | `number` | Maximum score allowed to deny the order. Default is `49`. |\n| `creationDate` | `string` | Date when the dimension was created (ISO 8601). |\n| `creationVersion` | `string` | Version of the system at creation time. |\n| `creationEnvironment` | `string` | Environment in which the dimension was created (e.g., `stable`, `beta`). |" - }, - "response": [] - }, - { - "name": "Delete Dimension", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-OANE}}" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-OANE}}" - } - ], - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions", - "{{dimensionId}}" - ] - }, - "description": "This endpoint deletes a specific dimension by its ID.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Dimension identifier. |\n\n---\n\n### Response body\n\n``` json\n{}\n\n ```" - }, - "response": [] - } - ], - "description": "A dimension is a container that groups authorization rules for a specific organization unit. All buying policies (rules) belonging to that unit are stored within this single dimension. Dimensions are also known as \"buying policy groups\"." - }, - { - "name": "Rules", - "item": [ - { - "name": "Create Dimension Rule", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Cookie", - "value": "VtexIdclientAutCookie={{your_token}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions", - "{{dimensionId}}", - "rules" - ] - }, - "description": "This endpoint registers a new diumension rule.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | Unique identifier of the rule. |\n| `name` | `string` | Yes | Name of the rule. |\n| `priority` | `number` | Yes | Execution priority of the rule within the dimension. |\n| `trigger.condition.conditionType` | `number` | Yes | Type of condition logic (e.g., numerical range, expression). |\n| `trigger.condition.description` | `string` | Yes | Description of the condition being evaluated. |\n| `trigger.condition.expression` | `string` | No | Expression used for evaluation, if applicable. |\n| `trigger.effect.description` | `string` | Yes | Description of the effect to be applied if condition is met. |\n| `trigger.effect.effectType` | `number` | Yes | Type of effect (e.g., accept, deny, pending). |\n| `timeout` | `number` | Yes | Maximum time (ms) allowed for rule evaluation. |\n| `notification` | `boolean` | Yes | Whether a notification should be triggered if the rule is evaluated. |\n| `scoreInterval.accept` | `number` | Yes | Minimum score required to accept the rule. |\n| `scoreInterval.deny` | `number` | Yes | Maximum score allowed to deny the rule. |\n| `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| `authorizationData.requireAllApprovals` | `boolean` | No | Condition that makes all authorizers approvals to be required. |\n| `authorizationData.authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| `authorizationData.authorizers[].type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| `authorizationData.authorizers[].id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response\n\n``` json\n[\n {\n \"id\":\"202cd02c-e36f-4f79-85f4-91210fac8b98\",\n \"name\":\"Order cannot exceed budget\",\n \"status\":null,\n \"doId\":null,\n \"priority\":1,\n \"trigger\":{\n \"condition\":{\n \"conditionType\":2,\n \"description\":\"JSONata Rule\",\n \"lessThan\":null,\n \"greatherThan\":null,\n \"expression\":\"budgetData.budgetAllocations.budgetBalance.remaining < 0\"\n },\n \"effect\":{\n \"description\":\"Send Order Auth update event\",\n \"effectType\":2,\n \"funcPath\":null\n }\n },\n \"timeout\":5000,\n \"notification\":false,\n \"scoreInterval\":{\n \"accept\":51,\n \"deny\":49\n }\n }\n]\n\n ```\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| `id` | `string` | Rule identifier. |\n| `name` | `string` | Name of the rule. |\n| `status` | `string` | Status of the rule. |\n| `doId` | `string` | Deployment object ID (optional). |\n| `priority` | `number` | Rule evaluation priority. |\n| `trigger` | `object` | Trigger information. |\n| └─ `condition` | `object` | Condition that triggers the rule evaluation. |\n| └── `conditionType` | `number` | Type of condition. |\n| └── `description` | `string` | Description of the condition. |\n| └── `expression` | `string` | JSONata expression for rule condition evaluation. |\n| └─ `effect` | `object` | Effect applied when the condition is satisfied. |\n| └── `description` | `string` | Description of the effect. |\n| └── `effectType` | `number` | Type of effect. |\n| └── `funcPath` | `string` | Optional path to a function to be executed. |\n| `timeout` | `number` | Timeout in milliseconds. |\n| `notification` | `boolean` | Whether to trigger a notification. |\n| `scoreInterval` | `object` | Score interval information. |\n| └─ `accept` | `number` | Score interval to automatically accept. |\n| └─ `deny` | `number` | Score interval to automatically deny. |" - }, - "response": [] - }, - { - "name": "Update All Dimension Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-OANE}}" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-OANE}}" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"Accounting Limit - Max spend limit per order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value >= 10000 ($100)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value >= 10000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $100 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Max spend limit per order line\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 1000 ($10)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $max(items.sellingPrice + items.tax + items.customTax) >= 1000\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with value above $10 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Minimum order value required to place an order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value below 100 ($1)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value <= 100\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value below $1\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value above $50 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $.value > 5000 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value above $50 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order line for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value above $5 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $max(items.sellingPrice + items.tax + items.customTax) > 500 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders that contains items with value above $5 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max spend limit per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 30000 ($300) for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.sellingPrice + items.tax + items.customTax) >= 300000\"\n },\n \"effect\": {\n \"description\": \"Order items for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 that exceed $300 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Only one approver\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"User 8f6b3712-4c05-4ce5-8057-63fd0d69a587 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 15000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions", - "{{dimensionId}}", - "rules" - ] - }, - "description": "This endpoint updates all dimension rules.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n[\n {\n \"name\": \"Accounting Limit - Max spend limit per order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value >= 10000 ($100)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value >= 10000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $100 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Max spend limit per order line\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 1000 ($10)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $max(items.sellingPrice + items.tax + items.customTax) >= 1000\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with value above $10 need to be manually approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"0aac12d6-6b22-4483-bd83-eb086c42888e\",\n \"type\": \"Unit\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Accounting Limit - Minimum order value required to place an order\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value below 100 ($1)\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value <= 100\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value below $1\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders with value above $50 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $.value > 5000 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders with value above $50 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"Address Limits - Max spend limit per order line for a specific address\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value above $5 with custom address 12334048475146857\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and ($addr := \\\"12334048475146857\\\"; $isThisAddr := $addr in customData.customFields[linkedEntity.type=\\\"address\\\"].linkedEntity.id; $isThisAddr ? $max(items.sellingPrice + items.tax + items.customTax) > 500 : true)\"\n },\n \"effect\": {\n \"description\": \"Automatically deny orders that contains items with value above $5 with custom address 12334048475146857\",\n \"effectType\": 1\n }\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max spend limit per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with value >= 30000 ($300) for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.sellingPrice + items.tax + items.customTax) >= 300000\"\n },\n \"effect\": {\n \"description\": \"Order items for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 that exceed $300 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Limit - Max number of units per line for a user\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Match orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and purchaseAgentData.purchaseAgents.userId = \\\"8f6b3712-4c05-4ce5-8057-63fd0d69a587\\\" and $max(items.quantity) >= 100\"\n },\n \"effect\": {\n \"description\": \"Orders that contains items with more than 100 of quantity for purchase agent 8f6b3712-4c05-4ce5-8057-63fd0d69a587 require approval\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Only one approver\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"User 8f6b3712-4c05-4ce5-8057-63fd0d69a587 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 15000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n },\n {\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n ]\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | `string` | Yes | Name of the rule. |\n| `priority` | `number` | Yes | Priority of the rule within the dimension. Lower numbers are evaluated first. |\n| `trigger.condition.conditionType` | `number` | Yes | Type of the condition logic (e.g., range, expression). |\n| `trigger.condition.description` | `string` | Yes | Description of the condition being evaluated. |\n| `trigger.condition.expression` | `string` | No | Expression to evaluate, if applicable. |\n| `trigger.effect.description` | `string` | Yes | Description of the effect applied when the condition is met. |\n| `trigger.effect.effectType` | `number` | Yes | Type of effect applied (e.g., 1 = deny, 2 = accept). |\n| `scoreInterval.accept` | `number` | Yes | Minimum score required to accept the order. |\n| `scoreInterval.deny` | `number` | Yes | Maximum score allowed to deny the order. |\n| `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| `authorizationData.requireAllApprovals` | `boolean` | Yes | Condition that makes all authorizers approvals to be required. |\n| `authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| `authorizers[].type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| `authorizers[].id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response body\n\n``` json\n{\n \"id\": \"c391298c-6c74-431f-a6f8-a8ae0e5bf420\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - Update\",\n \"unitId\": null,\n \"status\": null,\n \"priority\": 2,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"bf2ed52d-b128-4099-b3e3-43153e85b463\",\n \"name\": \"New rule\",\n \"status\": null,\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"New Rule\",\n \"lessThan\": 30.0,\n \"greatherThan\": 0.01,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"New Rule\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 5000,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n ],\n \"creationDate\": \"2025-06-16T17:01:42.0989019Z\",\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the dimension. |\n| `name` | `string` | Name of the dimension. |\n| `unitId` | `string` | Identifier of the organizational unit this dimension belongs to. |\n| `status` | `string` | Status of the dimension. Can be used to control activation. |\n| `priority` | `number` | Execution priority of the dimension. Lower numbers are evaluated first. |\n| `shouldSimulate` | `boolean` | Indicates if the rules should be simulated instead of enforced. |\n| `ruleCollection` | `array of objects` | List of rules contained within the dimension. |\n| `ruleCollection.id` | `string` | Unique identifier of the rule. |\n| `ruleCollection.name` | `string` | Name of the rule. |\n| `ruleCollection.status` | `string` | Current status of the rule. |\n| `ruleCollection.doId` | `string` | Identifier for Decision Object (optional). |\n| `ruleCollection.priority` | `number` | Rule execution priority within the dimension. |\n| `ruleCollection.trigger.condition.conditionType` | `number` | Type of the condition logic (e.g., numerical range, expression). |\n| `ruleCollection.trigger.condition.description` | `string` | Description of the condition being evaluated. |\n| `ruleCollection.trigger.condition.lessThan` | `number` | Maximum value allowed for validation. |\n| `ruleCollection.trigger.condition.greatherThan` | `number` | Minimum value allowed for validation. |\n| `ruleCollection.trigger.condition.expression` | `string` | Expression to evaluate if applicable. |\n| `ruleCollection.trigger.effect.description` | `string` | Description of the effect applied if condition is met. |\n| `ruleCollection.trigger.effect.effectType` | `number` | Type of effect to apply (e.g., accept, deny, pending). |\n| `ruleCollection.trigger.effect.funcPath` | `string` | Optional path to a function to execute as an effect. |\n| `ruleCollection.timeout` | `number` | Time in milliseconds to wait for rule evaluation. |\n| `ruleCollection.notification` | `boolean` | Whether a notification should be triggered. |\n| `ruleCollection.scoreInterval.accept` | `number` | Minimum score required to accept the order. |\n| `ruleCollection.scoreInterval.deny` | `number` | Maximum score allowed to deny the order. |\n| `creationDate` | `string` | Date when the dimension was created (ISO 8601). |\n| `creationVersion` | `string` | Version of the system at creation time. |\n| `creationEnvironment` | `string` | Environment in which the dimension was created (e.g., `stable`, `beta`). |" - }, - "response": [] - }, - { - "name": "Update Dimension Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-OANE}}" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-OANE}}" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions", - "{{dimensionId}}", - "rules", - "{{ruleId}}" - ] - }, - "description": "This endpoint updates a specific dimension rule.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n| `ruleId` | `string` | Yes | Identifier for the dimension rule. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"name\": \"User Approval - Many approvers\",\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Users 8f6b3712-4c05-4ce5-8057-63fd0d69a587 and 8f6b3712-4c05-4ce5-8057-63fd0d69a588 needs to approve orders above $150\",\n \"expression\": \"$.openTextField.value = 'ODP use cases' and $.value > 30000\"\n },\n \"effect\": {\n \"description\": \"Orders with value above $150 must be approved\",\n \"effectType\": 2\n }\n },\n \"authorizationData\": {\n \"requireAllApprovals\": true,\n \"authorizers\": [\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a587\",\n \"type\": \"User\"\n },\n {\n \"id\": \"8f6b3712-4c05-4ce5-8057-63fd0d69a588\",\n \"type\": \"User\"\n }\n ]\n },\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n }\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `id` | `string` | Yes | Unique identifier of the rule. |\n| `name` | `string` | Yes | Name of the rule. |\n| `priority` | `number` | Yes | Execution priority of the rule within the dimension. |\n| `trigger.condition.conditionType` | `number` | Yes | Type of condition logic (e.g., numerical range, expression). |\n| `trigger.condition.description` | `string` | Yes | Description of the condition being evaluated. |\n| `trigger.condition.expression` | `string` | No | Expression used for evaluation, if applicable. |\n| `trigger.effect.description` | `string` | Yes | Description of the effect to be applied if condition is met. |\n| `trigger.effect.effectType` | `number` | Yes | Type of effect (e.g., accept, deny, pending). |\n| `timeout` | `number` | Yes | Maximum time (ms) allowed for rule evaluation. |\n| `notification` | `boolean` | Yes | Whether a notification should be triggered if the rule is evaluated. |\n| `scoreInterval.accept` | `number` | Yes | Minimum score required to accept the rule. |\n| `scoreInterval.deny` | `number` | Yes | Maximum score allowed to deny the rule. |\n| `authorizationData` | `object` | No | Defines required authorizers and whether all must approve. |\n| `authorizationData.requireAllApprovals` | `boolean` | No | Condition that makes all authorizers approvals to be required. |\n| `authorizationData.authorizers` | `array of objects` | Yes | List of entities that can authorize the action. |\n| `authorizationData.authorizers[].type` | `string` | Yes | Type of authorizer (e.g., `unit`, `user`). |\n| `authorizationData.authorizers[].id` | `string` | Yes | Unique identifier of the authorizer. |\n\n---\n\n### Response body\n\n``` json\n{\n \"id\": \"bf2ed52d-b128-4099-b3e3-43153e85b463\",\n \"name\": \"Updated rule\",\n \"status\": null,\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 1,\n \"description\": \"Updated Rule\",\n \"lessThan\": 30.0,\n \"greatherThan\": 0.01,\n \"expression\": null\n },\n \"effect\": {\n \"description\": \"Updated Rule\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 5000,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the rule. |\n| `name` | `string` | Name of the rule. |\n| `status` | `string` | Current status of the rule. |\n| `doId` | `string` | Identifier for Decision Object (optional). |\n| `priority` | `number` | Execution priority of the rule within the dimension. |\n| `trigger.condition.conditionType` | `number` | Type of condition logic (e.g., numerical range, expression). |\n| `trigger.condition.description` | `string` | Description of the condition being evaluated. |\n| `trigger.condition.lessThan` | `number` | Maximum value allowed for the condition. |\n| `trigger.condition.greatherThan` | `number` | Minimum value allowed for the condition. |\n| `trigger.condition.expression` | `string` | Expression used for evaluation, if applicable. |\n| `trigger.effect.description` | `string` | Description of the effect to be applied if condition is met. |\n| `trigger.effect.effectType` | `number` | Type of effect (e.g., accept, deny, pending). |\n| `trigger.effect.funcPath` | `string` | Optional path to a function to execute as an effect. |\n| `timeout` | `number` | Maximum time (ms) allowed for rule evaluation. |\n| `notification` | `boolean` | Whether a notification should be triggered if the rule is evaluated. |\n| `scoreInterval.accept` | `number` | Minimum score required to accept the rule. |\n| `scoreInterval.deny` | `number` | Maximum score allowed to deny the rule. |" - }, - "response": [] - }, - { - "name": "Delete Dimension Rule", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-OANE}}" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-OANE}}" - } - ], - "url": { - "raw": "https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}", - "protocol": "https", - "host": [ - "api", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "{{accountName}}", - "authorization-dimensions", - "{{dimensionId}}", - "rules", - "{{ruleId}}" - ] - }, - "description": "This endpoint deletes a specific dimension rule.\n\n---\n\n### Request\n\n- **Method**: `DELETE`\n \n- **URL**: `https://api.vtexcommercestable.com.br/{{accountName}}/authorization-dimensions/{{dimensionId}}/rules/{{ruleId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `dimensionId` | `string` | Yes | Identifier for the authorization dimension. |\n| `ruleId` | `string` | Yes | Identifier for the dimension rule. |\n\n---\n\n### Request Body\n\n``` json\n{}\n\n ```" - }, - "response": [] - }, - { - "name": "Accept Rule", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "VtexIdclientAutCookie_qastore", - "value": "{{authCookieValue}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-qastore}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-qastore}}", - "type": "text", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"params\": {\n \"score\": 100,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "commercial-authorizations", - "{{orderAuthId}}", - "callback" - ] - }, - "description": "This endpoint accepts a dimension rule.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{accountName}}.myvtex.com/commercial-authorizations/{{orderAuthId}}/callback`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `orderAuthId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"params\": {\n \"score\": 100,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| params | Object | Yes | Container for the parameters of the request. |\n| params.score | Integer | Yes | Score value to be assigned. Acceptance value depends on the rule configuration. In general, a `score` of `100` accepts the rule. |\n| params.dimensionId | String | Yes | Identifier of the dimension being evaluated. |\n| params.ruleId | String | Yes | Identifier of the rule associated with the dimension. |\n\n### Response body\n\n``` json\n{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"accepted\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0.0,\n \"marketPlacePaymentValue\": 0.0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.40,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"accepted\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier of the approval request. |\n| orderId | string | Identifier of the order linked to this approval process. |\n| workflowInstanceId | string | Identifier of the workflow instance. |\n| status | string | Current approval status (e.g., `accepted`). |\n| units | array | List of unit identifiers related to the approval request. |\n| callbackEndpoint | string | Callback URL for order authorization status updates. |\n| totalOrderValueDesiredBySeller | number | Total value of the order as expected by the seller. |\n| marketPlacePaymentValue | number | Value of the order payment in the marketplace. |\n| itemCollection | array of object | List of items in the order. |\n| itemCollection\\[\\].id | string | Unique identifier of the item in the approval process. |\n| itemCollection\\[\\].sku | string | SKU identifier of the item. |\n| itemCollection\\[\\].price | number | Item price. |\n| itemCollection\\[\\].totalSystemDiscount | number | Discount automatically applied by the system. |\n| itemCollection\\[\\].totalManualDiscount | number | Discount manually applied. |\n| itemCollection\\[\\].quantity | integer | Quantity of the item. |\n| itemCollection\\[\\].additionalInfo.commercialCondition | string | Commercial condition identifier. |\n| additionalInfo | object | Extra information related to the request. |\n| additionalInfo.userProfileId | string | Identifier of the user profile linked to this approval request. |\n| dimensionStatus | array of object | Approval status details per dimension. |\n| dimensionStatus\\[\\].id | string | Unique identifier of the dimension status record. |\n| dimensionStatus\\[\\].name | string | Dimension name. |\n| dimensionStatus\\[\\].unitId | string | Unit identifier related to this dimension. |\n| dimensionStatus\\[\\].userProfileId | string | User profile identifier related to this dimension. |\n| dimensionStatus\\[\\].status | string | Current status of the dimension (e.g., `accepted`). |\n| dimensionStatus\\[\\].score | integer | Score assigned to the dimension. |\n| dimensionStatus\\[\\].priority | integer | Priority of this dimension (lower = higher priority). |\n| dimensionStatus\\[\\].shouldSimulate | boolean | Indicates if this dimension should be simulated before application. |\n| dimensionStatus\\[\\].ruleCollection | array of object | Rules applied to this dimension. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].id | string | Unique identifier of the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].name | string | Rule name. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].status | string | Current status of the rule (e.g., `accepted`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].doId | string | Optional decision object identifier. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].score | integer | Score assigned to the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].priority | integer | Rule priority (lower = higher priority). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.condition | object | Condition that triggers the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.conditionType | integer | Type of condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.description | string | Human-readable description of the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.expression | string | Expression used to evaluate the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect | object | Effect applied when the condition is met. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.description | string | Description of the effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.effectType | integer | Type of effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].timeout | integer | Timeout (in ms) for rule evaluation. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].notification | boolean | Indicates if notifications are enabled for this rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval | object | Score thresholds for decision making. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.accept | integer | Minimum score for acceptance. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.deny | integer | Maximum score for denial. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData | object | Data related to authorization requirements. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.requireAllApprovals | boolean | If `true`, all authorizers must approve. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers | array of object | List of authorizers for the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].id | string | Identifier of the authorizer. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].type | string | Type of authorizer (e.g., `Unit`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].authorizationDate | string (iso 8601) | Date when authorization occurred. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserAuthorized | boolean | Whether the current user is authorized. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserNextAuthorizer | boolean | Whether the current user is the next required authorizer. |\n| dimensionStatus\\[\\].creationDate | string | Timestamp of when the dimension status was created. |\n| dimensionStatus\\[\\].creationVersion | string | Version of the system at creation time. |\n| dimensionStatus\\[\\].creationEnvironment | string | Environment in which the record was created (e.g., `stable`). |\n| dimensionStatus\\[\\].requireAllRulesAcceptance | boolean | If `true`, all rules must be accepted for approval. |\n| creationVersion | string | Version of the system at creation time. |\n| creationEnvironment | string | Environment in which the approval request was created (e.g., `stable`). |\n| userProfileId | string | Identifier of the user profile that created the approval request. |" - }, - "response": [ - { - "name": "200 OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "VtexIdclientAutCookie_qastore", - "value": "{{authCookieValue}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-qastore}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-qastore}}", - "type": "text", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"params\": {\n \"score\": 100,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "commercial-authorizations", - "{{orderAuthId}}", - "callback" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [ - { - "expires": "Invalid Date", - "domain": "", - "path": "" - } - ], - "body": "{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"accepted\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0,\n \"marketPlacePaymentValue\": 0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.4,\n \"totalManualDiscount\": 0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"accepted\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"accepted\",\n \"doId\": null,\n \"score\": 100,\n \"authorizedEmails\": [],\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}" - } - ] - }, - { - "name": "Deny Rule", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "VtexIdclientAutCookie_qastore", - "value": "{{authCookieValue}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-qastore}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-qastore}}", - "type": "text", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"params\": {\n \"score\": 0,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "commercial-authorizations", - "{{orderAuthId}}", - "callback" - ] - }, - "description": "This endpoint denies a dimension rule.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{account}}.myvtex.com/commercial-authorizations/{{orderAuthId}}/callback`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n### Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `orderAuthId` | `string` | Yes | Identifier for the authorization dimension. |\n\n---\n\n### Request Body\n\n``` json\n{\n \"params\": {\n \"score\": 0,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| params | Object | Yes | Container for the parameters of the request. |\n| params.score | Integer | Yes | Score value to be assigned. Denial value depends on the rule configuration. In general, a `score` of `0` denies the rule. |\n| params.dimensionId | String | Yes | Identifier of the dimension being evaluated. |\n| params.ruleId | String | Yes | Identifier of the rule associated with the dimension. |\n\n### Response Body\n\n``` json\n{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"denied\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0,\n \"marketPlacePaymentValue\": 0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.4,\n \"totalManualDiscount\": 0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier of the approval request. |\n| orderId | string | Identifier of the order linked to this approval process. |\n| workflowInstanceId | string | Identifier of the workflow instance. |\n| status | string | Current denial status (e.g., `denied`). |\n| units | array | List of unit identifiers related to the approval request. |\n| callbackEndpoint | string | Callback URL for order authorization status updates. |\n| totalOrderValueDesiredBySeller | number | Total value of the order as expected by the seller. |\n| marketPlacePaymentValue | number | Value of the order payment in the marketplace. |\n| itemCollection | array of object | List of items in the order. |\n| itemCollection\\[\\].id | string | Unique identifier of the item in the approval process. |\n| itemCollection\\[\\].sku | string | SKU identifier of the item. |\n| itemCollection\\[\\].price | number | Item price. |\n| itemCollection\\[\\].totalSystemDiscount | number | Discount automatically applied by the system. |\n| itemCollection\\[\\].totalManualDiscount | number | Discount manually applied. |\n| itemCollection\\[\\].quantity | integer | Quantity of the item. |\n| itemCollection\\[\\].additionalInfo.commercialCondition | string | Commercial condition identifier. |\n| additionalInfo | object | Extra information related to the request. |\n| additionalInfo.userProfileId | string | Identifier of the user profile linked to this approval request. |\n| dimensionStatus | array of object | Approval status details per dimension. |\n| dimensionStatus\\[\\].id | string | Unique identifier of the dimension status record. |\n| dimensionStatus\\[\\].name | string | Dimension name. |\n| dimensionStatus\\[\\].unitId | string | Unit identifier related to this dimension. |\n| dimensionStatus\\[\\].userProfileId | string | User profile identifier related to this dimension. |\n| dimensionStatus\\[\\].status | string | Current status of the dimension (e.g., `denied`). |\n| dimensionStatus\\[\\].score | integer | Score assigned to the dimension. |\n| dimensionStatus\\[\\].priority | integer | Priority of this dimension (lower = higher priority). |\n| dimensionStatus\\[\\].shouldSimulate | boolean | Indicates if this dimension should be simulated before application. |\n| dimensionStatus\\[\\].ruleCollection | array of object | Rules applied to this dimension. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].id | string | Unique identifier of the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].name | string | Rule name. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].status | string | Current status of the rule (e.g., `denied`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].doId | string | Optional decision object identifier. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].score | integer | Score assigned to the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].priority | integer | Rule priority (lower = higher priority). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.condition | object | Condition that triggers the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.conditionType | integer | Type of condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.description | string | Human-readable description of the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.expression | string | Expression used to evaluate the condition. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect | object | Effect applied when the condition is met. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.description | string | Description of the effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].trigger.effect.effectType | integer | Type of effect. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].timeout | integer | Timeout (in ms) for rule evaluation. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].notification | boolean | Indicates if notifications are enabled for this rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval | object | Score thresholds for decision making. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.accept | integer | Minimum score for acceptance. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].scoreInterval.deny | integer | Maximum score for denial. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData | object | Data related to authorization requirements. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.requireAllApprovals | boolean | If `true`, all authorizers must approve. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers | array of object | List of authorizers for the rule. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].id | string | Identifier of the authorizer. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].type | string | Type of authorizer (e.g., `Unit`). |\n| dimensionStatus\\[\\].ruleCollection\\[\\].authorizationData.authorizers\\[\\].authorizationDate | string (iso 8601) | Date when authorization occurred. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserAuthorized | boolean | Whether the current user is authorized. |\n| dimensionStatus\\[\\].ruleCollection\\[\\].isUserNextAuthorizer | boolean | Whether the current user is the next required authorizer. |\n| dimensionStatus\\[\\].creationDate | string | Timestamp of when the dimension status was created. |\n| dimensionStatus\\[\\].creationVersion | string | Version of the system at creation time. |\n| dimensionStatus\\[\\].creationEnvironment | string | Environment in which the record was created (e.g., `stable`). |\n| dimensionStatus\\[\\].requireAllRulesAcceptance | boolean | If `true`, all rules must be accepted for approval. |\n| creationVersion | string | Version of the system at creation time. |\n| creationEnvironment | string | Environment in which the approval request was created (e.g., `stable`). |\n| userProfileId | string | Identifier of the user profile that created the approval request. |" - }, - "response": [ - { - "name": "200 OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "VtexIdclientAutCookie_qastore", - "value": "{{authCookieValue}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey-qastore}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken-qastore}}", - "type": "text", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"params\": {\n \"score\": 0,\n \"dimensionId\": \"{{dimensionId}}\",\n \"ruleId\": \"{{ruleId}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/commercial-authorizations/{{orderAuthId}}/callback", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "commercial-authorizations", - "{{orderAuthId}}", - "callback" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"id\": \"6f6d7472-e4d0-4004-a1d2-6d4ccc7e696a\",\n \"orderId\": \"1557790634097-01\",\n \"workflowInstanceId\": \"9f578326-ec7b-42e5-9e4f-212a07aa5697\",\n \"status\": \"denied\",\n \"units\": [\n \"f9078fd1-3c6d-4103-8658-77155edaf940\"\n ],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1557790634097-01/callback?an=b2bfaststoredev\",\n \"totalOrderValueDesiredBySeller\": 0,\n \"marketPlacePaymentValue\": 0,\n \"itemCollection\": [\n {\n \"id\": \"77a7b09f-da69-4392-8ac6-7cee0acf7e0f\",\n \"sku\": \"88\",\n \"price\": 33.99,\n \"totalSystemDiscount\": -3.4,\n \"totalManualDiscount\": 0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"d88e44b1-2791-4770-a9e3-d0fdc1a1c1fd\",\n \"name\": \"Compras faturamento B2B - vtexcommercestable\",\n \"unitId\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\",\n \"status\": \"denied\",\n \"score\": 100,\n \"priority\": 1,\n \"shouldSimulate\": false,\n \"ruleCollection\": [\n {\n \"id\": \"2448612d-bbbf-4bc5-8b8c-b1c3f4f638e3\",\n \"name\": \"Pending title\",\n \"status\": \"denied\",\n \"doId\": null,\n \"score\": 100,\n \"authorizedEmails\": [],\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Pending condition description\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"$count(budgetData.unitAllocations.*[budgetId='0198f73a-68a1-7296-ae88-ffe9586c3528' and allocationId='0198f73a-6d98-758f-8f1d-a2a3bc23d48c' and allocationBalance.remaining <= $$.value]) > 0\"\n },\n \"effect\": {\n \"description\": \"Pending condition description\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 0,\n \"notification\": false,\n \"scoreInterval\": {\n \"accept\": 51,\n \"deny\": 49\n },\n \"authorizationData\": {\n \"requireAllApprovals\": false,\n \"authorizers\": [\n {\n \"id\": \"f9078fd1-3c6d-4103-8658-77155edaf940\",\n \"type\": \"Unit\",\n \"authorizationDate\": \"2025-08-29T19:07:52.4705074Z\"\n }\n ]\n },\n \"isUserAuthorized\": true,\n \"isUserNextAuthorizer\": true\n }\n ],\n \"creationDate\": \"2025-08-29T19:07:42.7281514Z\",\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"requireAllRulesAcceptance\": false\n }\n ],\n \"creationVersion\": \"2.1.5\",\n \"creationEnvironment\": \"stable\",\n \"userProfileId\": \"69c9e480-850b-11f0-b37f-c3162b6f2b91\"\n}" - } - ] - } - ], - "description": "A condition–action pair inside a dimension that defines how the system evaluates and authorizes operations. \n \nEach rule includes a condition (`trigger.condition`) and an effect (`trigger.effect`), determining whether an action is approved, denied, or sent for manual approval.\n\nRules are also known as \"buying policies\" and are nested within dimensions (or \"buying policy groups\")." - }, - { - "name": "Order", - "item": [ - { - "name": "Place Order", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "VtexIdclientAutCookie_qastore", - "value": "{{authCookieValue}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\": [\n {\n \"id\": 2,\n \"quantity\": 2,\n \"seller\": \"1\",\n \"price\": 100,\n \"uniqueId\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n {\n \"id\": 8,\n \"quantity\": 1,\n \"seller\": \"1\",\n \"price\": 8500,\n \"uniqueId\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n }\n ],\n \"shippingData\": {{my_shippingData}},\n \"clientProfileData\": {{my_profileData}},\n \"paymentData\": {{my_paymentsDataString}},\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC2\",\n \"refId\": \"CC2\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"9b884ddc-2dbc-4443-8706-8c6a21dac219\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"home\"\n },\n \"fields\": [\n {\n \"name\": \"Desktop\",\n \"value\": \"DSK1\",\n \"refId\": \"b1d7a268-090a-4578-9bf9-22b4537851e8\"\n }\n ]\n }\n ]\n },\n \"openTextField\": {\n \"value\": \"ODP use cases\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/checkout/pub/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "checkout", - "pub", - "orders" - ] - }, - "description": "This endpoint creates a new order.\n\n---\n\n### Request\n\n- **Method**: `PUT`\n \n- **URL**: `https://{{account}}.myvtex.com/api/checkout/pub/orders`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n---\n\n### Request Body\n\n``` json\n{\n \"items\": [\n {\n \"id\": 2,\n \"quantity\": 2,\n \"seller\": \"1\",\n \"price\": 100,\n \"uniqueId\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n {\n \"id\": 8,\n \"quantity\": 1,\n \"seller\": \"1\",\n \"price\": 8500,\n \"uniqueId\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n }\n ],\n \"shippingData\": {{my_shippingData}},\n \"clientProfileData\": {{my_profileData}},\n \"paymentData\": {{my_paymentsDataString}},\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC2\",\n \"refId\": \"CC2\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"9b884ddc-2dbc-4443-8706-8c6a21dac219\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"home\"\n },\n \"fields\": [\n {\n \"name\": \"Desktop\",\n \"value\": \"DSK1\",\n \"refId\": \"b1d7a268-090a-4578-9bf9-22b4537851e8\"\n }\n ]\n }\n ]\n },\n \"openTextField\": {\n \"value\": \"ODP use cases\"\n }\n}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| items | `array of objects` | Yes | List of items included in the order. |\n| items\\[\\].id | `number` | Yes | Identifier of the item. |\n| items\\[\\].quantity | `number` | Yes | Quantity of the item being ordered. |\n| items\\[\\].seller | `string` | Yes | Seller identifier for the item. |\n| items\\[\\].price | `number` | Yes | Price of the item. |\n| items\\[\\].uniqueId | `string` | Yes | Unique identifier of the item in the cart. |\n| shippingData | `object` | Yes | Shipping information for the order. |\n| clientProfileData | `object` | Yes | Customer profile information. |\n| paymentData | `object` | Yes | Payment information. |\n| customData | `object` | No | Custom fields and apps related to the order. |\n| customData.customApps | `array of objects` | No | Custom applications data. |\n| customData.customFields | `array of objects` | No | Custom fields linked to items, orders, or addresses. |\n| customData.customFields\\[\\].linkedEntity | `object` | Yes | Entity information that the custom field is linked to. |\n| customData.customFields\\[\\].linkedEntity.type | `string` | Yes | Type of entity the custom field is linked to (e.g., `item`, `order`). |\n| customData.customFields\\[\\].linkedEntity.id | `string` | No | Identifier of the linked entity (e.g., item `uniqueId`, address `home`). |\n| customData.customFields\\[\\].fields\\[\\] | `array of objects` | Yes | List of customFields. |\n| customData.customFields\\[\\].fields\\[\\].name | `string` | Yes | Name of the custom field (e.g., `costCenter`, `PO Number`). |\n| customData.customFields\\[\\].fields\\[\\].value | `string` | Yes | Value assigned to the custom field. |\n| customData.customFields\\[\\].fields\\[\\].refId | `string` | No | Optional reference identifier for the custom field. |\n| openTextField | `object` | No | Field containing free-text information. |\n| openTextField.value | `string` | No | Value of the free-text field (e.g., \"ODP use cases\"). |\n\n---\n\n### Response Body\n\n``` json\n{\n \"orderForm\": null,\n \"transactionData\": {\n \"merchantTransactions\": [\n {\n \"id\": \"RECORRENCIACHARLIE\",\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"paymentSystem\": \"47\",\n \"bin\": null,\n \"accountId\": null,\n \"tokenId\": null,\n \"value\": 105547,\n \"referenceValue\": 105547,\n \"giftCardRedemptionCode\": null,\n \"giftCardProvider\": null,\n \"giftCardId\": null\n }\n ]\n }\n ],\n \"receiverUri\": \"https://recorrenciacharlie.vtexpayments.com.br/split/1560176581020/payments\",\n \"gatewayCallbackTemplatePath\": \"/checkout/gatewayCallback/1560176581020/{messageCode}\"\n },\n \"orders\": [\n {\n \"orderId\": \"1560176581020-01\",\n \"orderGroup\": \"1560176581020\",\n \"state\": null,\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560176581020-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 105547,\n \"items\": [\n {\n \"uniqueId\": \"ABBF87D61CB3441E97FC2527A93432AA\",\n \"id\": \"1\",\n \"productId\": \"1\",\n \"productRefId\": \"\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:52:36Z\",\n \"tax\": 0,\n \"price\": 765,\n \"listPrice\": 765,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 765,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 765,\n \"total\": 765,\n \"sellingPrices\": [\n {\n \"value\": 765,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"8BEAE818E2AE4474905B4BEF306A5E77\",\n \"id\": \"2\",\n \"productId\": \"2\",\n \"productRefId\": \"\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:54:16Z\",\n \"tax\": 0,\n \"price\": 4282,\n \"listPrice\": 4282,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 4282,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 4282,\n \"total\": 4282,\n \"sellingPrices\": [\n {\n \"value\": 4282,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"F3E0DA124887476DBB0F2C7DC0B6FE2A\",\n \"id\": \"3\",\n \"productId\": \"3\",\n \"productRefId\": \"\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:57:30Z\",\n \"tax\": 0,\n \"price\": 1000,\n \"listPrice\": 1000,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 1000,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 100,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 1000,\n \"total\": 100000,\n \"sellingPrices\": [\n {\n \"value\": 1000,\n \"quantity\": 100\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n }\n ],\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE\",\n \"logo\": \"\",\n \"minimumOrderValue\": 0\n }\n ],\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 105047\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": 0\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 500\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"userautomated24.608800099331596@mailinator.com\",\n \"firstName\": \"Postman\",\n \"lastName\": \"Test\",\n \"document\": \"20275756343\",\n \"documentType\": \"cpf\",\n \"phone\": \"+552222222222\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": false,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [],\n \"teaser\": []\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0.0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"1\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 1,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 5,\n \"listPrice\": 5,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0.0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"2\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 2,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 495,\n \"listPrice\": 495,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0.0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"3\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"pickupPoints\": [\n {\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"id\": \"1_VTEX-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_BPS-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_RIOSUL-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n }\n ],\n \"contactInformation\": []\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"id\": null,\n \"paymentSystem\": \"47\",\n \"paymentSystemName\": \"Cash\",\n \"value\": 105547,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 105547,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": null,\n \"dueDate\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentOrigin\": null\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": null,\n \"commercialConditionData\": null,\n \"giftRegistryData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"saveUserData\": false,\n \"timeZone\": \"E. South America Standard Time\",\n \"currencyCode\": \"BRL\",\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \",\",\n \"currencyGroupSeparator\": \".\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": null,\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"3\",\n \"seller\": \"1\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"productId\": \"3\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"assemblyOptions\": []\n },\n {\n \"id\": \"2\",\n \"seller\": \"1\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"productId\": \"2\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.plano-da-ana\",\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n },\n {\n \"id\": \"1\",\n \"seller\": \"1\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"productId\": \"1\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.teste-nico\",\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.plano-gold\",\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.portunus\",\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.basic\",\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n }\n ]\n },\n \"taxData\": null,\n \"customData\": null,\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"5bb299d7a91c487faece472daed48b46@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:57:30.7718345Z\",\n \"lastChange\": \"2025-09-08T16:57:32.3020624Z\",\n \"timeZoneCreationDate\": \"2025-09-08T13:57:30.7718345\",\n \"timeZoneLastChange\": \"2025-09-08T13:57:32.3020624\",\n \"isCompleted\": false,\n \"hostName\": \"recorrenciacharlie\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:57:30.5217933Z\"\n }\n ],\n \"allowMultipleDeliveries\": true\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `orderForm` | `object` | Contains the complete orderform. |\n| `transactionData` | `object` | Encapsulates data related to the payment transaction. |\n| ↳ `merchantTransactions` | `array of objects` | A list of transactions grouped by merchant. |\n| ↳- `id` | `string` | The merchant's unique identifier. |\n| ↳- `transactionId` | `string` | The unique ID for the transaction. |\n| ↳- `merchantName` | `string` | The name of the merchant. |\n| ↳- `payments` | `array of objects` | Contains details about the payment methods used. |\n| ↳-- `paymentSystem` | `string` | The identifier for the payment system used (e.g., credit card, cash). |\n| ↳-- `bin` | `number` | Card BIN (Bank Identification Number). It's the first 6 to 8 digits on a payment card. |\n| ↳-- `accountId` | `string` | The account ID. |\n| ↳-- `value` | `number` | The total value of the payment in cents. |\n| ↳-- `referenceValue` | `number` | The original or base amount of a transaction or payment. |\n| ↳-- `giftCardRedemptionCode` | `string` | The unique alphanumeric code a customer enters to apply a gift card's value to a purchase. |\n| ↳-- `giftCardProvider` | `string` | The name of the company or entity that issued the gift card. |\n| ↳-- `giftCardId` | `string` | The unique internal identifier assigned to the gift card within the payment system after it has been used. |\n| ↳- `receiverUri` | `string` | The endpoint URL for the payment receiver. |\n| ↳- `gatewayCallbackTemplatePath` | `string` | The path template for the payment gateway's callback. |\n| `orders` | `array of objects` | A list of orders generated from the cart. |\n| ↳ `orderId` | `string` | The unique identifier for this specific order. |\n| ↳ `orderGroup` | `string` | An ID that groups multiple orders from the same cart. |\n| ↳ `state` | `string` | Represents the current status of the order in the fulfillment workflow (e.g., `handling`, `shipped`). |\n| ↳ `isCheckedIn` | `boolean` | A flag that indicates if the order has been checked in at a physical location, like a store or warehouse. |\n| ↳ `sellerOrderId` | `string` | The unique identifier for the order from the seller's internal system. |\n| ↳ `storeId` | `string` | The identifier for a specific physical store, often used for in-store pickup or local fulfillment. |\n| ↳ `checkedInPickupPointId` | `null` | The ID of the pickup point where an order was physically scanned or checked in upon arrival. |\n| ↳ `value` | `number` | The total value of the order in cents. |\n| ↳ `items` | `array of objects` | A list of all items included in the order. |\n| ↳- `uniqueId` | `string` | The item unique ID. |\n| ↳- `id` | `string` | The SKU ID of the item. |\n| ↳- `productId` | `string` | The primary, unique identifier for the product in the system's catalog. |\n| ↳- `productRefId` | `string` | An optional, external reference code for the product, often used for integrations with other systems like an ERP. |\n| ↳- `refId` | `string` | A reference ID for the specific SKU. |\n| ↳- `ean` | `string` | The EAN (European Article Number), which is the standardized barcode number used globally for retail products. |\n| ↳- `name` | `string` | The display name of the item. |\n| ↳- `skuName` | `string` | The display name for the specific SKU. |\n| ↳- `modalType` | `string` | Defines the type of modal to be used in the user interface, if any. |\n| ↳- `parentItemIndex` | `number` | The index of the parent item in the cart, used when this item is part of a bundle or kit. |\n| ↳- `parentAssemblyBinding` | `string` | Specifies how this item is bound to its parent assembly or bundle. |\n| ↳- `assemblies` | `array` | A list of customizations or components selected by the customer for an assembled product. |\n| ↳- `priceValidUntil` | `string` | A timestamp indicating the expiration date and time for the item's current price. |\n| ↳- `tax` | `number` | The total tax value applied to a single unit of this item, in cents. |\n| ↳- `price` | `number` | The base price for a single unit of the item before any promotions, in cents. |\n| ↳- `listPrice` | `number` | The original price of the item before discounts (often the \"was\" price), in cents. |\n| ↳- `manualPrice` | `number` | The price manually set by a store administrator, which overrides other price calculations. |\n| ↳- `manualPriceAppliedBy` | `number` | The ID of the user or system that applied a manual price. |\n| ↳- `sellingPrice` | `number` | The final price for which a single unit of the item is sold after all calculations, in cents. |\n| ↳- `rewardValue` | `number` | The value of loyalty points or rewards associated with purchasing this item. |\n| ↳- `isGift` | `boolean` | A flag indicating if the item is marked as a gift, which can trigger options like gift wrapping. |\n| ↳- `additionalInfo` | `object` | An object containing supplementary information about the product. |\n| ↳-- `dimension` | `object` | An object containing the physical dimensions (height, width, length) and weight of the item. |\n| ↳-- `brandName` | `string` | The brand name of the product. |\n| ↳-- `brandId` | `string` | The unique identifier for the product's brand. |\n| ↳-- `offeringInfo` | `null` | Additional information related to a selected service or offering for the item. |\n| ↳-- `offeringType` | `string` | The type of service or offering associated with the item. |\n| ↳-- `offeringTypeId` | `string` | The unique identifier for the type of service or offering. |\n| ↳- `preSaleDate` | `string` | The date and time when the item will be available for pre-sale, if applicable. |\n| ↳- `productCategoryIds` | `string` | A string containing the hierarchical path of category IDs this product belongs to. |\n| ↳- `productCategories` | `object` | An object that maps the product's category IDs to their corresponding names. |\n| ↳- `quantity` | `number` | The number of units of this item in the order. |\n| ↳- `seller` | `string` | The unique identifier for the seller that is fulfilling this specific item. |\n| ↳- `sellerChain` | `array` | A list of seller IDs involved in the sale, indicating the fulfillment chain or hierarchy. |\n| ↳- `imageUrl` | `string` | The complete URL for the item's primary display image. |\n| ↳- `detailUrl` | `string` | The relative URL path to the product's detail page on the storefront. |\n| ↳- `components` | `array` | A list of components that make up this item if it's a kit with fixed parts. |\n| ↳- `bundleItems` | `array` | A list of items included as part of this bundle, often used for customizable bundles. |\n| ↳- `attachments` | `array` | A list of attachments or services added to the item by the customer, like personalization. |\n| ↳- `attachmentOfferings` | `array` | A list of available services or attachments that can be added to the item, like subscriptions. |\n| ↳-- `name` | `string` | The unique name or identifier for the attachment offering. |\n| ↳-- `required` | `boolean` | A flag indicating whether this attachment is mandatory for purchasing the item. |\n| ↳-- `schema` | `object` | An object that defines the configurable options and rules for the attachment. |\n| ↳--- `vtex.subscription.key.frequency` | `object` | Defines the rules and available options for the subscription's frequency. |\n| ↳---- `maximumNumberOfCharacters` | `number` | Specifies the maximum character length allowed for the frequency value. |\n| ↳---- `domain` | `array` | A list of the predefined, valid values that a user can select for the subscription frequency. |\n| ↳- `offerings` | `array` | A list of services or special options selected by the customer for this item. |\n| ↳- `priceTags` | `array` | Contains pricing information from promotions and taxes that affect the final price. |\n| ↳- `availability` | `string` | Indicates the stock status of the item (e.g., 'available', 'unavailable'). |\n| ↳- `measurementUnit` | `string` | The unit of measure in which the item is sold (e.g., 'kg', 'un', 'm²'). |\n| ↳- `unitMultiplier` | `number` | A factor used to convert the sold unit into a standard base unit for inventory or pricing. |\n| ↳- `manufacturerCode` | `null` | The product's identification code as provided by the manufacturer. |\n| ↳- `priceDefinition` | `object` | An object detailing how the final selling price was calculated. |\n| ↳-- `calculatedSellingPrice` | `number` | The final price of a single unit after all rules and promotions have been applied. |\n| ↳-- `total` | `number` | The total price for the item line (calculated selling price × quantity). |\n| ↳-- `sellingPrices` | `array` | A list of price points based on quantity, used for tiered pricing. |\n| ↳--- `value` | `number` | The price per unit for the specified quantity tier. |\n| ↳--- `quantity` | `number` | The minimum quantity required to qualify for this price tier. |\n| ↳-- `reason` | `null` | A description of why the price was calculated in a certain way, often for manual overrides. |\n| ↳- `taxCode` | `string` | The fiscal or tax classification code for the product. |\n| ↳ `sellers` | `array of objects` | Information about the seller(s) of the items. |\n| ↳- `id` | `string` | The unique identifier for the seller. |\n| ↳- `name` | `string` | The legal or display name of the seller. |\n| ↳- `logo` | `string` | The URL for the seller's logo. |\n| ↳- `minimumOrderValue` | `number` | The minimum value required for an order from this seller, in cents. A value of `0` means no minimum. |\n| ↳ `totals` | `array of objects` | An array summarizing the different costs of the order. |\n| ↳- `id` | `string` | Identifier for the total (e.g., `Items`, `Shipping`). |\n| ↳- `name` | `string` | The display name for the total. |\n| ↳- `value` | `number` | The monetary value for that total category. |\n| ↳ `clientProfileData` | `object` | Contains the customer's personal information. |\n| ↳- `email` | `string` | The customer's email address. |\n| ↳- `firstName` | `string` | The customer's first name. |\n| ↳- `lastName` | `string` | The customer's last name. |\n| ↳- `document` | `string` | The customer's identification document number. |\n| ↳- `documentType` | `string` | The type of personal identification document provided (e.g., 'cpf' for Brazilian individuals). |\n| ↳- `phone` | `string` | The customer's phone number. |\n| ↳- `corporateName` | `string` | The legal name of the company, if the customer is a business. |\n| ↳- `tradeName` | `string` | The commercial or trade name of the company. |\n| ↳- `corporateDocument` | `string` | The company's official registration number (e.g., CNPJ in Brazil). |\n| ↳- `stateInscription` | `string` | The state tax registration number for a business. |\n| ↳- `corporatePhone` | `string` | The primary phone number for the business. |\n| ↳- `isCorporate` | `boolean` | A flag indicating whether the customer is a corporate (business) account. |\n| ↳- `profileCompleteOnLoading` | `boolean` | A flag indicating if the customer's profile data was fully loaded upon session start. |\n| ↳- `profileErrorOnLoading` | `string` | Contains error information if the profile failed to load completely. |\n| ↳- `customerClass` | `string` | A field to classify the customer into a specific group or tier. |\n| ↳ `ratesAndBenefitsData` | `object` | Contains data about promotions, discounts, and benefits applied to the order. |\n| ↳- `rateAndBenefitsIdentifiers` | `array` | A list of identifiers for the specific promotions or benefits applied to the cart. |\n| ↳- `teaser` | `array` | A list of promotional messages or \"teasers\" related to the applied benefits. |\n| ↳ `shippingData` | `object` | Contains all shipping and delivery information. |\n| ↳- `address` | `object` | Contains the detailed information for a specific shipping address. |\n| ↳-- `addressType` | `string` | The type of address, such as 'residential' or 'commercial'. |\n| ↳-- `receiverName` | `string` | The full name of the person designated to receive the shipment. |\n| ↳-- `addressId` | `string` | The unique identifier for this address in the system. |\n| ↳-- `isDisposable` | `boolean` | A flag indicating if the address is temporary and should not be saved to the user's profile. |\n| ↳-- `postalCode` | `string` | The postal or ZIP code for the address. |\n| ↳-- `city` | `string` | The city of the address. |\n| ↳-- `state` | `string` | The state or province abbreviation. |\n| ↳-- `country` | `string` | The three-letter ISO country code. |\n| ↳-- `street` | `string` | The name of the street. |\n| ↳-- `number` | `string` | The street number of the building or house. |\n| ↳-- `neighborhood` | `string` | The neighborhood or district. |\n| ↳-- `complement` | `string` | Additional address details, such as an apartment number or building name. |\n| ↳-- `reference` | `string` | A reference point or landmark to help locate the address. |\n| ↳-- `geoCoordinates` | `array` | A list containing the geographic coordinates \\[longitude, latitude\\] for the address. |\n| ↳ `logisticsInfo` | `array of objects` | Logistics details for each item or group of items. |\n| ↳- `itemIndex` | `number` | The index of the item in the main `items` array that this logistics information applies to. |\n| ↳- `selectedSla` | `string` | The ID of the chosen shipping method. |\n| ↳- `selectedDeliveryChannel` | `string` | The chosen delivery channel. |\n| ↳- `addressId` | `string` | The ID of the address associated with this logistics entry. |\n| ↳- `slas` | `array of objects` | A list of all available shipping methods (SLAs) for this item. |\n| ↳-- `id` | `string` | The unique identifier for the shipping method. |\n| ↳-- `deliveryChannel` | `string` | The channel used for this SLA. |\n| ↳-- `name` | `string` | The display name of the shipping method (e.g., 'Normal', 'Express'). |\n| ↳-- `deliveryIds` | `array of objects` | A list of details about the courier, warehouse, and dock involved in this delivery. |\n| ↳--- `courierId` | `string` | The ID of the courier or carrier responsible for the delivery. |\n| ↳--- `warehouseId` | `string` | The ID of the warehouse where the item is sourced from. |\n| ↳--- `dockId` | `string` | The ID of the shipping dock where the item will be dispatched. |\n| ↳--- `courierName` | `string` | The display name of the courier. |\n| ↳--- `quantity` | `number` | The number of items in the shipment for this delivery leg. |\n| ↳--- `kitItemDetails` | `array` | A list containing details for each component item if the product is a kit or bundle. |\n| ↳-- `shippingEstimate` | `string` | The estimated delivery time, usually in business days (e.g., '3bd'). |\n| ↳-- `shippingEstimateDate` | `string` | The specific date the shipment is estimated to be delivered. A `null` value indicates a date was not provided. |\n| ↳-- `lockTTL` | `string` | \"Time to Live\" for the shipping quote, indicating how long the price is guaranteed. |\n| ↳-- `availableDeliveryWindows` | `array` | A list of available time slots for scheduled delivery. An empty array indicates none are offered. |\n| ↳-- `deliveryWindow` | `string` | The specific delivery window selected by the customer from the available options. |\n| ↳--- `price` | `number` | The cost of this shipping method, in cents. |\n| ↳--- `listPrice` | `number` | The original price of the shipping method before any promotions, in cents. |\n| ↳--- `tax` | `number` | The tax amount applied to the shipping cost, in cents. |\n| ↳--- `pickupStoreInfo` | `object` | Information about the pickup point, if applicable for the SLA. |\n| ↳---- `isPickupStore` | `boolean` | A flag that is `true` if this SLA is for a pickup point. |\n| ↳---- `friendlyName` | `string` | The public or display name of the pickup store (e.g., \"Main Street Store\"). |\n| ↳---- `address` | `string` | An object containing the full address of the pickup location. |\n| ↳---- `additionalInfo` | `string` | Extra instructions for the pickup (e.g., \"Go to the 2nd floor customer service desk\"). |\n| ↳---- `dockId` | `string` | The identifier for the specific dock or area where packages are handled at the pickup location. |\n| ↳--- `pickupPointId` | `string` | The unique identifier for the pickup point. |\n| ↳--- `pickupDistance` | `number` | The distance from the shipping address to the pickup point, usually in kilometers. |\n| ↳--- `transitTime` | `string` | The estimated time the package will spend in transit. |\n| ↳-- `shipsTo` | `array` | A list of country codes that this item can be shipped to. |\n| ↳-- `itemId` | `string` | The ID of the item this logistics information refers to. |\n| ↳-- `deliveryChannels` | `array of objects` | A list of available delivery channels for the item. |\n| ↳--- `id` | `string` | The identifier for the delivery channel (e.g., 'delivery', 'pickup-in-point'). |\n| ↳-- `selectedAddresses` | `array of objects` | A list of the shipping addresses selected for the order. |\n| ↳--- `addressType` | `string` | The type of address, such as 'residential' or 'commercial'. |\n| ↳--- `receiverName` | `string` | The full name of the person designated to receive the shipment. |\n| ↳--- `addressId` | `string` | The unique identifier for this address in the system. |\n| ↳--- `isDisposable` | `boolean` | A flag indicating if the address is temporary and should not be saved to the user's profile. |\n| ↳--- `postalCode` | `string` | The postal or ZIP code for the address. |\n| ↳--- `city` | `string` | The city of the address. |\n| ↳--- `state` | `string` | The state or province abbreviation. |\n| ↳--- `country` | `string` | The three-letter ISO country code. |\n| ↳--- `street` | `string` | The name of the street. |\n| ↳--- `number` | `string` | The street number of the building or house. |\n| ↳--- `neighborhood` | `string` | The neighborhood or district. |\n| ↳--- `complement` | `string` | Additional address details, such as an apartment number or building name. |\n| ↳--- `reference` | `string` | A reference point or landmark to help locate the address. |\n| ↳--- `geoCoordinates` | `array` | A list containing the geographic coordinates \\[longitude, latitude\\] for the address. |\n| ↳-- `availableAddresses` | `array` | A list of all addresses saved to the customer's profile that are available for this shipment. |\n| ↳--- `addressType` | `string` | The type of address, such as 'residential' or 'commercial'. |\n| ↳--- `receiverName` | `string` | The full name of the person designated to receive shipments at this address. |\n| ↳--- `addressId` | `string` | The unique identifier for this address in the system. |\n| ↳--- `isDisposable` | `boolean` | A flag indicating if the address is temporary and was not saved to the user's profile. |\n| ↳--- `postalCode` | `string` | The postal or ZIP code for the address. |\n| ↳--- `city` | `string` | The city of the address. |\n| ↳--- `state` | `string` | The state or province abbreviation. |\n| ↳--- `country` | `string` | The three-letter ISO country code. |\n| ↳--- `street` | `string` | The name of the street. |\n| ↳--- `number` | `string` | The street number of the building or house. |\n| ↳--- `neighborhood` | `string` | The neighborhood or district. |\n| ↳--- `complement` | `string` | Additional address details, such as an apartment number or building name. |\n| ↳--- `reference` | `string` | A reference point or landmark to help locate the address. |\n| ↳--- `geoCoordinates` | `array` | A list containing the geographic coordinates \\[longitude, latitude\\] for the address. |\n| ↳-- `pickupPoints` | `array of objects` | A list of available pickup points (stores or lockers) for the current order. |\n| ↳--- `friendlyName` | `string` | The public display name of the pickup point location. |\n| ↳--- `address` | `object` | An object containing the full address of the pickup point. |\n| ↳---- `addressType` | `string` | The type of address, which is 'pickup' for these locations. |\n| ↳---- `receiverName` | `null` | The full name of the person designated to receive the shipment. It is often `null` for pickup point addresses. |\n| ↳---- `addressId` | `string` | The unique identifier for the pickup point's address. |\n| ↳---- `isDisposable` | `boolean` | Indicates if the address is temporary for this transaction. |\n| ↳---- `postalCode` | `string` | The postal code of the pickup point. |\n| ↳---- `city` | `string` | The city where the pickup point is located. |\n| ↳---- `state` | `string` | The state where the pickup point is located. |\n| ↳---- `country` | `string` | The country where the pickup point is located. |\n| ↳---- `street` | `string` | The street name of the pickup point. |\n| ↳---- `number` | `string` | The street number of the pickup point. |\n| ↳---- `neighborhood` | `string` | The neighborhood of the pickup point. |\n| ↳---- `geoCoordinates` | `array` | The geographic coordinates \\[longitude, latitude\\] of the pickup point. |\n| ↳--- `additionalInfo` | `string` | Extra instructions for the customer regarding pickup. |\n| ↳--- `id` | `string` | The unique identifier for the pickup point itself. |\n| ↳--- `isActive` | `null` | A flag to indicate if the pickup point is currently operational. |\n| ↳--- `businessHours` | `array of objects` | A list of objects defining the opening and closing times for each day of the week. |\n| ↳---- `DayOfWeek` | `number` | The day of the week, typically represented as a number (e.g., 0 for Sunday, 1 for Monday). |\n| ↳---- `OpeningTime` | `string` | The time the location opens on that day, in HH:MM:SS format. |\n| ↳---- `ClosingTime` | `string` | The time the location closes on that day, in HH:MM:SS format. |\n| ↳ `contactInformation` | `array` | A list of contact details, which is empty in this case. |\n| ↳ `paymentData` | `object` | An object containing all data related to the payment of the order. |\n| ↳-- `giftCards` | `array` | A list of gift cards used in the payment. |\n| ↳-- `transactions` | `array of objects` | A list of payment transactions made for the order. |\n| ↳--- `isActive` | `boolean` | A flag indicating if the transaction is currently active. |\n| ↳--- `transactionId` | `string` | The unique identifier for this payment transaction. |\n| ↳--- `merchantName` | `string` | The name of the merchant associated with this transaction. |\n| ↳--- `payments` | `array of objects` | A list of individual payments that make up the transaction. |\n| ↳---- `id` | `string` | The unique identifier for this specific payment attempt. |\n| ↳---- `paymentSystem` | `string` | The numeric ID of the payment method used (e.g., '47' for Cash). |\n| ↳---- `paymentSystemName` | `string` | The display name of the payment method used. |\n| ↳---- `value` | `number` | The monetary value of this payment, in cents. |\n| ↳---- `installments` | `number` | The number of installments for the payment. |\n| ↳---- `connectorResponses` | `object` | Contains raw responses from the payment gateway or connector. |\n| ↳---- `referenceValue` | `number` | The original or base value of the payment before any adjustments, in cents. |\n| ↳---- `cardHolder` | `string` | The name of the cardholder, if a credit/debit card was used. |\n| ↳---- `cardNumber` | `string` | The masked card number. |\n| ↳---- `firstDigits` | `string` | The first few digits (BIN) of the card number. |\n| ↳---- `lastDigits` | `string` | The last four digits of the card number. |\n| ↳---- `cvv2` | `string` | The Card Verification Value (security code). |\n| ↳---- `expireMonth` | `string` | The card's expiration month. |\n| ↳---- `expireYear` | `string` | The card's expiration year. |\n| ↳---- `url` | `string` | A URL for redirection, if required by the payment method (e.g., for 3D Secure). |\n| ↳---- `koinUrl` | `string` | A redirection URL for the Koin \"Buy Now, Pay Later\" payment service. |\n| ↳---- `tid` | `string` | The Transaction ID provided by the payment acquirer. |\n| ↳---- `redemptionCode` | `string` | The code entered by the customer to redeem a gift card or voucher for this payment. |\n| ↳---- `giftCardId` | `string` | The unique internal identifier for the gift card used in this payment. |\n| ↳---- `giftCardProvider` | `string` | The name of the company or service that issued the gift card. |\n| ↳---- `giftCardAsDiscount` | `string` | A flag indicating if the gift card's value was applied as a discount instead of a direct payment method. |\n| ↳---- `group` | `string` | A name used to group multiple payments together (e.g., 'creditCard', 'bankSlip'). |\n| ↳---- `dueDate` | `string` | The due date for the payment, relevant for invoices or bank slips. |\n| ↳---- `accountId` | `string` | The unique identifier for the customer's account with the payment provider. |\n| ↳---- `parentAccountId` | `string` | The identifier for a parent or master account, used in cases of sub-accounts or corporate accounts. |\n| ↳---- `bankIssuedInvoiceIdentificationNumber` | `string` | The identification number for a bank-issued invoice or slip. |\n| ↳---- `bankIssuedInvoiceBarCodeNumber` | `string` | The full barcode number for a bank slip. |\n| ↳---- `billingAddress` | `string` | An object containing the billing address associated with the payment. |\n| ↳---- `paymentOrigin` | `string` | Indicates the origin of the payment. |\n| ↳--- `sharedTransaction` | `boolean` | A flag indicating if this transaction is shared across multiple sellers. |\n| ↳ `clientPreferencesData` | `object` | Contains data about the client's preferences, such as opting in for newsletters. |\n| ↳ `commercialConditionData` | `null` | Data related to special commercial conditions or contracts for the customer. |\n| ↳ `giftRegistryData` | `null` | Contains information if the order is part of a gift registry or wish list. |\n| ↳ `marketingData` | `null` | Contains marketing-related data, such as UTM parameters, coupons, or campaign identifiers. |\n| ↳ `storePreferencesData` | `object` | Contains settings and preferences specific to the storefront, like currency and timezone. |\n| ↳- `countryCode` | `string` | The three-letter ISO code for the country the store operates in. |\n| ↳- `saveUserData` | `boolean` | A flag indicating if the user's data should be saved for future purchases. |\n| ↳- `timeZone` | `string` | The timezone of the store. |\n| ↳- `currencyCode` | `string` | The three-letter code for the store's currency (e.g., `BRL`). |\n| ↳- `currencyLocale` | `number` | The locale ID used for formatting the currency. |\n| ↳- `currencySymbol` | `string` | The symbol for the store's currency (e.g., `R$`). |\n| ↳- `currencyFormatInfo` | `object` | An object detailing how to format currency values for display. |\n| ↳-- `currencyDecimalDigits` | `number` | The number of digits to show after the decimal separator. |\n| ↳--- `currencyDecimalSeparator` | `string` | The character used as the decimal separator (e.g., `,`). |\n| ↳--- `currencyGroupSeparator` | `string` | The character used for separating groups of thousands (e.g., `.`). |\n| ↳--- `currencyGroupSize` | `number` | The number of digits in each group before a separator. |\n| ↳--- `startsWithCurrencySymbol` | `boolean` | A flag indicating if the currency symbol is placed before the value. |\n| ↳- `openTextField` | `string` | A field for the customer to add open-ended comments or observations about the order. |\n| ↳- `invoiceData` | `object` | Contains the necessary information for generating a fiscal invoice. |\n| ↳- `itemMetadata` | `object` | Contains additional backend metadata about the items in the cart. |\n| ↳-- `items` | `array of objects` | A list of metadata objects for each item in the cart. |\n| ↳--- `id` | `string` | The item's SKU ID. |\n| ↳--- `seller` | `string` | The unique identifier for the seller of the item. |\n| ↳--- `name` | `string` | The product name. |\n| ↳--- `skuName` | `string` | The name of the specific SKU. |\n| ↳--- `imageUrl` | `string` | The URL for the item's image. |\n| ↳--- `detailUrl` | `string` | The relative URL to the product's detail page. |\n| ↳--- `assemblyOptions` | `array` | A list of available assembly options, like subscriptions or customizations. |\n| ↳--- `id` | `string` | The unique ID for the assembly option. |\n| ↳--- `name` | `string` | The display name of the assembly option. |\n| ↳--- `required` | `boolean` | A flag indicating if selecting this option is mandatory. |\n| ↳--- `inputValues` | `object` | Defines the schema for the user's input for this option. |\n| ↳--- `composition` | `string` | Details about the components if this option adds items to the cart. |\n| ↳ `taxData` | `string` | Contains detailed tax information for the order, especially for B2B or international sales. |\n| ↳ `customData` | `object` | A field for custom applications to attach arbitrary data to the order form. |\n| ↳ `hooksData` | `object` | Contains data related to external hooks or integrations that have interacted with the order. |\n| ↳ `changeData` | `object` | Contains information about changes made to an order after it was placed. |\n| ↳ `subscriptionData` | `object` | Contains details if the order is part of a subscription, including frequency and renewal information. |\n| ↳ `merchantContextData` | `object` | Data provided by the merchant's external systems for context. |\n| ↳ `salesChannel` | `string` | The ID of the sales channel (or trade policy) through which the order was placed. |\n| ↳ `followUpEmail` | `string` | A unique email address used for post-purchase communication for this specific order. |\n| ↳ `creationDate` | `string` | The exact date and time the order was created, in UTC (Coordinated Universal Time). |\n| ↳ `lastChange` | `string` | The date and time of the last modification to the order, in UTC. |\n| ↳ `timeZoneCreationDate` | `string` | The creation date and time of the order, adjusted to the store's local timezone. |\n| ↳ `timeZoneLastChange` | `string` | The last modification date and time, adjusted to the store's local timezone. |\n| ↳ `isCompleted` | `boolean` | A flag that becomes `true` when the customer successfully completes the checkout process. |\n| ↳ `hostName` | `string` | The hostname of the store where the order was created. |\n| ↳ `merchantName` | `null` | The name of the merchant account. |\n| `userType` | `string` | The type of user who placed the order. An empty string usually means a regular customer. |\n| ↳ `roundingError` | `number` | Any rounding difference that occurred during total calculations, in cents. |\n| ↳ `allowEdition` | `boolean` | A flag indicating if the order can be edited after being placed. |\n| ↳ `allowCancellation` | `boolean` | A flag indicating if the order can be canceled. |\n| ↳ `isUserDataVisible` | `boolean` | A flag indicating if the user's personal data should be visible. |\n| ↳ `allowChangeSeller` | `boolean` | A flag indicating if the seller responsible for an item can be changed. |\n| ↳ `orderFormCreationDate` | `string` | The timestamp when the order form (the cart session) was initially created, in UTC. |\n| `allowMultipleDeliveries` | `boolean` | Flag indicating if the order can be shipped to multiple addresses. |" - }, - "response": [ - { - "name": "200 OK", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "VtexIdclientAutCookie_qastore", - "value": "{{authCookieValue}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\": [\n {\n \"id\": 2,\n \"quantity\": 2,\n \"seller\": \"1\",\n \"price\": 100,\n \"uniqueId\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n {\n \"id\": 8,\n \"quantity\": 1,\n \"seller\": \"1\",\n \"price\": 8500,\n \"uniqueId\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n }\n ],\n \"shippingData\": {{my_shippingData}},\n \"clientProfileData\": {{my_profileData}},\n \"paymentData\": {{my_paymentsDataString}},\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"66E33CB45C1241B8986CDE97AE7EC270\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"D0A0403BDF7047D1A64BE83051D203FC\"\n },\n \"fields\": [\n {\n \"name\": \"costCenter\",\n \"value\": \"CC2\",\n \"refId\": \"CC2\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"order\"\n },\n \"fields\": [\n {\n \"name\": \"PO Number\",\n \"value\": \"PO1\",\n \"refId\": \"9b884ddc-2dbc-4443-8706-8c6a21dac219\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"address\",\n \"id\": \"home\"\n },\n \"fields\": [\n {\n \"name\": \"Desktop\",\n \"value\": \"DSK1\",\n \"refId\": \"b1d7a268-090a-4578-9bf9-22b4537851e8\"\n }\n ]\n }\n ]\n },\n \"openTextField\": {\n \"value\": \"ODP use cases\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/checkout/pub/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "checkout", - "pub", - "orders" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"orderForm\": null,\n \"transactionData\": {\n \"merchantTransactions\": [\n {\n \"id\": \"RECORRENCIACHARLIE\",\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"paymentSystem\": \"47\",\n \"bin\": null,\n \"accountId\": null,\n \"tokenId\": null,\n \"value\": 105547,\n \"referenceValue\": 105547,\n \"giftCardRedemptionCode\": null,\n \"giftCardProvider\": null,\n \"giftCardId\": null\n }\n ]\n }\n ],\n \"receiverUri\": \"https://recorrenciacharlie.vtexpayments.com.br/split/1560176581020/payments\",\n \"gatewayCallbackTemplatePath\": \"/checkout/gatewayCallback/1560176581020/{messageCode}\"\n },\n \"orders\": [\n {\n \"orderId\": \"1560176581020-01\",\n \"orderGroup\": \"1560176581020\",\n \"state\": null,\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560176581020-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 105547,\n \"items\": [\n {\n \"uniqueId\": \"ABBF87D61CB3441E97FC2527A93432AA\",\n \"id\": \"1\",\n \"productId\": \"1\",\n \"productRefId\": \"\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:52:36Z\",\n \"tax\": 0,\n \"price\": 765,\n \"listPrice\": 765,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 765,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n },\n {\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 765,\n \"total\": 765,\n \"sellingPrices\": [\n {\n \"value\": 765,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"8BEAE818E2AE4474905B4BEF306A5E77\",\n \"id\": \"2\",\n \"productId\": \"2\",\n \"productRefId\": \"\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:54:16Z\",\n \"tax\": 0,\n \"price\": 4282,\n \"listPrice\": 4282,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 4282,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [\n {\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"schema\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n }\n }\n ],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 4282,\n \"total\": 4282,\n \"sellingPrices\": [\n {\n \"value\": 4282,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n },\n {\n \"uniqueId\": \"F3E0DA124887476DBB0F2C7DC0B6FE2A\",\n \"id\": \"3\",\n \"productId\": \"3\",\n \"productRefId\": \"\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"priceValidUntil\": \"2026-09-08T16:57:30Z\",\n \"tax\": 0,\n \"price\": 1000,\n \"listPrice\": 1000,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 1000,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": null,\n \"brandName\": \"Test Brand name\",\n \"brandId\": \"2000000\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Grocery\"\n },\n \"quantity\": 100,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [],\n \"availability\": \"available\",\n \"measurementUnit\": \"kg\",\n \"unitMultiplier\": 1,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 1000,\n \"total\": 100000,\n \"sellingPrices\": [\n {\n \"value\": 1000,\n \"quantity\": 100\n }\n ],\n \"reason\": null\n },\n \"taxCode\": \"\"\n }\n ],\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE\",\n \"logo\": \"\",\n \"minimumOrderValue\": 0\n }\n ],\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 105047\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": 0\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 500\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"userautomated24.608800099331596@mailinator.com\",\n \"firstName\": \"Postman\",\n \"lastName\": \"Test\",\n \"document\": \"20275756343\",\n \"documentType\": \"cpf\",\n \"phone\": \"+552222222222\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": false,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [],\n \"teaser\": []\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 0,\n \"listPrice\": 0,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"1\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 1,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 1,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 5,\n \"listPrice\": 5,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"2\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ]\n },\n {\n \"itemIndex\": 2,\n \"selectedSla\": \"Normal\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"12334048475146857\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Normal\",\n \"deliveryIds\": [\n {\n \"courierId\": \"1\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Transportadora\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"3bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 495,\n \"listPrice\": 495,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"3bd\"\n },\n {\n \"id\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (VTEX-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_VTEX-RJ\",\n \"pickupDistance\": 25.510984420776367,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (BPS-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_BPS-RJ\",\n \"pickupDistance\": 25.721134185791016,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n },\n {\n \"id\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryChannel\": \"pickup-in-point\",\n \"name\": \"Retira sem Janela (RIOSUL-RJ)\",\n \"deliveryIds\": [\n {\n \"courierId\": \"Retira sem Janela\",\n \"warehouseId\": \"Retira sem Janela\",\n \"dockId\": \"Retira sem Janela\",\n \"courierName\": \"Retira sem Janela\",\n \"quantity\": 100,\n \"kitItemDetails\": []\n }\n ],\n \"shippingEstimate\": \"2bd\",\n \"shippingEstimateDate\": null,\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 200,\n \"listPrice\": 200,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": true,\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"dockId\": \"Retira sem Janela\"\n },\n \"pickupPointId\": \"1_RIOSUL-RJ\",\n \"pickupDistance\": 27.00348663330078,\n \"polygonName\": \"\",\n \"transitTime\": \"2bd\"\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"itemId\": \"3\",\n \"deliveryChannels\": [\n {\n \"id\": \"pickup-in-point\"\n },\n {\n \"id\": \"delivery\"\n }\n ]\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"user Saint Jones\",\n \"addressId\": \"12334048475146857\",\n \"isDisposable\": true,\n \"postalCode\": \"25575610\",\n \"city\": \"São João de Meriti\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Antônio Ferreira\",\n \"number\": \"35\",\n \"neighborhood\": \"Vila Colúmbia\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": [\n -43.34095001220703,\n -22.767324447631836\n ]\n }\n ],\n \"pickupPoints\": [\n {\n \"friendlyName\": \"VTEX-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"VTEX-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18259,\n -22.94436\n ]\n },\n \"additionalInfo\": \"Chegar cedo\",\n \"id\": \"1_VTEX-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"23:59:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"BPS-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"BPS-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Praia de Botafogo\",\n \"number\": \"400\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.18347,\n -22.94746\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_BPS-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n },\n {\n \"friendlyName\": \"RIOSUL-RJ\",\n \"address\": {\n \"addressType\": \"pickup\",\n \"receiverName\": null,\n \"addressId\": \"RIOSUL-RJ\",\n \"isDisposable\": true,\n \"postalCode\": \"22290-160\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Rua Lauro Müller\",\n \"number\": \"116\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.17352,\n -22.95487\n ]\n },\n \"additionalInfo\": \"\",\n \"id\": \"1_RIOSUL-RJ\",\n \"isActive\": null,\n \"businessHours\": [\n {\n \"DayOfWeek\": 0,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 1,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 2,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 3,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 4,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 5,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n },\n {\n \"DayOfWeek\": 6,\n \"OpeningTime\": \"00:00:00\",\n \"ClosingTime\": \"00:00:00\"\n }\n ]\n }\n ],\n \"contactInformation\": []\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"7E35DD7878D840AA9C005861E6E39420\",\n \"merchantName\": \"RECORRENCIACHARLIE\",\n \"payments\": [\n {\n \"id\": null,\n \"paymentSystem\": \"47\",\n \"paymentSystemName\": \"Cash\",\n \"value\": 105547,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 105547,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": null,\n \"dueDate\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentOrigin\": null\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": null,\n \"commercialConditionData\": null,\n \"giftRegistryData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"saveUserData\": false,\n \"timeZone\": \"E. South America Standard Time\",\n \"currencyCode\": \"BRL\",\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \",\",\n \"currencyGroupSeparator\": \".\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": null,\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"3\",\n \"seller\": \"1\",\n \"name\": \"Mango\",\n \"skuName\": \"Mango\",\n \"productId\": \"3\",\n \"refId\": \"151761\",\n \"ean\": \"7896025801878\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155418-55-55/product-packshot-mango.jpg?v=638362594212400000\",\n \"detailUrl\": \"/mango/p\",\n \"assemblyOptions\": []\n },\n {\n \"id\": \"2\",\n \"seller\": \"1\",\n \"name\": \"Kiwi\",\n \"skuName\": \"Kiwi\",\n \"productId\": \"2\",\n \"refId\": \"151760\",\n \"ean\": \"7896025801899\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155417-55-55/881558096202.jpg?v=638362590492400000\",\n \"detailUrl\": \"/kiwi/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.plano-da-ana\",\n \"name\": \"vtex.subscription.plano-da-ana\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"2 day\",\n \" 3 week\",\n \" 5 week\",\n \" 4 month\",\n \" 5 month\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n },\n {\n \"id\": \"1\",\n \"seller\": \"1\",\n \"name\": \"Apple\",\n \"skuName\": \"Apple\",\n \"productId\": \"1\",\n \"refId\": \"197326\",\n \"ean\": \"7898926177332\",\n \"imageUrl\": \"https://recorrenciacharlie.vteximg.com.br/arquivos/ids/155416-55-55/istockphoto-184276818-612x612.jpg?v=638362584172930000\",\n \"detailUrl\": \"/apple/p\",\n \"assemblyOptions\": [\n {\n \"id\": \"vtex.subscription.teste-nico\",\n \"name\": \"vtex.subscription.teste-nico\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.plano-gold\",\n \"name\": \"vtex.subscription.plano-gold\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 month\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.portunus\",\n \"name\": \"vtex.subscription.portunus\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 7,\n \"domain\": [\n \"1 day\",\n \" 1 week\"\n ]\n }\n },\n \"composition\": null\n },\n {\n \"id\": \"vtex.subscription.basic\",\n \"name\": \"vtex.subscription.basic\",\n \"required\": false,\n \"inputValues\": {\n \"vtex.subscription.key.frequency\": {\n \"maximumNumberOfCharacters\": 8,\n \"domain\": [\n \"1 day\",\n \" 1 week\",\n \" 2 week\",\n \" 4 week\",\n \" 1 month\",\n \" 2 month\",\n \" 1 year\"\n ]\n }\n },\n \"composition\": null\n }\n ]\n }\n ]\n },\n \"taxData\": null,\n \"customData\": null,\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"5bb299d7a91c487faece472daed48b46@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:57:30.7718345Z\",\n \"lastChange\": \"2025-09-08T16:57:32.3020624Z\",\n \"timeZoneCreationDate\": \"2025-09-08T13:57:30.7718345\",\n \"timeZoneLastChange\": \"2025-09-08T13:57:32.3020624\",\n \"isCompleted\": false,\n \"hostName\": \"recorrenciacharlie\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:57:30.5217933Z\"\n }\n ],\n \"allowMultipleDeliveries\": true\n}" - } - ] - }, - { - "name": "Get Order Cancellation Feedback", - "request": { - "method": "GET", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{appKey}}" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{appToken}}" - } - ], - "url": { - "raw": "{{baseUrl}}/api/order-system/orders/{{orderId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "order-system", - "orders", - "{{orderId}}" - ] - }, - "description": "This endpoint retrieves the details in the `cancellationData` field of the order when a buying policy causes an automatic rejection of an order.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}/api/order-system/orders/{{orderId}}?an={{account}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `orderId` | `string` | Yes | Order identifier. |\n\n---\n\n### Response\n\n``` json\n{\n \"id\": \"b5a68673-4298-4412-8b41-626c247a2482\",\n \"orderId\": \"1540031666098-01\",\n \"workflowInstanceId\": \"65858b2e-5a80-4331-a2ac-6d36b6a8d642\",\n \"status\": \"accepted\",\n \"units\": [],\n \"callbackEndpoint\": \"http://checkout.vtexcommerce.com.br/api/checkout/pvt/order-auth/1540031666098-01/callback?an=recorrenciacharlie\",\n \"totalOrderValueDesiredBySeller\": 0.0,\n \"marketPlacePaymentValue\": 0.0,\n \"itemCollection\": [\n {\n \"id\": \"7f159283-3365-4e8d-ad73-1987c53996f5\",\n \"sku\": \"1\",\n \"price\": 7.65,\n \"totalSystemDiscount\": 0.0,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n },\n {\n \"id\": \"4110a466-c040-4a96-bce5-eff7ed0668e1\",\n \"sku\": \"2\",\n \"price\": 42.82,\n \"totalSystemDiscount\": 0.0,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n },\n {\n \"id\": \"95eb1ced-3493-499c-bebc-e656946707c4\",\n \"sku\": \"3\",\n \"price\": 10.0,\n \"totalSystemDiscount\": 0.0,\n \"totalManualDiscount\": 0.0,\n \"quantity\": 1,\n \"additionalInfo\": {\n \"commercialCondition\": \"1\"\n }\n }\n ],\n \"additionalInfo\": {\n \"userProfileId\": \"e18ac822-9a2e-4357-be4c-c7a95892c9e2\"\n },\n \"dimensionStatus\": [\n {\n \"id\": \"3ad21b0b-597e-4871-9ce9-9862e67012e7\",\n \"name\": \"Dimension Monitoring - Dimension CRUD test - Dynamic Rule - vtexcommercebeta\",\n \"unitId\": null,\n \"status\": \"accepted\",\n \"score\": 100.0,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"6dcfddf7-e152-473f-bf8c-8e2c2da783bb\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"ignored\",\n \"doId\": null,\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Deny\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 100000\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Deny\",\n \"effectType\": 1,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n },\n {\n \"id\": \"7b5bfcc9-2441-4910-8312-8aa22227d91f\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"ignored\",\n \"doId\": null,\n \"priority\": 2,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Do Effect\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 50000\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Create Do Effect\",\n \"effectType\": 2,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n },\n {\n \"id\": \"825896b7-4df0-4d5e-aec0-7e43bcb5451a\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"accepted\",\n \"doId\": null,\n \"score\": 100.0,\n \"authorizedEmails\": [],\n \"priority\": 3,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Approve\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 0\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Approve\",\n \"effectType\": 0,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-05-21T20:35:22.8943023Z\",\n \"creationVersion\": \"2.0.10-beta.1\",\n \"creationEnvironment\": \"beta\"\n },\n {\n \"id\": \"f2dcc0e0-ee6e-4537-921b-8c63a7ad41fd\",\n \"name\": \"Dimension Monitoring - Dimension with Unit - vtexcommercebeta\",\n \"unitId\": \"1\",\n \"status\": \"accepted\",\n \"score\": 100.0,\n \"priority\": 1,\n \"shouldSimulate\": true,\n \"ruleCollection\": [\n {\n \"id\": \"2de4445c-a801-4d0d-b311-490868323eae\",\n \"name\": \"Rule Monitoring test\",\n \"status\": \"ignored\",\n \"doId\": null,\n \"authorizedEmails\": [],\n \"priority\": 1,\n \"trigger\": {\n \"condition\": {\n \"conditionType\": 2,\n \"description\": \"Testing Dynamic Rule with Deny\",\n \"lessThan\": null,\n \"greatherThan\": null,\n \"expression\": \"value > 100000\"\n },\n \"effect\": {\n \"description\": \"Effect Description - Deny\",\n \"effectType\": 1,\n \"funcPath\": null\n }\n },\n \"timeout\": 500,\n \"notification\": true,\n \"scoreInterval\": {\n \"accept\": 10,\n \"deny\": 5\n }\n }\n ],\n \"creationDate\": \"2025-06-11T17:53:49.2675344Z\",\n \"creationVersion\": \"2.0.17-beta\",\n \"creationEnvironment\": \"beta\"\n }\n ],\n \"creationVersion\": \"2.0.7\",\n \"creationEnvironment\": \"stable\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Unique identifier of the order authorization. |\n| `orderId` | `string` | Order identifier in the commerce platform. |\n| `workflowInstanceId` | `string` | Workflow execution instance identifier. |\n| `status` | `string` | Final status of the evaluation (e.g., `accepted`, `denied`). |\n| `units` | `array` | Units involved in the decision, if applicable. |\n| `callbackEndpoint` | `string` | URL for the system to notify the evaluation result. |\n| `totalOrderValueDesiredBySeller` | `number` | Total order value expected by the seller. |\n| `marketPlacePaymentValue` | `number` | Payment value processed by the marketplace. |\n| `itemCollection` | `array of objects` | List of items evaluated in the order. |\n| `itemCollection[].id` | `string` | Unique identifier of the item. |\n| `itemCollection[].sku` | `string` | SKU identifier. |\n| `itemCollection[].price` | `number` | Price of the item. |\n| `itemCollection[].totalSystemDiscount` | `number` | Discount applied by the system. |\n| `itemCollection[].totalManualDiscount` | `number` | Discount manually applied. |\n| `itemCollection[].quantity` | `number` | Quantity of the item. |\n| `itemCollection[].additionalInfo.commercialCondition` | `string` | Commercial condition identifier. |\n| `additionalInfo.userProfileId` | `string` | Identifier of the user profile associated with the order. |\n| `dimensionStatus` | `array of objects` | List of evaluated dimensions with respective results. |\n| `dimensionStatus[].id` | `string` | Unique identifier of the dimension. |\n| `dimensionStatus[].name` | `string` | Name of the dimension. |\n| `dimensionStatus[].unitId` | `string` | Organizational unit associated, if applicable. |\n| `dimensionStatus[].status` | `string` | Result of the dimension evaluation (`accepted`, `denied`, etc.). |\n| `dimensionStatus[].score` | `number` | Final score of the evaluation. |\n| `dimensionStatus[].priority` | `number` | Priority of the dimension. |\n| `dimensionStatus[].shouldSimulate` | `boolean` | Whether the dimension was simulated. |\n| `dimensionStatus[].ruleCollection` | `array of objects` | Rules evaluated within the dimension. |\n| `dimensionStatus[].creationDate` | `string` | ISO timestamp when the dimension was created. |\n| `dimensionStatus[].creationVersion` | `string` | System version when the dimension was created. |\n| `dimensionStatus[].creationEnvironment` | `string` | Environment of origin (`beta`, `stable`, etc.). |\n| `creationVersion` | `string` | Version of the authorization system. |\n| `creationEnvironment` | `string` | Execution environment (`stable`, `beta`, etc.). |" - }, - "response": [] - }, - { - "name": "Send Order Payment", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{{my_payload}}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.vtexpayments.com.br/api/pub/transactions/{{my_transactionId}}/payments", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexpayments", - "com", - "br" - ], - "path": [ - "api", - "pub", - "transactions", - "{{my_transactionId}}", - "payments" - ] - }, - "description": "This endpoint process an orders payment.\n\n---\n\n### Request\n\n- **Method**: `POST`\n \n- **URL**: `https://{{account}}.vtexpayments.com.br/api/pub/transactions/{{my_transactionId}}/payments`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/json`\n \n\n#### Parameters\n\n| Parameters | Type | Required | Description |\n| --- | --- | --- | --- |\n| my_transactionId | `string` | Yes | Order transaction identifier. |\n\n---\n\n### Request Body\n\n``` json\n{{my_payload}}\n\n ```\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| paymentData | `object` | Yes | Payment information. |\n\n\n### Response body\n\n``` json\n{\n \"id\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"referenceKey\": \"656517\",\n \"interactions\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/interactions\"\n },\n \"settlements\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/settlements\"\n },\n \"payments\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/payments\"\n },\n \"refunds\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/refunds\"\n },\n \"cancellations\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/cancellations\"\n },\n \"capabilities\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/capabilities\"\n },\n \"timeoutStatus\": 1,\n \"totalRefunds\": 0.0,\n \"status\": \"Finished\",\n \"value\": 3159,\n \"receiverUri\": null,\n \"startDate\": \"2025-09-08T16:46:44\",\n \"authorizationToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"authorizationDate\": \"2025-09-08T16:46:45\",\n \"commitmentToken\": \"3372C829621C4004B94B180C4FA4577E\",\n \"commitmentDate\": \"2025-09-08T16:46:57\",\n \"refundingToken\": null,\n \"refundingDate\": null,\n \"cancelationToken\": null,\n \"cancelationDate\": null,\n \"fields\": [\n {\n \"name\": \"owner\",\n \"value\": \"vtex-service::checkout::stable\"\n },\n {\n \"name\": \"conditions\",\n \"value\": \"[{\\\"id\\\":\\\"1\\\",\\\"value\\\":33.99}]\"\n },\n {\n \"name\": \"postbackStatusUrl\",\n \"value\": \"https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1560170656517/notifications/transaction-status?an=b2bfaststoredev\"\n },\n {\n \"name\": \"currencyCode\",\n \"value\": \"USD\"\n },\n {\n \"name\": \"shopperInteraction\",\n \"value\": \"ecommerce\"\n },\n {\n \"name\": \"lastTransitionDate\",\n \"value\": \"9/8/2025 4:46:56 PM\"\n },\n {\n \"name\": \"TotalTimeSpentInTransitionsUntilThisTransition\",\n \"value\": \"16667.4862\"\n },\n {\n \"name\": \"channel\",\n \"value\": \"B2BFASTSTOREDEV\"\n },\n {\n \"name\": \"salesChannel\",\n \"value\": \"1\"\n },\n {\n \"name\": \"orderGroup\",\n \"value\": \"1560170656517\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"parentMerchant\",\n \"value\": \"13cfb648-f0a2-4e8f-818e-e3e9c7538b0d\"\n },\n {\n \"name\": \"orderId\",\n \"value\": \"2C4BF3F0A5C34B20A229AAC8262732CE\"\n },\n {\n \"name\": \"ip\",\n \"value\": \"3.229.80.75\"\n },\n {\n \"name\": \"userAgent\",\n \"value\": \"PostmanRuntime/7.39.0\"\n },\n {\n \"name\": \"acceptHeader\",\n \"value\": \"*/*\"\n },\n {\n \"name\": \"cart\",\n \"value\": \"{\\\"items\\\":[{\\\"id\\\":\\\"88\\\",\\\"name\\\":\\\"Combination Spanner Set Storage\\\",\\\"value\\\":3399,\\\"quantity\\\":1,\\\"priceTags\\\":[{\\\"name\\\":\\\"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\\\",\\\"value\\\":-3.40,\\\"isPercentual\\\":false}],\\\"components\\\":null,\\\"commission\\\":0.0,\\\"freightCommission\\\":0.0,\\\"sellerChain\\\":null,\\\"shippingDiscount\\\":0,\\\"discount\\\":-340,\\\"refId\\\":\\\"88\\\",\\\"productId\\\":\\\"56\\\",\\\"sellingPrice\\\":30.59,\\\"sellerId\\\":\\\"1\\\",\\\"dockId\\\":\\\"1\\\",\\\"categoryId\\\":\\\"1\\\",\\\"categoryName\\\":\\\"Category\\\",\\\"deliveryChannel\\\":\\\"delivery\\\",\\\"deliveryType\\\":\\\"Entrega Soberana\\\",\\\"deliverySlaInMinutes\\\":1440,\\\"deliveryWindow\\\":null,\\\"tax\\\":0,\\\"freight\\\":100}],\\\"sellers\\\":[{\\\"id\\\":\\\"1\\\",\\\"name\\\":\\\"VTEX\\\",\\\"documentType\\\":\\\"CNPJ\\\",\\\"document\\\":null}],\\\"freight\\\":100,\\\"shippingdate\\\":null,\\\"shippingestimated\\\":\\\"1bd\\\",\\\"orderUrl\\\":\\\"http://b2bfaststoredev.vtexcommercestable.com.br/admin/checkout/#/orders?q=1560170656517\\\",\\\"tax\\\":0,\\\"isGiftRegistry\\\":null,\\\"giftRegistryDescription\\\":null,\\\"giftRegistryId\\\":null,\\\"isPickupStore\\\":null,\\\"isCallCenter\\\":null}\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"postPurchaseOperationMode\",\n \"value\": \"Total\"\n },\n {\n \"name\": \"retainPartialSettlements\",\n \"value\": \"False\"\n },\n {\n \"name\": \"nativeSplitEnabled\",\n \"value\": \"False\"\n },\n {\n \"name\": \"clientProfileData\",\n \"value\": \"{\\\"email\\\":null,\\\"firstName\\\":\\\"Frederic\\\",\\\"lastName\\\":\\\"Kessler\\\",\\\"document\\\":\\\"22736794/000199\\\",\\\"phone\\\":\\\"3834600495\\\",\\\"corporateName\\\":null,\\\"tradeName\\\":null,\\\"corporateDocument\\\":null,\\\"stateInscription\\\":null,\\\"postalCode\\\":\\\"22250-040\\\",\\\"address\\\":{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null},\\\"gender\\\":null,\\\"birthDate\\\":null,\\\"createdDate\\\":\\\"2025-08-19T12:55:37.8475373Z\\\",\\\"corporatePhone\\\":null,\\\"isCorporate\\\":false,\\\"documentType\\\":\\\"CNPJ\\\",\\\"id\\\":\\\"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\\\"}\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"shopperInteraction\": \"ecommerce\",\n \"ipAddress\": \"3.229.80.75\",\n \"sessionId\": null,\n \"macId\": null,\n \"vtexFingerprint\": null,\n \"chargeback\": null,\n \"whiteSignature\": null,\n \"owner\": \"vtex-service::checkout::stable\",\n \"orderId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"userAgent\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"acceptHeader\": \"*/*\",\n \"antifraudTid\": null,\n \"antifraudResponse\": null,\n \"antifraudReference\": null,\n \"antifraudAffiliationId\": null,\n \"channel\": \"B2BFASTSTOREDEV\",\n \"salesChannel\": \"1\",\n \"urn\": null,\n \"softDescriptor\": null,\n \"markedForRecurrence\": false,\n \"buyer\": null\n}\n ```\n\n\n| Field | Type | Description |\n| :--- | :--- | :--- |\n| `id` | `string` | The unique identifier for the transaction object itself. |\n| `transactionId` | `string` | The primary identifier for the payment transaction. |\n| `referenceKey` | `string` | An external reference key, often from an Order Management System (OMS). |\n| `interactions` | `object` | Contains the API endpoint for transaction interactions. |\n| ↳--- `href` | `string` | The relative URL to access the interaction details. |\n| `settlements` | `object` | Contains the API endpoint for transaction settlements. |\n| `payments` | `object` | Contains the API endpoint for the payments within the transaction. |\n| `refunds` | `object` | Contains the API endpoint for refunds associated with the transaction. |\n| `cancellations` | `object` | Contains the API endpoint for cancellations. |\n| `capabilities` | `object` | Contains the API endpoint to view available transaction capabilities. |\n| `timeoutStatus` | `number` | A status code indicating if the transaction is timed out. |\n| `totalRefunds` | `number` | The total value that has been refunded for this transaction. |\n| `status` | `string` | The current status of the transaction (e.g., 'Finished', 'Authorized'). |\n| `value` | `number` | The total value of the transaction, in cents. |\n| `receiverUri` | `null` | The endpoint URL for the payment receiver. |\n| `startDate` | `string` | The timestamp when the transaction was initiated. |\n| `authorizationToken` | `string` | A token received from the payment gateway upon successful authorization. |\n| `authorizationDate` | `string` | The timestamp when the payment was authorized. |\n| `commitmentToken` | `string` | A token confirming the commitment or capture of the funds. |\n| `commitmentDate` | `string` | The timestamp when the funds were committed or captured. |\n| `fields` | `array` | A list of key-value pairs containing miscellaneous data about the transaction. |\n| ↳- `name` | `string` | The name of the data field (e.g., 'currencyCode', 'cart', 'clientProfileData'). |\n| ↳- `value` | `string` | The value of the data field. |\n| `currencyCode` | `string` | The three-letter ISO currency code for the transaction (e.g., `USD`). |\n| `shopperInteraction` | `string` | The type of interaction through which the transaction was made. |\n| `ipAddress` | `string` | The IP address of the shopper at the time of the transaction. |\n| `owner` | `string` | The service or application that created the transaction. |\n| `orderId` | `string` | The identifier for the order associated with this transaction. |\n| `userAgent` | `string` | The user agent string of the shopper's browser or client. |\n| `acceptHeader` | `string` | The Accept header from the shopper's HTTP request. |\n| `channel` | `string` | The name of the store or channel where the transaction occurred. |\n| `salesChannel` | `string` | The ID of the sales channel (trade policy) used for the transaction. |\n| `softDescriptor` | `null` | The text that appears on the customer's credit card statement. |\n| `markedForRecurrence` | `boolean` | A flag indicating if this transaction is part of a recurring payment schedule. |\n| `buyer` | `object` | An object containing information about the buyer. |" - }, - "response": [ - { - "name": "200 OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{{my_payload}}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.vtexpayments.com.br/api/pub/transactions/{{my_transactionId}}/payments", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexpayments", - "com", - "br" - ], - "path": [ - "api", - "pub", - "transactions", - "{{my_transactionId}}", - "payments" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [], - "body": "{\n \"id\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"referenceKey\": \"656517\",\n \"interactions\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/interactions\"\n },\n \"settlements\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/settlements\"\n },\n \"payments\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/payments\"\n },\n \"refunds\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/refunds\"\n },\n \"cancellations\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/cancellations\"\n },\n \"capabilities\": {\n \"href\": \"/api/pvt/transactions/2C4BF3F0A5C34B20A229AAC8262732CE/capabilities\"\n },\n \"timeoutStatus\": 1,\n \"totalRefunds\": 0,\n \"status\": \"Finished\",\n \"value\": 3159,\n \"receiverUri\": null,\n \"startDate\": \"2025-09-08T16:46:44\",\n \"authorizationToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"authorizationDate\": \"2025-09-08T16:46:45\",\n \"commitmentToken\": \"3372C829621C4004B94B180C4FA4577E\",\n \"commitmentDate\": \"2025-09-08T16:46:57\",\n \"refundingToken\": null,\n \"refundingDate\": null,\n \"cancelationToken\": null,\n \"cancelationDate\": null,\n \"fields\": [\n {\n \"name\": \"owner\",\n \"value\": \"vtex-service::checkout::stable\"\n },\n {\n \"name\": \"conditions\",\n \"value\": \"[{\\\"id\\\":\\\"1\\\",\\\"value\\\":33.99}]\"\n },\n {\n \"name\": \"postbackStatusUrl\",\n \"value\": \"https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1560170656517/notifications/transaction-status?an=b2bfaststoredev\"\n },\n {\n \"name\": \"currencyCode\",\n \"value\": \"USD\"\n },\n {\n \"name\": \"shopperInteraction\",\n \"value\": \"ecommerce\"\n },\n {\n \"name\": \"lastTransitionDate\",\n \"value\": \"9/8/2025 4:46:56 PM\"\n },\n {\n \"name\": \"TotalTimeSpentInTransitionsUntilThisTransition\",\n \"value\": \"16667.4862\"\n },\n {\n \"name\": \"channel\",\n \"value\": \"B2BFASTSTOREDEV\"\n },\n {\n \"name\": \"salesChannel\",\n \"value\": \"1\"\n },\n {\n \"name\": \"orderGroup\",\n \"value\": \"1560170656517\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"parentMerchant\",\n \"value\": \"13cfb648-f0a2-4e8f-818e-e3e9c7538b0d\"\n },\n {\n \"name\": \"orderId\",\n \"value\": \"2C4BF3F0A5C34B20A229AAC8262732CE\"\n },\n {\n \"name\": \"ip\",\n \"value\": \"3.229.80.75\"\n },\n {\n \"name\": \"userAgent\",\n \"value\": \"PostmanRuntime/7.39.0\"\n },\n {\n \"name\": \"acceptHeader\",\n \"value\": \"*/*\"\n },\n {\n \"name\": \"cart\",\n \"value\": \"{\\\"items\\\":[{\\\"id\\\":\\\"88\\\",\\\"name\\\":\\\"Combination Spanner Set Storage\\\",\\\"value\\\":3399,\\\"quantity\\\":1,\\\"priceTags\\\":[{\\\"name\\\":\\\"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\\\",\\\"value\\\":-3.40,\\\"isPercentual\\\":false}],\\\"components\\\":null,\\\"commission\\\":0.0,\\\"freightCommission\\\":0.0,\\\"sellerChain\\\":null,\\\"shippingDiscount\\\":0,\\\"discount\\\":-340,\\\"refId\\\":\\\"88\\\",\\\"productId\\\":\\\"56\\\",\\\"sellingPrice\\\":30.59,\\\"sellerId\\\":\\\"1\\\",\\\"dockId\\\":\\\"1\\\",\\\"categoryId\\\":\\\"1\\\",\\\"categoryName\\\":\\\"Category\\\",\\\"deliveryChannel\\\":\\\"delivery\\\",\\\"deliveryType\\\":\\\"Entrega Soberana\\\",\\\"deliverySlaInMinutes\\\":1440,\\\"deliveryWindow\\\":null,\\\"tax\\\":0,\\\"freight\\\":100}],\\\"sellers\\\":[{\\\"id\\\":\\\"1\\\",\\\"name\\\":\\\"VTEX\\\",\\\"documentType\\\":\\\"CNPJ\\\",\\\"document\\\":null}],\\\"freight\\\":100,\\\"shippingdate\\\":null,\\\"shippingestimated\\\":\\\"1bd\\\",\\\"orderUrl\\\":\\\"http://b2bfaststoredev.vtexcommercestable.com.br/admin/checkout/#/orders?q=1560170656517\\\",\\\"tax\\\":0,\\\"isGiftRegistry\\\":null,\\\"giftRegistryDescription\\\":null,\\\"giftRegistryId\\\":null,\\\"isPickupStore\\\":null,\\\"isCallCenter\\\":null}\"\n },\n {\n \"name\": \"shippingData\",\n \"value\": \"{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null}\"\n },\n {\n \"name\": \"postPurchaseOperationMode\",\n \"value\": \"Total\"\n },\n {\n \"name\": \"retainPartialSettlements\",\n \"value\": \"False\"\n },\n {\n \"name\": \"nativeSplitEnabled\",\n \"value\": \"False\"\n },\n {\n \"name\": \"clientProfileData\",\n \"value\": \"{\\\"email\\\":null,\\\"firstName\\\":\\\"Frederic\\\",\\\"lastName\\\":\\\"Kessler\\\",\\\"document\\\":\\\"22736794/000199\\\",\\\"phone\\\":\\\"3834600495\\\",\\\"corporateName\\\":null,\\\"tradeName\\\":null,\\\"corporateDocument\\\":null,\\\"stateInscription\\\":null,\\\"postalCode\\\":\\\"22250-040\\\",\\\"address\\\":{\\\"receiverName\\\":\\\"Marla Singer\\\",\\\"postalCode\\\":\\\"22250040\\\",\\\"city\\\":\\\"Bobbyborough\\\",\\\"state\\\":\\\"SP\\\",\\\"country\\\":\\\"BRA\\\",\\\"street\\\":\\\"Marvin Glens\\\",\\\"number\\\":\\\"697\\\",\\\"neighborhood\\\":\\\"-\\\",\\\"complement\\\":\\\"-\\\",\\\"reference\\\":null},\\\"gender\\\":null,\\\"birthDate\\\":null,\\\"createdDate\\\":\\\"2025-08-19T12:55:37.8475373Z\\\",\\\"corporatePhone\\\":null,\\\"isCorporate\\\":false,\\\"documentType\\\":\\\"CNPJ\\\",\\\"id\\\":\\\"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\\\"}\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"shopperInteraction\": \"ecommerce\",\n \"ipAddress\": \"3.229.80.75\",\n \"sessionId\": null,\n \"macId\": null,\n \"vtexFingerprint\": null,\n \"chargeback\": null,\n \"whiteSignature\": null,\n \"owner\": \"vtex-service::checkout::stable\",\n \"orderId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"userAgent\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"acceptHeader\": \"*/*\",\n \"antifraudTid\": null,\n \"antifraudResponse\": null,\n \"antifraudReference\": null,\n \"antifraudAffiliationId\": null,\n \"channel\": \"B2BFASTSTOREDEV\",\n \"salesChannel\": \"1\",\n \"urn\": null,\n \"softDescriptor\": null,\n \"markedForRecurrence\": false,\n \"buyer\": null\n}" - } - ] - }, - { - "name": "Get Order Group", - "request": { - "method": "GET", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/order-system/orders/order-group/{{my_orderGroup}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "order-system", - "orders", - "order-group", - "{{my_orderGroup}}" - ] - }, - "description": "This endpoint retrieves the details of an order group.\n\n---\n\n### Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.myvtex.com/api/order-system/orders/order-group/{{my_orderGroup}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **Content-Type**: `application/vnd.vtex.create-budget+json`\n \n\n### Paramenters\n\n| Parameter | **Type** | Required | Description |\n| --- | --- | --- | --- |\n| `my_orderGroup` | `string` | Yes | Order group identifier. |\n\n---\n\n### Response body\n\n``` json\n[\n {\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"VTEX\",\n \"logo\": \"\",\n \"subSellerId\": \"1\",\n \"fulfillmentEndpoint\": \"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=b2bfaststoredev\"\n }\n ],\n \"receiptData\": {\n \"ReceiptCollection\": [\n {\n \"ReceiptType\": \"authorizePayment\",\n \"Date\": \"2025-09-08T16:46:45.3342331Z\",\n \"ReceiptToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": null\n },\n {\n \"ReceiptType\": \"settlePayment\",\n \"Date\": \"2025-09-08T16:46:56.8172171Z\",\n \"ReceiptToken\": \"4C45295FB5184611B88A3EE754C988EA\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017115Z\",\n \"ReceiptToken\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017154Z\",\n \"ReceiptToken\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n }\n ]\n },\n \"sequence\": \"656517\",\n \"marketPlaceOrderId\": \"\",\n \"origin\": 0,\n \"items\": [\n {\n \"sellerSku\": \"88\",\n \"priceTable\": null,\n \"priceValidUntil\": \"2026-09-08T16:46:40Z\",\n \"callCenterOperator\": null,\n \"commission\": 0,\n \"freightCommission\": 0,\n \"taxCode\": \"1\",\n \"catalogProvider\": \"vrn:vtex.catalog-api-proxy:-:b2bfaststoredev:master:/proxy/authenticated/catalog/pvt/sku/stockkeepingunitbyid/88\",\n \"bundleItems\": [],\n \"components\": [],\n \"costPrice\": null,\n \"lockId\": null,\n \"uniqueId\": \"E0C828E7E81E4466AE92C1CBA6D872E0\",\n \"id\": \"88\",\n \"productId\": \"56\",\n \"productRefId\": \"88\",\n \"refId\": \"88\",\n \"ean\": null,\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"tax\": 0,\n \"customTax\": 0,\n \"price\": 3399,\n \"listPrice\": 3399,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 3059,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": {\n \"cubicweight\": 1.0,\n \"height\": 10.0,\n \"length\": 10.0,\n \"weight\": 10.0,\n \"width\": 10.0\n },\n \"brandName\": \"Precision Pro\",\n \"brandId\": \"2000001\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null,\n \"categoriesIds\": \"/1/\",\n \"productClusterId\": \"137\",\n \"commercialConditionId\": \"1\"\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Category\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [\n {\n \"name\": \"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\",\n \"value\": -340,\n \"rawValue\": -3.40,\n \"isPercentual\": false,\n \"identifier\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"owner\": \"b2bfaststoredev\"\n }\n ],\n \"availability\": \"available\",\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 3059,\n \"total\": 3059,\n \"sellingPrices\": [\n {\n \"value\": 3059,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n }\n }\n ],\n \"giftRegistryData\": null,\n \"contextData\": {\n \"loggedIn\": false,\n \"hasAccessToOrderFormEnabledByLicenseManager\": false,\n \"userAgent\": \"PostmanRuntime/7.39.0\",\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"recaptchaScore\": null\n },\n \"marketPlaceOrderGroup\": null,\n \"marketplaceServicesEndpoint\": null,\n \"orderFormId\": \"2a7b348c-e023-4613-ac02-d3575deab1a1\",\n \"affiliateId\": \"\",\n \"status\": \"\",\n \"callCenterOperator\": \"\",\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"creationVersion\": \"2.346.5.0\",\n \"creationEnvironment\": \"STABLE\",\n \"lastChangeVersion\": \"1.169.2.0\",\n \"workflowInstanceId\": \"c75c182e-eb4a-49e4-ad34-bbd38095f18c\",\n \"workflowInstanceGroupId\": null,\n \"marketplacePaymentValue\": null,\n \"marketplacePaymentReferenceValue\": null,\n \"marketplace\": null,\n \"orderId\": \"1560170656517-01\",\n \"orderGroup\": \"1560170656517\",\n \"state\": \"invoiced\",\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560170656517-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 3159,\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 3399\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": -340\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 100\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"johnson.kozey@yahoo.com\",\n \"firstName\": \"Frederic\",\n \"lastName\": \"Kessler\",\n \"document\": \"22736794/000199\",\n \"documentType\": \"CNPJ\",\n \"phone\": \"3834600495\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": true,\n \"profileErrorOnLoading\": false,\n \"customerClass\": null,\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"isProspect\": false\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [\n {\n \"id\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"name\": \"Pagamento a vista\",\n \"featured\": false,\n \"description\": null,\n \"matchedParameters\": {\n \"product@CatalogSystem\": \"54|exclusive\",\n \"paymentMethodId\": \"17\"\n },\n \"additionalInfo\": null\n }\n ]\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Entrega Soberana\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"slas\": [\n {\n \"id\": \"Entrega Soberana\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Entrega Soberana\",\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"shippingEstimate\": \"1bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 100,\n \"listPrice\": 100,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\"\n }\n ],\n \"shipsTo\": [\n \"USA\",\n \"BRA\"\n ],\n \"itemId\": \"88\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ],\n \"price\": 100,\n \"listPrice\": 100,\n \"shippingEstimate\": \"1bd\",\n \"dockEstimate\": \"0bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"deliveryCompany\": null,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\",\n \"sellingPrice\": 100,\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"deliveryWindow\": null,\n \"pickupPointId\": null,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupDistance\": null\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"trackingHints\": [],\n \"pickupPoints\": [],\n \"contactInformation\": [\n {\n \"id\": \"3b93a926fea84c62ae309882a03e909b\",\n \"firstName\": \"Marla\",\n \"lastName\": \"Singer\"\n },\n {\n \"id\": \"fdace46db89346dc8493aa693a5962dc\",\n \"firstName\": \"Robert\",\n \"lastName\": \"Paulson\"\n }\n ],\n \"contactsInfo\": [\n {\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"contacts\": [\n \"fdace46db89346dc8493aa693a5962dc\",\n \"3b93a926fea84c62ae309882a03e909b\"\n ],\n \"receiveWindows\": []\n }\n ],\n \"isFOB\": null\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"merchantName\": \"B2BFASTSTOREDEV\",\n \"payments\": [\n {\n \"id\": \"4CB7873069554734969679E47505DD43\",\n \"paymentSystem\": \"17\",\n \"paymentSystemName\": \"Promissory\",\n \"value\": 3159,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 3159,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": \"promissory\",\n \"dueDate\": null,\n \"paymentOrigin\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentDetails\": []\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": {\n \"locale\": \"pt-BR\",\n \"optinNewsLetter\": false,\n \"savePersonalData\": false,\n \"savePaymentData\": false\n },\n \"commercialConditionData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"USA\",\n \"timeZone\": \"Eastern Standard Time\",\n \"currencyCode\": \"USD\",\n \"currencyLocale\": 1033,\n \"currencySymbol\": \"$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \".\",\n \"currencyGroupSeparator\": \",\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": {\n \"address\": null,\n \"settleInvoices\": [\n \"1757350014\"\n ],\n \"invoices\": {\n \"1757350014\": {\n \"type\": \"Output\",\n \"invoiceNumber\": \"1757350014\"\n }\n }\n },\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"88\",\n \"seller\": \"1\",\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"productId\": \"56\",\n \"refId\": \"88\",\n \"ean\": null,\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"assemblyOptions\": []\n }\n ]\n },\n \"taxData\": null,\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"order\",\n \"id\": null\n },\n \"fields\": [\n {\n \"name\": \"poNumber\",\n \"value\": \"PO1\",\n \"refId\": \"PO1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"E0C828E7E81E4466AE92C1CBA6D872E0\"\n },\n \"fields\": [\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n }\n ]\n },\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"purchaseAgentData\": {\n \"purchaseAgents\": [\n {\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"versionId\": \"\",\n \"persona\": \"BUYER\",\n \"unitId\": \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\"\n }\n ]\n },\n \"budgetData\": {\n \"unitAllocations\": {\n \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\": [\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c3d4-966b-7519-8cdc-0867f99581c4\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -410354\n }\n },\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c267-1c3c-70ef-9fdf-5572fd08e70e\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -415282\n }\n }\n ]\n }\n },\n \"authorizationPolicyData\": {\n \"status\": \"accepted\",\n \"deniedPolicies\": [],\n \"pendingPolicies\": []\n },\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"9e2d3530482e49f8bd0e8e9d97ee2f36@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:46:42.0195859Z\",\n \"lastChange\": \"2025-09-08T16:46:58.1025748Z\",\n \"timeZoneCreationDate\": \"2025-09-08T12:46:42.0195859\",\n \"timeZoneLastChange\": \"2025-09-08T12:46:58.1025748\",\n \"isCompleted\": true,\n \"hostName\": \"b2bfaststoredev\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:46:40.1383799Z\",\n \"marketplaceRequestedCancellationWindow\": null\n }\n]\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `sellers`| `array` | Sellers linked to the order.||| ↳ `sellers[]` | `object` | A seller entry. | |\n| ↳ ↳ `sellers[].id` | `string` | Seller identifier. | |\n| ↳ ↳ `sellers[].name` | `string` | Seller display name. | |\n| ↳ ↳ `sellers[].logo` | `string` | URL for seller logo (may be empty). | |\n| ↳ ↳ `sellers[].subSellerId` | `string` | Sub‑seller identifier (if applicable). | |\n| ↳ ↳ `sellers[].fulfillmentEndpoint` | `string` | Fulfillment API endpoint URL. | |\n| `receiptData` | `object` | Receipts related to payment lifecycle. | |\n| ↳ `receiptData.ReceiptCollection` | `array` | Collection of receipt entries. | |\n| ↳ ↳ `receiptData.ReceiptCollection[]` | `object` | A receipt event. | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].ReceiptType` | `string` | Receipt type (e.g., `authorizePayment`, `settlePayment`, `budgetConfirmation`). | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].Date` | `string` | Event timestamp (UTC). | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].ReceiptToken` | `string` | Unique receipt token/ID. | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].Source` | `string` | Source of the receipt event. | |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].InvoiceNumber` | `string` | Related invoice number, if any. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].TransactionId` | `string` | Related transaction ID. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].MerchantName` | `string ` | Merchant name, if present. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].SellerOrderId` | `string` | Seller order ID, if present. |\n| ↳ ↳ ↳ `receiptData.ReceiptCollection[].ValueAsInt` | `number` | Value associated with the event (cents). |\n| `sequence` | `string` | Order sequence number. | |\n| `marketPlaceOrderId` | `string` | Marketplace order ID (may be empty). | |\n| `origin` | `number` | Origin code for the order. | |\n| `items` | `array` | Line items in the order. | |\n| ↳ `items[]` | `object` | An item (SKU) in the order. | |\n| ↳ ↳ `items[].sellerSku` | `string` | Seller’s SKU code. | |\n| ↳ ↳ `items[].priceTable` | `string ` | Price table identifier, if used. |\n| ↳ ↳ `items[].priceValidUntil` | `string` | Price validity timestamp (UTC). | |\n| ↳ ↳ `items[].callCenterOperator` | `string` | Operator who applied changes, if any. |\n| ↳ ↳ `items[].commission` | `number` | Commission amount (cents). | |\n| ↳ ↳ `items[].freightCommission` | `number` | Freight commission amount (cents). | |\n| ↳ ↳ `items[].taxCode` | `string` | Tax code for the item. | |\n| ↳ ↳ `items[].catalogProvider` | `string` | Catalog provider reference (URN/URL). | |\n| ↳ ↳ `items[].bundleItems` | `array` | Bundle components (if SKU is a bundle). | |\n| ↳ ↳ `items[].components` | `array` | Assembly components (if applicable). | |\n| ↳ ↳ `items[].costPrice` | `number` | Cost price (cents), if known. |\n| ↳ ↳ `items[].lockId` | `string` | Lock identifier for pricing/availability. |\n| ↳ ↳ `items[].uniqueId` | `string` | Unique identifier for this line item. | |\n| ↳ ↳ `items[].id` | `string` | SKU ID. | |\n| ↳ ↳ `items[].productId` | `string` | Product ID. | |\n| ↳ ↳ `items[].productRefId` | `string` | Product reference code. | |\n| ↳ ↳ `items[].refId` | `string` | SKU reference code. | |\n| ↳ ↳ `items[].ean` | `string` | EAN barcode, if any. |\n| ↳ ↳ `items[].name` | `string` | Product name. | |\n| ↳ ↳ `items[].skuName` | `string` | SKU name/variant. | |\n| ↳ ↳ `items[].modalType` | `string ` | Presentation/modal type, if any. |\n| ↳ ↳ `items[].parentItemIndex` | `number` | Parent line index (if child of a kit). |\n| ↳ ↳ `items[].parentAssemblyBinding` | `string` | Parent assembly binding, if any. |\n| ↳ ↳ `items[].assemblies` | `array` | Assembly selections. | |\n| ↳ ↳ `items[].tax` | `number` | Tax amount (cents) for the item. | |\n| ↳ ↳ `items[].customTax` | `number` | Additional/custom tax (cents). | |\n| ↳ ↳ `items[].price` | `number` | Base price (cents). | |\n| ↳ ↳ `items[].listPrice` | `number` | List price (cents). | |\n| ↳ ↳ `items[].manualPrice` | `number` | Manually overridden price (cents). |\n| ↳ ↳ `items[].manualPriceAppliedBy` | `string` | User who applied manual price. |\n| ↳ ↳ `items[].sellingPrice` | `number` | Final selling price (cents). | |\n| ↳ ↳ `items[].rewardValue` | `number` | Reward/loyalty value (cents). | |\n| ↳ ↳ `items[].isGift` | `boolean` | Indicates if the item is a gift. | |\n| ↳ ↳ `items[].additionalInfo` | `object` | Extra metadata about the item. | |\n| ↳ ↳ ↳ `items[].additionalInfo.dimension` | `object` | Physical dimensions/weight. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.cubicweight` | `number` | Cubic weight. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.height` | `number` | Height. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.length` | `number` | Length. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.weight` | `number` | Weight. | |\n| ↳ ↳ ↳ ↳ `items[].additionalInfo.dimension.width` | `number` | Width. | |\n| ↳ ↳ ↳ `items[].additionalInfo.brandName` | `string` | Brand name. | |\n| ↳ ↳ ↳ `items[].additionalInfo.brandId` | `string` | Brand identifier. | |\n| ↳ ↳ ↳ `items[].additionalInfo.offeringInfo` | `string | null` | Offering info, if used. |\n| ↳ ↳ ↳ `items[].additionalInfo.offeringType` | `string | null` | Offering type. |\n| ↳ ↳ ↳ `items[].additionalInfo.offeringTypeId` | `string | null` | Offering type ID. |\n| ↳ ↳ ↳ `items[].additionalInfo.categoriesIds` | `string` | Category path IDs (e.g., `\"/1/\"`). | |\n| ↳ ↳ ↳ `items[].additionalInfo.productClusterId` | `string` | Product cluster identifier. | |\n| ↳ ↳ ↳ `items[].additionalInfo.commercialConditionId` | `string` | Commercial condition ID. | |\n| ↳ ↳ `items[].preSaleDate` | `string` | Pre‑sale availability date, if set. |\n| ↳ ↳ `items[].productCategoryIds` | `string` | Category path IDs for the product. | |\n| ↳ ↳ `items[].productCategories` | `object` | Map of categoryId → category name. | |\n| ↳ ↳ `items[].quantity` | `number` | Quantity ordered. | |\n| ↳ ↳ `items[].seller` | `string` | Seller ID for this line. | |\n| ↳ ↳ `items[].sellerChain` | `array` | Seller chain involved in fulfillment. | |\n| ↳ ↳ `items[].imageUrl` | `string` | SKU image URL. | |\n| ↳ ↳ `items[].detailUrl` | `string` | Product detail page path. | |\n| ↳ ↳ `items[].attachments` | `array` | Attached customization info. | |\n| ↳ ↳ `items[].attachmentOfferings` | `array` | Available attachment options. | |\n| ↳ ↳ `items[].offerings` | `array` | Additional offerings for the item. | |\n| ↳ ↳ `items[].priceTags` | `array` | Discounts/surcharges applied. | |\n| ↳ ↳ ↳ `items[].priceTags[]` | `object` | A price tag record. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].name` | `string` | Price tag name. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].value` | `number` | Value in cents (negatives = discount). | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].rawValue` | `number` | Value in currency units (e.g., dollars). | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].isPercentual` | `boolean` | Whether the tag is a percentage. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].identifier` | `string` | Identifier for the rule/benefit. | |\n| ↳ ↳ ↳ ↳ `items[].priceTags[].owner` | `string` | Owner account of the tag. | |\n| ↳ ↳ `items[].availability` | `string` | Stock status (e.g., `available`). | |\n| ↳ ↳ `items[].measurementUnit` | `string` | Unit of measure (e.g., `un`). | |\n| ↳ ↳ `items[].unitMultiplier` | `number` | Multiplier for unit conversions. | |\n| ↳ ↳ `items[].manufacturerCode` | `string` | Manufacturer code, if any. |\n| ↳ ↳ `items[].priceDefinition` | `object` | Price breakdown used to compute totals. | |\n| ↳ ↳ ↳ `items[].priceDefinition.calculatedSellingPrice` | `number` | Computed selling price (cents). | |\n| ↳ ↳ ↳ `items[].priceDefinition.total` | `number` | Total amount considered (cents). | |\n| ↳ ↳ ↳ `items[].priceDefinition.sellingPrices` | `array` | Tiered selling price components. | |\n| ↳ ↳ ↳ ↳ `items[].priceDefinition.sellingPrices[]` | `object` | A selling price tier. | |\n| ↳ ↳ ↳ ↳ ↳ `items[].priceDefinition.sellingPrices[].value` | `number` | Price value (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `items[].priceDefinition.sellingPrices[].quantity` | `number` | Quantity covered by the tier. | |\n| ↳ ↳ ↳ `items[].priceDefinition.reason` | `string` | Reason or rule used, if any. |\n| `giftRegistryData` | `object` | Gift registry data, when present. |\n| `contextData` | `object` | Context of the checkout/session. | |\n| ↳ `contextData.loggedIn` | `boolean` | Whether user was authenticated. | |\n| ↳ `contextData.hasAccessToOrderFormEnabledByLicenseManager` | `boolean` | License‑based access flag. | |\n| ↳ `contextData.userAgent` | `string` | Client user agent. | |\n| ↳ `contextData.userId` | `string` | User ID (UUID). | |\n| ↳ `contextData.recaptchaScore` | `number` | reCAPTCHA score, if evaluated. |\n| `marketPlaceOrderGroup` | `string` | Marketplace order group ID. |\n| `marketplaceServicesEndpoint` | `string` | Endpoint for marketplace services. |\n| `orderFormId` | `string` | Order form identifier (UUID). | |\n| `affiliateId` | `string` | Affiliate identifier, if any. | |\n| `status` | `string` | Order status label (may be empty). | |\n| `callCenterOperator` | `string` | Operator code/name (may be empty). | |\n| `userProfileId` | `string` | User profile ID (UUID). | |\n| `creationVersion` | `string` | Platform version at creation. | |\n| `creationEnvironment` | `string` | Environment at creation (e.g., `STABLE`). | |\n| `lastChangeVersion` | `string` | Platform version at last change. | |\n| `workflowInstanceId` | `string` | Workflow instance ID. | |\n| `workflowInstanceGroupId` | `string` | Workflow group ID, if any. |\n| `marketplacePaymentValue` | `number` | Marketplace payment value (cents). |\n| `marketplacePaymentReferenceValue` | `number` | Marketplace reference value (cents). |\n| `marketplace` | `object` | Marketplace metadata. |\n| `orderId` | `string` | Order identifier. | |\n| `orderGroup` | `string` | Logical order group identifier. | |\n| `state` | `string` | Order state (e.g., `invoiced`). | |\n| `isCheckedIn` | `boolean` | Indicates in‑store check‑in. | |\n| `sellerOrderId` | `string` | Seller’s order ID. | |\n| `storeId` | `string` | Store identifier, if any. |\n| `checkedInPickupPointId` | `string` | Pickup point ID, if checked in. |\n| `value` | `number` | Grand total value (cents). | |\n| `totals` | `array` | Aggregated totals by category. | |\n| ↳ `totals[]` | `object` | A total line. | |\n| ↳ ↳ `totals[].id` | `string` | Total code (e.g., `Items`, `Discounts`). | |\n| ↳ ↳ `totals[].name` | `string` | Human‑readable name. | |\n| ↳ ↳ `totals[].value` | `number` | Amount in cents (discounts negative). | |\n| `clientProfileData` | `object` | Shopper profile details. | |\n| ↳ `clientProfileData.email` | `string` | Email address. | |\n| ↳ `clientProfileData.firstName` | `string` | First name. | |\n| ↳ `clientProfileData.lastName` | `string` | Last name. | |\n| ↳ `clientProfileData.document` | `string` | Tax/document number. | |\n| ↳ `clientProfileData.documentType` | `string` | Document type (e.g., `CNPJ`). | |\n| ↳ `clientProfileData.phone` | `string` | Phone number. | |\n| ↳ `clientProfileData.corporateName` | `string` | Corporate legal name. |\n| ↳ `clientProfileData.tradeName` | `string` | Corporate trade name. |\n| ↳ `clientProfileData.corporateDocument` | `string` | Corporate document number. |\n| ↳ `clientProfileData.stateInscription` | `string` | State registration. |\n| ↳ `clientProfileData.corporatePhone` | `string` | Corporate phone. |\n| ↳ `clientProfileData.isCorporate` | `boolean` | Corporate account flag. | |\n| ↳ `clientProfileData.profileCompleteOnLoading` | `boolean` | Profile loaded as complete. | |\n| ↳ `clientProfileData.profileErrorOnLoading` | `boolean` | Error while loading profile. | |\n| ↳ `clientProfileData.customerClass` | `string` | Customer segmentation/class. |\n| ↳ `clientProfileData.userProfileId` | `string` | Profile ID (UUID). | |\n| ↳ `clientProfileData.isProspect` | `boolean` | Prospect flag. | |\n| `ratesAndBenefitsData` | `object` | Promotions and benefits applied. | |\n| ↳ `ratesAndBenefitsData.rateAndBenefitsIdentifiers` | `array` | Identifiers of applied benefits. | |\n| ↳ ↳ `...[]` | `object` | A benefit rule. | |\n| ↳ ↳ ↳ `id` | `string` | Benefit identifier (UUID). | |\n| ↳ ↳ ↳ `name` | `string` | Rule/promotion name. | |\n| ↳ ↳ ↳ `featured` | `boolean` | Featured promotion flag. | |\n| ↳ ↳ ↳ `description` | `string` | Description, if any. |\n| ↳ ↳ ↳ `matchedParameters` | `object` | Parameters that matched the rule. | |\n| ↳ ↳ ↳ ↳ `matchedParameters[\"product@CatalogSystem\"]` | `string` | Product/category match token. | |\n| ↳ ↳ ↳ ↳ `matchedParameters.paymentMethodId` | `string` | Payment method ID used. | |\n| ↳ ↳ ↳ `additionalInfo` | `string` | Extra info. |\n| `shippingData` | `object` | Shipping addresses, logistics, and contacts. | |\n| ↳ `shippingData.address` | `object` | Chosen shipping address. | |\n| ↳ ↳ `shippingData.address.addressType` | `string` | Address type (e.g., `residential`). | |\n| ↳ ↳ `shippingData.address.receiverName` | `string` | Recipient name. | |\n| ↳ ↳ `shippingData.address.addressId` | `string` | Address ID. | |\n| ↳ ↳ `shippingData.address.isDisposable` | `boolean` | Temporary/one‑time address flag. | |\n| ↳ ↳ `shippingData.address.postalCode` | `string` | Postal/ZIP code. | |\n| ↳ ↳ `shippingData.address.city` | `string` | City. | |\n| ↳ ↳ `shippingData.address.state` | `string` | State/region code. | |\n| ↳ ↳ `shippingData.address.country` | `string` | Country code (ISO‑3). | |\n| ↳ ↳ `shippingData.address.street` | `string` | Street. | |\n| ↳ ↳ `shippingData.address.number` | `string` | Street number. | |\n| ↳ ↳ `shippingData.address.neighborhood` | `string` | Neighborhood/district. | |\n| ↳ ↳ `shippingData.address.complement` | `string` | Address complement. | |\n| ↳ ↳ `shippingData.address.reference` | `string` | Reference/landmark. |\n| ↳ ↳ `shippingData.address.geoCoordinates` | `array` | `[longitude, latitude]`. | |\n| ↳ `shippingData.logisticsInfo` | `array` | Logistics data per item. | |\n| ↳ ↳ `...[]` | `object` | Logistics record for an item index. | |\n| ↳ ↳ ↳ `itemIndex` | `number` | Item index in `items`. | |\n| ↳ ↳ ↳ `selectedSla` | `string` | Selected SLA ID/name. | |\n| ↳ ↳ ↳ `selectedDeliveryChannel` | `string` | Delivery channel (e.g., `delivery`). | |\n| ↳ ↳ ↳ `addressId` | `string` | Address used for this SLA. | |\n| ↳ ↳ ↳ `slas` | `array` | Available SLAs. | |\n| ↳ ↳ ↳ ↳ `slas[]` | `object` | An SLA option. | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | SLA identifier. | |\n| ↳ ↳ ↳ ↳ ↳ `deliveryChannel` | `string` | Channel (delivery/pickup). | |\n| ↳ ↳ ↳ ↳ ↳ `name` | `string` | SLA name. | |\n| ↳ ↳ ↳ ↳ ↳ `deliveryIds` | `array` | Carrier/warehouse legs. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ `deliveryIds[]` | `object` | A delivery leg. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `courierId` | `string` | Carrier ID. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `warehouseId` | `string` | Warehouse ID. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `dockId` | `string` | Dock ID. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `courierName` | `string` | Carrier name. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `quantity` | `number` | Quantity moved in this leg. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `kitItemDetails` | `array` | Kit leg details, if any. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ ↳ `accountCarrierName` | `string` | Account that owns the carrier. | |\n| ↳ ↳ ↳ ↳ ↳ `shippingEstimate` | `string` | Time estimate (e.g., `1bd`). | |\n| ↳ ↳ ↳ ↳ ↳ `shippingEstimateDate` | `string` | Estimated delivery date (UTC). | |\n| ↳ ↳ ↳ ↳ ↳ `lockTTL` | `string` | Lock TTL (e.g., `10d`). | |\n| ↳ ↳ ↳ ↳ ↳ `availableDeliveryWindows` | `array` | Available scheduling windows. | |\n| ↳ ↳ ↳ ↳ ↳ `deliveryWindow` | `object | null` | Selected window, if any. |\n| ↳ ↳ ↳ ↳ ↳ `price` | `number` | Freight price (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `listPrice` | `number` | Freight list price (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `tax` | `number` | Freight tax (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `pickupStoreInfo` | `object` | Pickup store info (if pickup). | |\n| ↳ ↳ ↳ ↳ ↳ ↳ `isPickupStore` | `boolean` | Indicates pickup store. | |\n| ↳ ↳ ↳ ↳ ↳ ↳ `friendlyName` | `string` | Store name. |\n| ↳ ↳ ↳ ↳ ↳ ↳ `address` | `object` | Store address, if known. |\n| ↳ ↳ ↳ ↳ ↳ ↳ `additionalInfo` | `string` | Extra info. |\n| ↳ ↳ ↳ ↳ ↳ ↳ `dockId` | `string` | Store dock ID. |\n| ↳ ↳ ↳ ↳ ↳ `pickupPointId` | `string` | Pickup point identifier. |\n| ↳ ↳ ↳ ↳ ↳ `pickupDistance` | `number` | Distance to pickup point. | |\n| ↳ ↳ ↳ ↳ ↳ `polygonName` | `string` | SLA polygon name. | |\n| ↳ ↳ ↳ ↳ ↳ `transitTime` | `string` | Transit time string (e.g., `1bd`). | |\n| ↳ ↳ ↳ `shipsTo` | `array` | Countries the SLA ships to. | |\n| ↳ ↳ ↳ `itemId` | `string` | SKU ID for this logistics record. | |\n| ↳ ↳ ↳ `deliveryChannels` | `array` | Available delivery channels. | |\n| ↳ ↳ ↳ ↳ `deliveryChannels[]` | `object` | Delivery channel entry. | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | Channel ID (e.g., `delivery`). | |\n| ↳ ↳ ↳ `price` | `number` | Selected SLA price (cents). | |\n| ↳ ↳ ↳ `listPrice` | `number` | Selected SLA list price (cents). | |\n| ↳ ↳ ↳ `shippingEstimate` | `string` | Selected SLA estimate. | |\n| ↳ ↳ ↳ `dockEstimate` | `string` | Dock processing estimate. | |\n| ↳ ↳ ↳ `shippingEstimateDate` | `string` | Estimated date (UTC). | |\n| ↳ ↳ ↳ `lockTTL` | `string` | Lock TTL for this selection. | |\n| ↳ ↳ ↳ `deliveryCompany` | `string` | Carrier company name, if known. |\n| ↳ ↳ ↳ `polygonName` | `string` | Polygon name. | |\n| ↳ ↳ ↳ `transitTime` | `string` | Transit time. | |\n| ↳ ↳ ↳ `sellingPrice` | `number` | Selected SLA selling price (cents). | |\n| ↳ ↳ ↳ `deliveryIds` | `array` | Selected legs (same schema as above). | |\n| ↳ ↳ ↳ `deliveryWindow` | `object` | Selected delivery window. |\n| ↳ ↳ ↳ `pickupPointId` | `string` | Selected pickup point. |\n| ↳ ↳ ↳ `pickupStoreInfo` | `object` | Selected pickup store info. | |\n| ↳ ↳ ↳ `pickupDistance` | `number` | Distance to pickup point. |\n| ↳ `shippingData.selectedAddresses` | `array` | Addresses selected during checkout. | |\n| ↳ `shippingData.availableAddresses` | `array` | Addresses available to the user. | |\n| ↳ `shippingData.trackingHints` | `array` | Tracking hints from carriers. | |\n| ↳ `shippingData.pickupPoints` | `array` | Available pickup points. | |\n| ↳ `shippingData.contactInformation` | `array` | People related to delivery. | |\n| ↳ ↳ `...[]` | `object` | A contact. | |\n| ↳ ↳ ↳ `id` | `string` | Contact ID. | |\n| ↳ ↳ ↳ `firstName` | `string` | First name. | |\n| ↳ ↳ ↳ `lastName` | `string` | Last name. | |\n| ↳ `shippingData.contactsInfo` | `array` | Address‑to‑contacts mappings. | |\n| ↳ ↳ `...[]` | `object` | A mapping entry. | |\n| ↳ ↳ ↳ `addressId` | `string` | Address ID. | |\n| ↳ ↳ ↳ `contacts` | `array` | Contact IDs. | |\n| ↳ ↳ ↳ `receiveWindows` | `array` | Preferred receiving windows. | |\n| ↳ `shippingData.isFOB` | `boolean` | Free‑On‑Board flag. |\n| `paymentData` | `object` | Payment instruments and transactions. | |\n| ↳ `paymentData.giftCards` | `array` | Gift cards used (if any). | |\n| ↳ `paymentData.transactions` | `array` | Transactions created for the order. | |\n| ↳ ↳ `...[]` | `object` | A transaction. | |\n| ↳ ↳ ↳ `isActive` | `boolean` | Whether the transaction is active. | |\n| ↳ ↳ ↳ `transactionId` | `string` | Transaction ID. | |\n| ↳ ↳ ↳ `merchantName` | `string` | Merchant name. | |\n| ↳ ↳ ↳ `payments` | `array` | Payments within the transaction. | |\n| ↳ ↳ ↳ ↳ `payments[]` | `object` | A payment record. | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | Payment ID. | |\n| ↳ ↳ ↳ ↳ ↳ `paymentSystem` | `string` | Payment system ID. | |\n| ↳ ↳ ↳ ↳ ↳ `paymentSystemName` | `string` | Payment system display name. | |\n| ↳ ↳ ↳ ↳ ↳ `value` | `number` | Amount charged (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `installments` | `number` | Number of installments. | |\n| ↳ ↳ ↳ ↳ ↳ `connectorResponses` | `object` | Raw gateway responses. | |\n| ↳ ↳ ↳ ↳ ↳ `referenceValue` | `number` | Reference value (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `cardHolder` | `string` | Cardholder name. |\n| ↳ ↳ ↳ ↳ ↳ `cardNumber` | `string` | Masked card number. |\n| ↳ ↳ ↳ ↳ ↳ `firstDigits` | `string` | BIN (first digits), if available. |\n| ↳ ↳ ↳ ↳ ↳ `lastDigits` | `string` | Last digits, if available. |\n| ↳ ↳ ↳ ↳ ↳ `cvv2` | `string` | CVV2 (never stored in production). |\n| ↳ ↳ ↳ ↳ ↳ `expireMonth` | `string` | Expiration month. |\n| ↳ ↳ ↳ ↳ ↳ `expireYear` | `string` | Expiration year. |\n| ↳ ↳ ↳ ↳ ↳ `url` | `string` | Payment URL, if any. |\n| ↳ ↳ ↳ ↳ ↳ `koinUrl` | `string` | Koin URL, if any. |\n| ↳ ↳ ↳ ↳ ↳ `tid` | `string` | Transaction TID. |\n| ↳ ↳ ↳ ↳ ↳ `redemptionCode` | `string` | Gift card redemption code. |\n| ↳ ↳ ↳ ↳ ↳ `giftCardId` | `string` | Gift card ID. |\n| ↳ ↳ ↳ ↳ ↳ `giftCardProvider` | `string` | Gift card provider. |\n| ↳ ↳ ↳ ↳ ↳ `giftCardAsDiscount` | `boolean` | Whether gift card acts as discount. |\n| ↳ ↳ ↳ ↳ ↳ `group` | `string` | Payment group (e.g., `promissory`). | |\n| ↳ ↳ ↳ ↳ ↳ `dueDate` | `string` | Due date for payment, if any. |\n| ↳ ↳ ↳ ↳ ↳ `paymentOrigin` | `string` | Origin channel of the payment. |\n| ↳ ↳ ↳ ↳ ↳ `accountId` | `string` | Gateway account ID. |\n| ↳ ↳ ↳ ↳ ↳ `parentAccountId` | `string` | Parent account ID. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceIdentificationNumber` | `string` | Bank boleto ID. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceIdentificationNumberFormatted` | `string` | Formatted boleto ID. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceBarCodeNumber` | `string` | Bank barcode number. |\n| ↳ ↳ ↳ ↳ ↳ `bankIssuedInvoiceBarCodeType` | `string` | Barcode type. |\n| ↳ ↳ ↳ ↳ ↳ `billingAddress` | `object` | Billing address. |\n| ↳ ↳ ↳ ↳ ↳ `paymentDetails` | `array` | Extra details, if any. | |\n| ↳ ↳ ↳ `sharedTransaction` | `boolean` | Whether transaction is shared. | |\n| `clientPreferencesData` | `object` | Shopper preferences. | |\n| ↳ `clientPreferencesData.locale` | `string` | Locale (e.g., `pt-BR`). | |\n| ↳ `clientPreferencesData.optinNewsLetter` | `boolean` | Newsletter opt‑in. | |\n| ↳ `clientPreferencesData.savePersonalData` | `boolean` | Save personal data preference. | |\n| ↳ `clientPreferencesData.savePaymentData` | `boolean` | Save payment data preference. | |\n| `commercialConditionData` | `object` | Applied commercial conditions. |\n| `marketingData` | `object` | Marketing/campaign data. |\n| `storePreferencesData` | `object` | Store localization and currency settings. | |\n| ↳ `storePreferencesData.countryCode` | `string` | Country code. | |\n| ↳ `storePreferencesData.timeZone` | `string` | Store time zone name. | |\n| ↳ `storePreferencesData.currencyCode` | `string` | Currency code (ISO‑4217). | |\n| ↳ `storePreferencesData.currencyLocale` | `number` | Windows/LCID locale code. | |\n| ↳ `storePreferencesData.currencySymbol` | `string` | Currency symbol. | |\n| ↳ `storePreferencesData.currencyFormatInfo` | `object` | Currency formatting rules. | |\n| ↳ ↳ `...currencyDecimalDigits` | `number` | Number of decimal digits. | |\n| ↳ ↳ `...currencyDecimalSeparator` | `string` | Decimal separator. | |\n| ↳ ↳ `...currencyGroupSeparator` | `string` | Thousands separator. | |\n| ↳ ↳ `...currencyGroupSize` | `number` | Grouping size. | |\n| ↳ ↳ `...startsWithCurrencySymbol` | `boolean` | Whether symbol prefixes value. | |\n| `openTextField` | `object` | Free‑form text fields. |\n| `invoiceData` | `object` | Invoice information. | |\n| ↳ `invoiceData.address` | `object` | Invoice address, if provided. |\n| ↳ `invoiceData.settleInvoices` | `array` | Invoice numbers to settle. | |\n| ↳ `invoiceData.invoices` | `object` | Map invoiceNumber → invoice object. | |\n| ↳ ↳ `invoiceData.invoices[\"1757350014\"]` | `object` | Example invoice entry. | |\n| ↳ ↳ ↳ `type` | `string` | Invoice type (e.g., `Output`). | |\n| ↳ ↳ ↳ `invoiceNumber` | `string` | Invoice number. | |\n| `itemMetadata` | `object` | Metadata for items in the order. | |\n| ↳ `itemMetadata.items` | `array` | Items metadata list. | |\n| ↳ ↳ `...[]` | `object` | Metadata for one SKU. | |\n| ↳ ↳ ↳ `id` | `string` | SKU ID. | |\n| ↳ ↳ ↳ `seller` | `string` | Seller ID. | |\n| ↳ ↳ ↳ `name` | `string` | Product name. | |\n| ↳ ↳ ↳ `skuName` | `string` | SKU name. | |\n| ↳ ↳ ↳ `productId` | `string` | Product ID. | |\n| ↳ ↳ ↳ `refId` | `string` | Reference ID. | |\n| ↳ ↳ ↳ `ean` | `string` | EAN code. |\n| ↳ ↳ ↳ `imageUrl` | `string` | Image URL. | |\n| ↳ ↳ ↳ `detailUrl` | `string` | PDP URL path. | |\n| ↳ ↳ ↳ `assemblyOptions` | `array` | Assembly options (if any). | |\n| `taxData` | `object` | Tax breakdown (when available). |\n| `customData` | `object` | Custom app/field data. | |\n| ↳ `customData.customApps` | `array` | Custom apps payloads. | |\n| ↳ `customData.customFields` | `array` | Custom fields at order/item scope. | |\n| ↳ ↳ `...[]` | `object` | A group of custom fields scoped to an entity. | |\n| ↳ ↳ ↳ `linkedEntity` | `object` | Entity this group attaches to. | |\n| ↳ ↳ ↳ ↳ `type` | `string` | Entity type (e.g., `order`, `item`). | |\n| ↳ ↳ ↳ ↳ `id` | `string` | Entity ID (e.g., item uniqueId). |\n| ↳ ↳ ↳ `fields` | `array` | Name/value pairs. | |\n| ↳ ↳ ↳ ↳ `fields[]` | `object` | A custom field. | |\n| ↳ ↳ ↳ ↳ ↳ `name` | `string` | Field name. | |\n| ↳ ↳ ↳ ↳ ↳ `value` | `string` | Field value. | |\n| ↳ ↳ ↳ ↳ ↳ `refId` | `string` | Reference identifier. | |\n| `hooksData` | `object` | Webhook processing data. |\n| `changeData` | `object` | Change feed information. |\n| `subscriptionData` | `object` | Subscription linkage. |\n| `merchantContextData` | `objectnull` | Merchant‑specific context. |\n| `purchaseAgentData` | `object` | Purchase agent (B2B) metadata. | |\n| ↳ `purchaseAgentData.purchaseAgents` | `array` | Agents associated to the order. | |\n| ↳ ↳ `...[]` | `object` | A purchase agent record. | |\n| ↳ ↳ ↳ `userId` | `string` | Agent user ID. | |\n| ↳ ↳ ↳ `versionId` | `string` | Version identifier. | |\n| ↳ ↳ ↳ `persona` | `string` | Persona (e.g., `BUYER`). | |\n| ↳ ↳ ↳ `unitId` | `string` | Organizational unit ID. | |\n| `budgetData` | `object` | Budget reservations/allocations. | |\n| ↳ `budgetData.unitAllocations` | `object` | Map unitId → allocations array. | |\n| ↳ ↳ `budgetData.unitAllocations[unitId]` | `array` | Allocations for a unit. | |\n| ↳ ↳ ↳ `...[]` | `object` | A budget allocation/reservation. | |\n| ↳ ↳ ↳ ↳ `budgetId` | `string` | Budget ID. | |\n| ↳ ↳ ↳ ↳ `allocationId` | `string` | Allocation ID. | |\n| ↳ ↳ ↳ ↳ `linkedEntity` | `object` | What this allocation links to. | |\n| ↳ ↳ ↳ ↳ ↳ `type` | `string` | Linked type (e.g., `poNumber`). | |\n| ↳ ↳ ↳ ↳ ↳ `id` | `string` | Linked ID (e.g., `PO1`). | |\n| ↳ ↳ ↳ ↳ `reservationId` | `string` | Reservation ID. | |\n| ↳ ↳ ↳ ↳ `reservedAmount` | `number` | Amount reserved (cents). | |\n| ↳ ↳ ↳ ↳ `budgetBalance` | `object` | Budget balance snapshot. | |\n| ↳ ↳ ↳ ↳ ↳ `amount` | `number` | Budget amount (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `totalUtilized` | `number` | Total utilized (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `remaining` | `number` | Remaining amount (cents, may be negative). | |\n| ↳ ↳ ↳ ↳ `allocationBalance` | `object` | Allocation balance snapshot. | |\n| ↳ ↳ ↳ ↳ ↳ `amount` | `number` | Allocation amount (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `totalUtilized` | `number` | Total utilized (cents). | |\n| ↳ ↳ ↳ ↳ ↳ `remaining` | `number` | Remaining amount (cents, may be negative). | |\n| `authorizationPolicyData` | `object` | Result of authorization policies. | |\n| ↳ `authorizationPolicyData.status` | `string` | Overall status (e.g., `accepted`). | |\n| ↳ `authorizationPolicyData.deniedPolicies` | `array` | Policies that denied (none here). | |\n| ↳ `authorizationPolicyData.pendingPolicies` | `array` | Policies pending (none here). | |\n| `salesChannel` | `string` | Sales channel identifier. | |\n| `followUpEmail` | `string` | Follow‑up email address (system). | |\n| `creationDate` | `string` | Order creation timestamp (UTC). | |\n| `lastChange` | `string` | Last update timestamp (UTC). | |\n| `timeZoneCreationDate` | `string` | Creation timestamp in store time zone. | |\n| `timeZoneLastChange` | `string` | Last change timestamp in store time zone. | |\n| `isCompleted` | `boolean` | Whether the order is completed. | |\n| `hostName` | `string` | Store account/hostname. | |\n| `merchantName` | `string` | Merchant name, if any. |\n| `userType` | `string` | User type label. | |\n| `roundingError` | `number` | Rounding adjustment (cents). | |\n| `allowEdition` | `boolean` | Whether order can be edited. | |\n| `allowCancellation` | `boolean` | Whether order can be canceled. | |\n| `isUserDataVisible` | `boolean` | Whether PII is visible in context. | |\n| `allowChangeSeller` | `boolean` | Whether seller can be changed. | |\n| `orderFormCreationDate` | `string` | Order form creation timestamp (UTC). | |\n| `marketplaceRequestedCancellationWindow` | `object` | Cancellation window requested by marketplace. |\n" - }, - "response": [ - { - "name": "200 OK", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/order-system/orders/order-group/{{my_orderGroup}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "order-system", - "orders", - "order-group", - "{{my_orderGroup}}" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "type": "text" - } - ], - "cookie": [ - { - "expires": "Invalid Date", - "domain": "", - "path": "" - } - ], - "body": "[\n {\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"VTEX\",\n \"logo\": \"\",\n \"subSellerId\": \"1\",\n \"fulfillmentEndpoint\": \"http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=b2bfaststoredev\"\n }\n ],\n \"receiptData\": {\n \"ReceiptCollection\": [\n {\n \"ReceiptType\": \"authorizePayment\",\n \"Date\": \"2025-09-08T16:46:45.3342331Z\",\n \"ReceiptToken\": \"ED371A1D978A4BDE8B295851DEC1FC2B\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": null\n },\n {\n \"ReceiptType\": \"settlePayment\",\n \"Date\": \"2025-09-08T16:46:56.8172171Z\",\n \"ReceiptToken\": \"4C45295FB5184611B88A3EE754C988EA\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"MerchantName\": \"B2BFASTSTOREDEV\",\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017115Z\",\n \"ReceiptToken\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n },\n {\n \"ReceiptType\": \"budgetConfirmation\",\n \"Date\": \"2025-09-08T16:46:57.4017154Z\",\n \"ReceiptToken\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"Source\": \"received\",\n \"InvoiceNumber\": null,\n \"TransactionId\": null,\n \"MerchantName\": null,\n \"SellerOrderId\": null,\n \"ValueAsInt\": 3159\n }\n ]\n },\n \"sequence\": \"656517\",\n \"marketPlaceOrderId\": \"\",\n \"origin\": 0,\n \"items\": [\n {\n \"sellerSku\": \"88\",\n \"priceTable\": null,\n \"priceValidUntil\": \"2026-09-08T16:46:40Z\",\n \"callCenterOperator\": null,\n \"commission\": 0,\n \"freightCommission\": 0,\n \"taxCode\": \"1\",\n \"catalogProvider\": \"vrn:vtex.catalog-api-proxy:-:b2bfaststoredev:master:/proxy/authenticated/catalog/pvt/sku/stockkeepingunitbyid/88\",\n \"bundleItems\": [],\n \"components\": [],\n \"costPrice\": null,\n \"lockId\": null,\n \"uniqueId\": \"E0C828E7E81E4466AE92C1CBA6D872E0\",\n \"id\": \"88\",\n \"productId\": \"56\",\n \"productRefId\": \"88\",\n \"refId\": \"88\",\n \"ean\": null,\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"modalType\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null,\n \"assemblies\": [],\n \"tax\": 0,\n \"customTax\": 0,\n \"price\": 3399,\n \"listPrice\": 3399,\n \"manualPrice\": null,\n \"manualPriceAppliedBy\": null,\n \"sellingPrice\": 3059,\n \"rewardValue\": 0,\n \"isGift\": false,\n \"additionalInfo\": {\n \"dimension\": {\n \"cubicweight\": 1.0,\n \"height\": 10.0,\n \"length\": 10.0,\n \"weight\": 10.0,\n \"width\": 10.0\n },\n \"brandName\": \"Precision Pro\",\n \"brandId\": \"2000001\",\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null,\n \"categoriesIds\": \"/1/\",\n \"productClusterId\": \"137\",\n \"commercialConditionId\": \"1\"\n },\n \"preSaleDate\": null,\n \"productCategoryIds\": \"/1/\",\n \"productCategories\": {\n \"1\": \"Category\"\n },\n \"quantity\": 1,\n \"seller\": \"1\",\n \"sellerChain\": [\n \"1\"\n ],\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"attachments\": [],\n \"attachmentOfferings\": [],\n \"offerings\": [],\n \"priceTags\": [\n {\n \"name\": \"discount@price-458cf5e4-c861-45df-9299-dba12e927666#3cec769a-f79c-43bc-a200-bf95a42730e3\",\n \"value\": -340,\n \"rawValue\": -3.40,\n \"isPercentual\": false,\n \"identifier\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"owner\": \"b2bfaststoredev\"\n }\n ],\n \"availability\": \"available\",\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1.0,\n \"manufacturerCode\": null,\n \"priceDefinition\": {\n \"calculatedSellingPrice\": 3059,\n \"total\": 3059,\n \"sellingPrices\": [\n {\n \"value\": 3059,\n \"quantity\": 1\n }\n ],\n \"reason\": null\n }\n }\n ],\n \"giftRegistryData\": null,\n \"contextData\": {\n \"loggedIn\": false,\n \"hasAccessToOrderFormEnabledByLicenseManager\": false,\n \"userAgent\": \"PostmanRuntime/7.39.0\",\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"recaptchaScore\": null\n },\n \"marketPlaceOrderGroup\": null,\n \"marketplaceServicesEndpoint\": null,\n \"orderFormId\": \"2a7b348c-e023-4613-ac02-d3575deab1a1\",\n \"affiliateId\": \"\",\n \"status\": \"\",\n \"callCenterOperator\": \"\",\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"creationVersion\": \"2.346.5.0\",\n \"creationEnvironment\": \"STABLE\",\n \"lastChangeVersion\": \"1.169.2.0\",\n \"workflowInstanceId\": \"c75c182e-eb4a-49e4-ad34-bbd38095f18c\",\n \"workflowInstanceGroupId\": null,\n \"marketplacePaymentValue\": null,\n \"marketplacePaymentReferenceValue\": null,\n \"marketplace\": null,\n \"orderId\": \"1560170656517-01\",\n \"orderGroup\": \"1560170656517\",\n \"state\": \"invoiced\",\n \"isCheckedIn\": false,\n \"sellerOrderId\": \"00-1560170656517-01\",\n \"storeId\": null,\n \"checkedInPickupPointId\": null,\n \"value\": 3159,\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 3399\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": -340\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 100\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n }\n ],\n \"clientProfileData\": {\n \"email\": \"johnson.kozey@yahoo.com\",\n \"firstName\": \"Frederic\",\n \"lastName\": \"Kessler\",\n \"document\": \"22736794/000199\",\n \"documentType\": \"CNPJ\",\n \"phone\": \"3834600495\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": true,\n \"profileErrorOnLoading\": false,\n \"customerClass\": null,\n \"userProfileId\": \"cb89a629-7cfb-11f0-b37f-f3d962eee6e4\",\n \"isProspect\": false\n },\n \"ratesAndBenefitsData\": {\n \"rateAndBenefitsIdentifiers\": [\n {\n \"id\": \"458cf5e4-c861-45df-9299-dba12e927666\",\n \"name\": \"Pagamento a vista\",\n \"featured\": false,\n \"description\": null,\n \"matchedParameters\": {\n \"product@CatalogSystem\": \"54|exclusive\",\n \"paymentMethodId\": \"17\"\n },\n \"additionalInfo\": null\n }\n ]\n },\n \"shippingData\": {\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Entrega Soberana\",\n \"selectedDeliveryChannel\": \"delivery\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"slas\": [\n {\n \"id\": \"Entrega Soberana\",\n \"deliveryChannel\": \"delivery\",\n \"name\": \"Entrega Soberana\",\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"shippingEstimate\": \"1bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"availableDeliveryWindows\": [],\n \"deliveryWindow\": null,\n \"price\": 100,\n \"listPrice\": 100,\n \"tax\": 0,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupPointId\": null,\n \"pickupDistance\": 0,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\"\n }\n ],\n \"shipsTo\": [\n \"USA\",\n \"BRA\"\n ],\n \"itemId\": \"88\",\n \"deliveryChannels\": [\n {\n \"id\": \"delivery\"\n }\n ],\n \"price\": 100,\n \"listPrice\": 100,\n \"shippingEstimate\": \"1bd\",\n \"dockEstimate\": \"0bd\",\n \"shippingEstimateDate\": \"2025-09-09T16:46:49.8104824Z\",\n \"lockTTL\": \"10d\",\n \"deliveryCompany\": null,\n \"polygonName\": \"\",\n \"transitTime\": \"1bd\",\n \"sellingPrice\": 100,\n \"deliveryIds\": [\n {\n \"courierId\": \"153671c\",\n \"warehouseId\": \"1_1\",\n \"dockId\": \"1\",\n \"courierName\": \"Entrega Soberana\",\n \"quantity\": 1,\n \"kitItemDetails\": [],\n \"accountCarrierName\": \"b2bfaststoredev\"\n }\n ],\n \"deliveryWindow\": null,\n \"pickupPointId\": null,\n \"pickupStoreInfo\": {\n \"isPickupStore\": false,\n \"friendlyName\": null,\n \"address\": null,\n \"additionalInfo\": null,\n \"dockId\": null\n },\n \"pickupDistance\": null\n }\n ],\n \"selectedAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Marla Singer\",\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"isDisposable\": false,\n \"postalCode\": \"22250-040\",\n \"city\": \"Bobbyborough\",\n \"state\": \"SP\",\n \"country\": \"BRA\",\n \"street\": \"Marvin Glens\",\n \"number\": \"697\",\n \"neighborhood\": \"-\",\n \"complement\": \"-\",\n \"reference\": null,\n \"geoCoordinates\": [\n -43.1822509765625,\n -22.94582748413086\n ]\n }\n ],\n \"trackingHints\": [],\n \"pickupPoints\": [],\n \"contactInformation\": [\n {\n \"id\": \"3b93a926fea84c62ae309882a03e909b\",\n \"firstName\": \"Marla\",\n \"lastName\": \"Singer\"\n },\n {\n \"id\": \"fdace46db89346dc8493aa693a5962dc\",\n \"firstName\": \"Robert\",\n \"lastName\": \"Paulson\"\n }\n ],\n \"contactsInfo\": [\n {\n \"addressId\": \"47991cd6-b455-4005-b382-d3e9b7919c69\",\n \"contacts\": [\n \"fdace46db89346dc8493aa693a5962dc\",\n \"3b93a926fea84c62ae309882a03e909b\"\n ],\n \"receiveWindows\": []\n }\n ],\n \"isFOB\": null\n },\n \"paymentData\": {\n \"giftCards\": [],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"2C4BF3F0A5C34B20A229AAC8262732CE\",\n \"merchantName\": \"B2BFASTSTOREDEV\",\n \"payments\": [\n {\n \"id\": \"4CB7873069554734969679E47505DD43\",\n \"paymentSystem\": \"17\",\n \"paymentSystemName\": \"Promissory\",\n \"value\": 3159,\n \"installments\": 1,\n \"connectorResponses\": {},\n \"referenceValue\": 3159,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"koinUrl\": null,\n \"tid\": null,\n \"redemptionCode\": null,\n \"giftCardId\": null,\n \"giftCardProvider\": null,\n \"giftCardAsDiscount\": null,\n \"group\": \"promissory\",\n \"dueDate\": null,\n \"paymentOrigin\": null,\n \"accountId\": null,\n \"parentAccountId\": null,\n \"bankIssuedInvoiceIdentificationNumber\": null,\n \"bankIssuedInvoiceIdentificationNumberFormatted\": null,\n \"bankIssuedInvoiceBarCodeNumber\": null,\n \"bankIssuedInvoiceBarCodeType\": null,\n \"billingAddress\": null,\n \"paymentDetails\": []\n }\n ],\n \"sharedTransaction\": false\n }\n ]\n },\n \"clientPreferencesData\": {\n \"locale\": \"pt-BR\",\n \"optinNewsLetter\": false,\n \"savePersonalData\": false,\n \"savePaymentData\": false\n },\n \"commercialConditionData\": null,\n \"marketingData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"USA\",\n \"timeZone\": \"Eastern Standard Time\",\n \"currencyCode\": \"USD\",\n \"currencyLocale\": 1033,\n \"currencySymbol\": \"$\",\n \"currencyFormatInfo\": {\n \"currencyDecimalDigits\": 2,\n \"currencyDecimalSeparator\": \".\",\n \"currencyGroupSeparator\": \",\",\n \"currencyGroupSize\": 3,\n \"startsWithCurrencySymbol\": true\n }\n },\n \"openTextField\": null,\n \"invoiceData\": {\n \"address\": null,\n \"settleInvoices\": [\n \"1757350014\"\n ],\n \"invoices\": {\n \"1757350014\": {\n \"type\": \"Output\",\n \"invoiceNumber\": \"1757350014\"\n }\n }\n },\n \"itemMetadata\": {\n \"items\": [\n {\n \"id\": \"88\",\n \"seller\": \"1\",\n \"name\": \"Combination Spanner Set Storage\",\n \"skuName\": \"Combination Spanner Set Storage\",\n \"productId\": \"56\",\n \"refId\": \"88\",\n \"ean\": null,\n \"imageUrl\": \"https://b2bfaststoredev.vteximg.com.br/arquivos/ids/155396-55-55/88.png?v=638471444853200000\",\n \"detailUrl\": \"/combination-spanner-set-storage2/p\",\n \"assemblyOptions\": []\n }\n ]\n },\n \"taxData\": null,\n \"customData\": {\n \"customApps\": [],\n \"customFields\": [\n {\n \"linkedEntity\": {\n \"type\": \"order\",\n \"id\": null\n },\n \"fields\": [\n {\n \"name\": \"poNumber\",\n \"value\": \"PO1\",\n \"refId\": \"PO1\"\n }\n ]\n },\n {\n \"linkedEntity\": {\n \"type\": \"item\",\n \"id\": \"E0C828E7E81E4466AE92C1CBA6D872E0\"\n },\n \"fields\": [\n {\n \"name\": \"Cost Center\",\n \"value\": \"CC1\",\n \"refId\": \"CC1\"\n }\n ]\n }\n ]\n },\n \"hooksData\": null,\n \"changeData\": null,\n \"subscriptionData\": null,\n \"merchantContextData\": null,\n \"purchaseAgentData\": {\n \"purchaseAgents\": [\n {\n \"userId\": \"5737bfa1-b8fc-46e9-8826-039f45478dc9\",\n \"versionId\": \"\",\n \"persona\": \"BUYER\",\n \"unitId\": \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\"\n }\n ]\n },\n \"budgetData\": {\n \"unitAllocations\": {\n \"ef6710eb-064d-4b8c-85c7-8fd6b123841e\": [\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c3d4-966b-7519-8cdc-0867f99581c4\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-733b-ad4f-01f089224b94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -410354\n }\n },\n {\n \"budgetId\": \"0198c266-c2a9-745e-beff-ab4733fdd40d\",\n \"allocationId\": \"0198c267-1c3c-70ef-9fdf-5572fd08e70e\",\n \"linkedEntity\": {\n \"type\": \"poNumber\",\n \"id\": \"PO1\"\n },\n \"reservationId\": \"01992a39-155f-74ae-a7b1-381a5d7f5d94\",\n \"reservedAmount\": 3159,\n \"budgetBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -829206\n },\n \"allocationBalance\": {\n \"amount\": 3159,\n \"totalUtilized\": 0,\n \"remaining\": -415282\n }\n }\n ]\n }\n },\n \"authorizationPolicyData\": {\n \"status\": \"accepted\",\n \"deniedPolicies\": [],\n \"pendingPolicies\": []\n },\n \"salesChannel\": \"1\",\n \"followUpEmail\": \"9e2d3530482e49f8bd0e8e9d97ee2f36@ct.vtex.com.br\",\n \"creationDate\": \"2025-09-08T16:46:42.0195859Z\",\n \"lastChange\": \"2025-09-08T16:46:58.1025748Z\",\n \"timeZoneCreationDate\": \"2025-09-08T12:46:42.0195859\",\n \"timeZoneLastChange\": \"2025-09-08T12:46:58.1025748\",\n \"isCompleted\": true,\n \"hostName\": \"b2bfaststoredev\",\n \"merchantName\": null,\n \"userType\": \"\",\n \"roundingError\": 0,\n \"allowEdition\": false,\n \"allowCancellation\": false,\n \"isUserDataVisible\": true,\n \"allowChangeSeller\": false,\n \"orderFormCreationDate\": \"2025-09-08T16:46:40.1383799Z\",\n \"marketplaceRequestedCancellationWindow\": null\n }\n]\n" - } - ] - } - ], - "description": "The following endpoints allow interaction with client orders. They enable placing an order, processing its payment, and retrieving order information." - } - ], - "description": "The Buying Policies system supports dynamic rules that merchants can configure to suit their specific authorization processes. It provides a mechanism for users to register custom rule expressions, offering greater flexibility and extensibility.\n\nThe approval process is hierarchical and sequential:\n\n- Starts at the org unit where the order is placed.\n \n- Moves up one org unit level at a time, only after all policies at the current level are approved.\n \n- At each level, policies are applied in the order of their creation (from oldest to newest)." - }, - { - "name": "Auxiliar APIs", - "item": [ - { - "name": "List Payment Systems", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/payments/pvt/payment-systems/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "payments", - "pvt", - "payment-systems", - "" - ] - }, - "description": "**Official Doc:** [VTEX Payments Gateway API](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/merchants/payment-systems)\n\nThis endpoint retrieves a list of payment systems available for the merchant account.\n\n---\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/payments/pvt/payment-systems/\n\n ```\n\n**Headers:**\n\n- `X-VTEX-API-AppKey`: Your VTEX App Key\n \n- `X-VTEX-API-AppToken`: Your VTEX App Token\n \n\nNo request body is required.\n\n---\n\n### Response\n\n**Status:** `200 OK`\n\n**Content-Type:** `application/json`\n\nReturns an array of payment system objects:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | number | The ID of the payment system. |\n| `name` | string | The name of the payment system. |\n| `requiresDocument` | boolean | Whether a document is required. |\n| `implementation` | string | Implementation details. |\n| `connectorImplementation` | string | Connector implementation. |\n| `antifraudConnectorImplementation` | string | Antifraud connector implementation. |\n| `groupName` | string | Group name of the payment system. |\n| `redirect` | boolean | Whether redirection is allowed. |\n| `isCustom` | boolean | Whether it is a custom payment system. |\n| `isSelfAuthorized` | boolean | Whether it is self-authorized. |\n| `requiresAuthentication` | boolean | Whether authentication is required. |\n| `allowInstallments` | boolean | Whether installments are allowed. |\n| `allowBinExclusion` | boolean | Whether bin exclusion is allowed. |\n| `allowMultiple` | boolean | Whether multiple payments are allowed. |\n| `allowIssuer` | boolean | Whether issuer is allowed. |\n| `allowCountry` | boolean | Whether country is allowed. |\n| `allowCommercialPolicy` | boolean | Whether commercial policy is allowed. |\n| `allowCommercialCondition` | boolean | Whether commercial condition is allowed. |\n| `allowPeriod` | boolean | Whether period is allowed. |\n| `isAvailable` | boolean | Whether the payment system is available. |\n| `description` | string | Description of the payment system. |\n| `supportRecurrence` | boolean | Whether recurrence is supported. |\n| `validator` | object | Validation details. |\n| `appDependencies` | array | List of application dependencies. |\n| `displayDocument` | boolean | Whether document display is allowed. |\n| `dueDate` | string | Due date of the payment system. |\n| `allowNotification` | boolean | Whether notifications are allowed. |\n| `affiliationId` | string | Affiliation ID. |\n| `availablePayments` | null | Available payments. |\n| `dueDateMinutes` | number | Due date in minutes. |\n\n---\n\n### Example Response\n\n``` json\n[\n {\n \"id\": 1,\n \"name\": \"Credit Card\",\n \"requiresDocument\": true,\n \"implementation\": \"gateway-impl\",\n \"connectorImplementation\": \"connector-impl\",\n \"antifraudConnectorImplementation\": \"antifraud-impl\",\n \"groupName\": \"credit-card\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": true,\n \"allowInstallments\": true,\n \"allowBinExclusion\": true,\n \"allowMultiple\": true,\n \"allowIssuer\": true,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": \"Standard Credit Card\",\n \"supportRecurrence\": true,\n \"validator\": {},\n \"appDependencies\": [],\n \"displayDocument\": true,\n \"dueDate\": \"2025-12-31T23:59:59Z\",\n \"allowNotification\": true,\n \"affiliationId\": \"aff-123\",\n \"availablePayments\": null,\n \"dueDateMinutes\": 1440\n }\n]\n\n ```" - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/payments/pvt/payment-systems/", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "payments", - "pvt", - "payment-systems", - "" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "388836" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Tue, 25 Mar 2025 13:32:40 GMT" - }, - { - "key": "Cache-Control", - "value": "no-store" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "payment-v1.2.1" - }, - { - "key": "x-vtex-operation-id", - "value": "4d975107-b64c-4df5-a4fb-36ce624752c7" - }, - { - "key": "X-XSS-Protection", - "value": "1; mode=block" - }, - { - "key": "X-Frame-Options", - "value": "DENY" - }, - { - "key": "X-Content-Type-Options", - "value": "nosniff" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=86400; includeSubDomains" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 ec2ee70d2f42be931ebbd09be1528d7e.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "HmBRHEi0xqLQtMqsKHNwHyKBZdJKQJooC-oIf4yM0JPLojMjt9CMsQ==" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": 1,\n \"name\": \"American Express\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Amex\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^3[47][0-9]{13}$\",\n \"mask\": \"9999 999999 99999\",\n \"cardCodeMask\": \"9999\",\n \"cardCodeRegex\": \"^[0-9]{4}$\",\n \"weights\": [\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 2,\n \"name\": \"Visa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Visa\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^4[0-9]{15}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 3,\n \"name\": \"Diners\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Diners\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^3(0[0-5]|[68][0-9])[0-9]{11}$\",\n \"mask\": \"9999 999999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 4,\n \"name\": \"Mastercard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Mastercard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\\\d{4,10})|((502121)\\\\d{4,10})|((589916)\\\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\\\d{4,10})\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 5,\n \"name\": \"Discover\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Discover\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(6011|65[0-9]{2})[0-9]{12}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 6,\n \"name\": \"Boleto Bancário\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.BankIssuedInvoicePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 7,\n \"name\": \"Aura\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Aura\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^50[0-9]{17}$\",\n \"mask\": \"9999999999999999999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 8,\n \"name\": \"Hipercard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Hipercard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^606282|^3841(?:[0|4|6]{1})0\",\n \"mask\": \"9999999999999999999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 1,\n 1,\n 1\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 9,\n \"name\": \"Elo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Elo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(50(67(0[78]|1[5789]|2[012456789]|3[01234569]|4[0-7]|53|7[4-8])|9(0(0[0-9]|1[34]|2[0-7]|3[0359]|4[01235678]|5[01235789]|6[0-9]|7[01346789]|8[01234789]|9[123479])|1(0[34568]|4[6-9]|5[1-8]|8[356789])|2(2[0-2]|5[78]|6[1-9]|7[0-9]|8[01235678]|90)|357|4(0[7-9]|1[0-9]|2[0-2]|31|5[7-9]|6[0-6]|84)|55[01]|636|7(2[2-9]|6[5-9])))|4(0117[89]|3(1274|8935)|5(1416|7(393|63[12])))|6(27780|36368|5(0(0(3[12356789]|4[0-7]|7[78])|4(0[6-9]|1[0234]|2[2-9]|3[045789]|8[5-9]|9[0-9])|5(0[012346789]|1[0-9]|2[0-9]|3[0178]|5[2-9]|6[0-6]|7[7-9]|8[0-8]|9[1-8])|72[0-7]|9(0[1-9]|1[0-9]|2[0128]|3[89]|4[6-9]|5[0145]|6[235678]|71))|16(5[2-9]|6[0-9]|7[01456789])|50(0[0-9]|1[02345678]|36|5[1267]))))\\\\d{0,13}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 10,\n \"name\": \"Visa Electron\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.VisaElectron\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^4[0-9]{15}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 12,\n \"name\": \"PayPal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"payPal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.656191Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 13,\n \"name\": \"Bcash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.PagamentoDigital.PagamentoDigitalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bcash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 14,\n \"name\": \"Banricompras\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Banricompras\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(6396|5304\\\\s{0,1}1)\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 15,\n \"name\": \"Evolucard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EvolucardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"evolucard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 16,\n \"name\": \"Vale\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.GiftCard.VtexGiftCard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"giftCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 17,\n \"name\": \"Promissory\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.PromissoryPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"promissory\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 18,\n \"name\": \"Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 19,\n \"name\": \"Débito Online\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.GenericDebitCard\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 20,\n \"name\": \"Alignet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AlignetPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"alignet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 21,\n \"name\": \"JCB\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.JCB\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(35[0-9]{3}|2131|1800)[0-9]{11}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 22,\n \"name\": \"Débito Itau\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Itau\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 23,\n \"name\": \"Débito Bradesco\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Bradesco\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6567307Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 24,\n \"name\": \"Débito Banco do Brasil\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.BancoDoBrasil\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 25,\n \"name\": \"Débito Banrisul\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Banrisul\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 26,\n \"name\": \"PagSeguro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagSeguroPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pagSeguro\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 27,\n \"name\": \"Débito Hsbc\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Hsbc\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 28,\n \"name\": \"Peela\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.Peela\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"peela\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 29,\n \"name\": \"Private Label\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.PrivateLabelPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"9999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 30,\n \"name\": \"Webpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WebpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"webpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 31,\n \"name\": \"CoBranded\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.CoBrandedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"9999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 32,\n \"name\": \"PayClub\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayClubPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"payClub\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 33,\n \"name\": \"Cabal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Cabal\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^((627170)|(650272)|(650087)|(589657)|(603522)|(604((20[1-9])|(2[1-9][0-9])|(3[0-9]{2})|(400))))\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 34,\n \"name\": \"Nativa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Nativa\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^487017[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 35,\n \"name\": \"Naranja\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Naranja\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^589562[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 36,\n \"name\": \"Nevada\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Nevada\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^504363[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 37,\n \"name\": \"Shopping\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.Shopping\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^603488[0-9]{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6572632Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 38,\n \"name\": \"Safetypay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SafetypayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"safetypay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 39,\n \"name\": \"Maestro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.Maestro\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\\\d{4,10})|((502121)\\\\d{4,10})|((589916)\\\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\\\d{4,10})\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 40,\n \"name\": \"Koin Pós-Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.KoinBankIssueInvoicePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"boletoKoinPosPago\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 41,\n \"name\": \"PagoEfectivo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.PagoEfectivoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagoEfectivo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 42,\n \"name\": \"Stelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SteloPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Stelo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 43,\n \"name\": \"PagosWeb\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagosWebPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagosWeb\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 44,\n \"name\": \"Venda Direta Debito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DebitDirectSalePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitDirectSale\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 45,\n \"name\": \"Venda Direta Credito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditDirectSalePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditDirectSale\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 46,\n \"name\": \"FichaDeposito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.FichaDepositoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 47,\n \"name\": \"Cash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.CashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"cash\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 48,\n \"name\": \"Credz\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.CredzPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^(((636760)|(637032))\\\\d{0,10})$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 49,\n \"name\": \"PayPalPlus\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.PayPalPlus.PayPalPlusPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalPlus\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6577968Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 50,\n \"name\": \"Rede Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RedePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RedePay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 51,\n \"name\": \"Lotérica\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.LotteryCashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"lottery\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 52,\n \"name\": \"Adyen\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AdyenHostedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"adyenHosted\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 53,\n \"name\": \"Itau Shopline\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.ItauShopLine.ItauShoplinePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ItauShopline\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 55,\n \"name\": \"OneBuy\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.IFramePayments.OneBuyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"OneBuy\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 56,\n \"name\": \"PaymentHub\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaymentHubPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PaymentHub\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 57,\n \"name\": \"TodoPago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TodoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TodoPago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 59,\n \"name\": \"PagosNet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagosNetPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagosNet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 60,\n \"name\": \"MeoWallet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MeoWalletPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MeoWallet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6583215Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 64,\n \"name\": \"Customer Credit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.CreditControlPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditControl\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 65,\n \"name\": \"Mastercard Debit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.MastercardDebit\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^(502275|528745|(5045|5061|5062|5063|5064|5105|5111|5112|5117|5118|5122|5160|5161|5164|5165|5166|5174|5177|5188|5201|5204|5206|5235|5236|5240|5247|5256|5261|5263|5264|5280|5284|5285|5290|5295|5301|5306|5312|5324|5336|5339|5343|5349|5359|5367|5370|5379|5380|5384|5389|5399|5439|5452|5453|5457|5463|5496|5502|5508|5510|5512|5513|5514|5515|5534|5538|5541|5544|5546|5549|5559|5575|5576|5578|5579)[0-9]{2}|558426|559471|588772|589617|528733|549180|517562|551792|553771|553777)[0-9]{0,10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 66,\n \"name\": \"MultiBanco\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.MultiBancoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"multibanco\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 67,\n \"name\": \"PayMee\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayMeePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"payMee\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 68,\n \"name\": \"Livelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LiveloPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Livelo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 69,\n \"name\": \"Apple Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.ApplePay.ApplePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ApplePay\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 70,\n \"name\": \"MOLPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MOLPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MOLPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 71,\n \"name\": \"IPay88\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IPay88Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"IPay88\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 72,\n \"name\": \"PicPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PicPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"picPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 73,\n \"name\": \"Bitcoin\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CryptoCurrencyPayments.BitcoinPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bitcoin\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6588516Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 74,\n \"name\": \"FutPag\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FutPagPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"futPag\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 75,\n \"name\": \"iBuy\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IBuyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"iBuy\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 76,\n \"name\": \"MobilPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MobilPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"mobilPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 77,\n \"name\": \"LayAway\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.LayAwayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"layaway\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 78,\n \"name\": \"PinCash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PinCashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pincash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 79,\n \"name\": \"Pago Fácil\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.PagoFacilPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 80,\n \"name\": \"Cobro Express\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.CobroExpressPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 81,\n \"name\": \"Rapipago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.RapipagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 82,\n \"name\": \"Multicaja\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MulticajaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Multicaja\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 83,\n \"name\": \"Baloto\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.BalotoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 84,\n \"name\": \"Efecty\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.EfectyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 86,\n \"name\": \"LevPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LevPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"levpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6593744Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 87,\n \"name\": \"PagoLivre\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoLivrePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pagoLivre\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 88,\n \"name\": \"Pagomio\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagomioPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"pagomio\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 89,\n \"name\": \"PlaceToPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PlaceToPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"placeToPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 90,\n \"name\": \"Losango\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LosangoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"losango\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 91,\n \"name\": \"SPEI\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SpeiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SPEI\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 92,\n \"name\": \"PayUTeFia\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayUTeFiaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayUTeFia\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 93,\n \"name\": \"BoletoFlex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoFlexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoFlex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 94,\n \"name\": \"SpinPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SpinPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SpinPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 95,\n \"name\": \"AmeDigital\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AmeDigitalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"AmeDigital\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 96,\n \"name\": \"PagSmile\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagSmilePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagSmile\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 97,\n \"name\": \"Affirm\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AffirmPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Affirm\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6598943Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 98,\n \"name\": \"BACS Direct Debit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Debit.BacsDirectDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 99,\n \"name\": \"VirtusPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtusPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtusPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 100,\n \"name\": \"Alelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.Alelo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"foodCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^((((401178)|(401179)|(431274)|(438935)|(451416)|(457393)|(457631)|(457632)|(504175)|(506699)|(627780)|(636297)|(636368))\\\\d{0,10})|((4576)|(4011)|(5067)|(6500)|(6504)|(6505)|(6507)|(6509)|(6516)|(6550))\\\\d{0,12}|(509)\\\\d{0,13})$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 101,\n \"name\": \"Wipei\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WipeiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Wipei\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 102,\n \"name\": \"Addi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AddiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Addi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 103,\n \"name\": \"OXXO\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.BankIssuedInvoice.OxxoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"bankInvoice\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 104,\n \"name\": \"Lendico\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LendicoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Lendico\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 105,\n \"name\": \"Satispay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SatispayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Satispay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 106,\n \"name\": \"Klarna\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlarnaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klarna\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 107,\n \"name\": \"Samsung Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.SamsungPay.SamsungPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SamsungPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 108,\n \"name\": \"ItauCrediario\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ItauCrediarioPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ItauCrediario\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6604228Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 109,\n \"name\": \"Paylands\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaylandsPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Paylands\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 110,\n \"name\": \"FlowFinance\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FlowFinancePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"FlowFinance\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 111,\n \"name\": \"WompiCo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiCoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiCo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 112,\n \"name\": \"55Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FiveFivePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"55Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 113,\n \"name\": \"Cartão de débito virtual Caixa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.VirtualDebitElo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"virtualDebitElo\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^(506722(8|9)|(509023|509105|509030)\\\\d)\\\\d{9}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 114,\n \"name\": \"Siman\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SimanPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Siman\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 115,\n \"name\": \"Finago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FinagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Finago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 116,\n \"name\": \"UnDosTres\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.UnDosTresPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"UnDosTres\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 117,\n \"name\": \"SweetPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SweetPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SweetPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 118,\n \"name\": \"SisteCredito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SisteCreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SisteCredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 119,\n \"name\": \"Aplazame\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AplazamePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Aplazame\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 120,\n \"name\": \"Serfinsa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SerfinsaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Serfinsa\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 121,\n \"name\": \"Parcelex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ParcelexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Parcelex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6609616Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 122,\n \"name\": \"SumasPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SumasPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SumasPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 123,\n \"name\": \"Chek\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ChekPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Chek\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 124,\n \"name\": \"Klarna Pay Now\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlarnaPayNowPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klarna Pay Now\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 125,\n \"name\": \"Pix\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PixPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"instantPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 126,\n \"name\": \"MercadoPagoWallet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoWalletPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPagoWallet\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 127,\n \"name\": \"MercadoPagoPro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoProPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPagoPro\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 128,\n \"name\": \"Surtidora Departamental\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SurtidoraDepartamentalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SurtidoraDepartamental\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 129,\n \"name\": \"Ideal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IdealPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ideal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 130,\n \"name\": \"PuntosColombia\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PuntosColombiaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PuntosColombia\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 131,\n \"name\": \"Paguelofacil\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaguelofacilPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Paguelofacil\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 132,\n \"name\": \"KahshPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KahshPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"KahshPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 133,\n \"name\": \"DigitalRiver\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DigitalRiverPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DigitalRiver\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6614949Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 134,\n \"name\": \"VisaconPuntos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VisaconPuntosPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VisaconPuntos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 135,\n \"name\": \"ETPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ETPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ETPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 136,\n \"name\": \"TuyaPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TuyaPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TuyaPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 137,\n \"name\": \"Transbank Oneclick\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TransbankOneclickPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TransbankOneclick\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 138,\n \"name\": \"PagDividido\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.WalletPayments.PagDivididoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagDividido\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 139,\n \"name\": \"BraintreePayPal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreePaypalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BraintreePayPal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 140,\n \"name\": \"BrainTreePayPalDebito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BrainTreePayPalDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BrainTreePayPalDebit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 141,\n \"name\": \"BoletoParceladoKoin\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoParceladoKoinPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoParceladoKoin\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 142,\n \"name\": \"MBWay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MBWayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MBWay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 143,\n \"name\": \"Worldpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Worldpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 144,\n \"name\": \"AmazonPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AmazonPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"AmazonPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 145,\n \"name\": \"RazorPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RazorPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RazorPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662022Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 146,\n \"name\": \"Tinkoff\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TinkoffPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Tinkoff\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 147,\n \"name\": \"BomPraCredito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BomPraCreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BomPraCredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 148,\n \"name\": \"Lyra\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LyraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Lyra\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 149,\n \"name\": \"Aeropay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AeropayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Aeropay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 150,\n \"name\": \"Bizum\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BizumPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bizum\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 151,\n \"name\": \"Borica\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoricaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Borica\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 152,\n \"name\": \"PayPalCP\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalCPPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalCP\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 153,\n \"name\": \"Splitit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SplititPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Splitit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 154,\n \"name\": \"NetPayCheckout\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NetPayCheckoutPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"NetPayCheckout\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 155,\n \"name\": \"Payware\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaywarePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Payware\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 156,\n \"name\": \"MercadoPagoOff\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoPagoOffPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoPagoOff\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.662556Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 157,\n \"name\": \"QPayPro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QPayProPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"QPayPro\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 158,\n \"name\": \"Points FAC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PointsFACPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Points FAC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 159,\n \"name\": \"3DSFAC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FAC3DSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"3DSFAC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 160,\n \"name\": \"BitfyBr\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BitfyBrPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BitfyBr\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 161,\n \"name\": \"Stripe\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.StripePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Stripe\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 162,\n \"name\": \"Blik\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BlikPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Blik\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 163,\n \"name\": \"Scalapay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ScalapayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Scalapay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 164,\n \"name\": \"PayU Redirect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayURedirectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayURedirect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 165,\n \"name\": \"Mollie\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MolliePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Mollie\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 166,\n \"name\": \"SmartUcf\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SmartUcfPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SmartUcf\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6630873Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 167,\n \"name\": \"Cashback\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CashbackPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cashback\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 168,\n \"name\": \"Mobbex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MobbexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Mobbex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 169,\n \"name\": \"Google Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GooglePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Google Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 170,\n \"name\": \"Sequra\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SequraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Sequra\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 171,\n \"name\": \"Bamboo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BambooPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bamboo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 172,\n \"name\": \"Pagaleve\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 173,\n \"name\": \"Quatro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QuatroPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Quatro\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 174,\n \"name\": \"Aplazo Payment\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AplazoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"aplazo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 175,\n \"name\": \"Nelo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NeloPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nelo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 176,\n \"name\": \"aCuotaz\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ACuotazPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"aCuotaz\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6636288Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 177,\n \"name\": \"GOcuotas\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GOcuotasPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"GOcuotas\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 178,\n \"name\": \"Nubank\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NubankPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nubank\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 179,\n \"name\": \"Zaincash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZaincashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zaincash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 180,\n \"name\": \"Mach\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MachPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Mach\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 181,\n \"name\": \"Slightpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SlightpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"slightpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 182,\n \"name\": \"OsowEFT\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.OsowEFTPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"OsowEFT\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 183,\n \"name\": \"CardConnect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CardConnectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CardConnect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 184,\n \"name\": \"Switch HyperPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SwitchHyperPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Switch HyperPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 185,\n \"name\": \"Servicredito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ServicreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Servicredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 186,\n \"name\": \"Plata Ya Crédito (PYC)\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PlataYaCreditoPYCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Plata Ya Crédito (PYC)\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6641602Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 187,\n \"name\": \"Modo Payment\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ModoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Modo Payment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 188,\n \"name\": \"Qicard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QicardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Qicard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 189,\n \"name\": \"Pinelabs\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PinelabsPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pinelabs\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 190,\n \"name\": \"Cetelem\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CetelemPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cetelem\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 191,\n \"name\": \"Angeloni\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AngeloniPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Angeloni\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 192,\n \"name\": \"BoletoParceladoParcelaSim\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoParceladoParcelaSimPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoParceladoParcelaSim\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 193,\n \"name\": \"Shieldgate-MX\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ShieldgateMXPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Shieldgate-MX\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 194,\n \"name\": \"Klap\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlapPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klap\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 195,\n \"name\": \"ZIP\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZIPPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ZIP\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6646859Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 196,\n \"name\": \"Astropay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AstropayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Astropay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 197,\n \"name\": \"Cencosud Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CencosudPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cencosud Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 198,\n \"name\": \"Pagaleve Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagaleveTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve Transparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 199,\n \"name\": \"Bancolombia Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancolombiaTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bancolombia Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 601,\n \"name\": \"CardPromissory\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.CardPromissoryPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"cardPromissory\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 701,\n \"name\": \"PSE\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PSEPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PSE\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [\n \"vtexlatam.banks-for-pse@2.x\"\n ],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 702,\n \"name\": \"DMPag\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DMPagPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DMPag\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 703,\n \"name\": \"NANOPLAZOS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NANOPLAZOSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"NANOPLAZOS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.665226Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 704,\n \"name\": \"StripeConnect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.StripeConnectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"StripeConnect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 705,\n \"name\": \"Nequi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NequiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nequi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 706,\n \"name\": \"Daviplata\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DaviplataPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Daviplata\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 707,\n \"name\": \"Provu\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ProvuPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Provu\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 708,\n \"name\": \"Mercado Credito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MercadoCreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MercadoCredito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 709,\n \"name\": \"Ventipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VentipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ventipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 710,\n \"name\": \"Recaudo Efectivo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RecaudoEfectivoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RecaudoEfectivo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 711,\n \"name\": \"Payválida\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayválidaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Payválida\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 712,\n \"name\": \"Pagaleve Pix A Vista\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixAVistaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagalevePixAVista\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 713,\n \"name\": \"Pagaleve Pix A Vista Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixAVistaTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagalevePixAVistaTransparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6657541Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 714,\n \"name\": \"Brilla\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BrillaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Brilla\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 715,\n \"name\": \"Alma\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AlmaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Alma\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 716,\n \"name\": \"Chargeafter\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ChargeafterPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Chargeafter\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 717,\n \"name\": \"Credito Bodesa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoBodesaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CreditoBodesa\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 718,\n \"name\": \"Flywire\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FlywirePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Flywire\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 719,\n \"name\": \"Paga con Rappi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagaconRappiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagaconRappi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 720,\n \"name\": \"MazdaSantander\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MazdaSantanderPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MazdaSantander\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 721,\n \"name\": \"carnê banQi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.carnebanQiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"carnebanQi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 722,\n \"name\": \"Credit Key\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditKeyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CreditKey\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6662819Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 723,\n \"name\": \"Wepay4u\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Wepay4uPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Wepay4u\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 724,\n \"name\": \"VirtusPay Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtusPayTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtusPayTransparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 725,\n \"name\": \"Drip\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DripPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Drip\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 726,\n \"name\": \"Wompi - Nequi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiNequiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiNequi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 727,\n \"name\": \"Wompi - PSE\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiPSEPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiPSE\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 728,\n \"name\": \"Wompi - Corresponsales\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WompiCorresponsalesPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WompiCorresponsales\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 729,\n \"name\": \"Epay Credit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayCreditPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayCredit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 730,\n \"name\": \"Epay Debit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayDebit\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 731,\n \"name\": \"Epay CAT\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayCATPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayCAT\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 732,\n \"name\": \"Epay GC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayGCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayGC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6668072Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 733,\n \"name\": \"Epay Puntos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayPuntosPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayPuntos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 734,\n \"name\": \"Epay Prepay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayPrepayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayPrepay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 735,\n \"name\": \"Epay Redirect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayRedirectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpayRedirect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 736,\n \"name\": \"worldline SIPS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.worldlineSIPSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"worldlineSIPS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 737,\n \"name\": \"TiendaCrypto API Commerce\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TiendaCryptoAPICommercePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TiendaCryptoAPICommerce\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 738,\n \"name\": \"Cartão de Crédito por SIBS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CartaoDeCreditoPorSIBSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CartaoDeCreditoPorSIBS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 739,\n \"name\": \"bancolombia-bnpl\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancolombiaBnplPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BancolombiaBnpl\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 740,\n \"name\": \"Delego\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DelegoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Delego\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 741,\n \"name\": \"Bancolombia Collect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancolombiaCollectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BancolombiaCollect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6673273Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 742,\n \"name\": \"PayPalCheckout\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalCheckoutPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalCheckout\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 743,\n \"name\": \"PayPalRT\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalRTPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalRT\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 744,\n \"name\": \"PayPalOXXO\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalOXXOPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalOXXO\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 745,\n \"name\": \"dimo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DimoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"dimo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 746,\n \"name\": \"RetryPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RetryPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RetryPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 747,\n \"name\": \"Convênios Clamed\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ConveniosClamedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ConveniosClamed\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 748,\n \"name\": \"Qhantuy\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.QhantuyPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Qhantuy\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 749,\n \"name\": \"Personal Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PersonalCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PersonalCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6678476Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 750,\n \"name\": \"FCamara - Iniciador de pagamentos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FCamaraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"FCamara - Iniciador de pagamentos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 751,\n \"name\": \"MoreTyme\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MoreTymePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MoreTyme\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 752,\n \"name\": \"DeunaNow\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DeunaNowPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DeunaNow\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 753,\n \"name\": \"P24\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.P24Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"P24\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 754,\n \"name\": \"Jet card / RCS Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.JetCardRCSCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"JetCardRCSCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 755,\n \"name\": \"Elo Débito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.DebitElo\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"^(40117[8-9]|438935|451416|457393|45763[1-2]|50672[0-24-9]|50673[0-24-6]|50674[4-7]|506753|50677[57]|50900[0-3]|509023|509030|50906[57-9]|509073|50908[1-3]|50909[13]|50910[4-5]|50914[7-9]|50915[1-26-8]|50918[37-8]|50922[02]|509274|509288|50955[0-1]|509636|50972[4-57]|627780|65003[1-258]|65004[026]|650069|65007[0178]|65048[7-9]|65049[12459]|650508|650525|65052[7-9]|650530|65056[2-37-9]|65057[01]|65058[46]|65059[1257]|650907|650938|65094[8-9]|650951|65096[7-9]|650970|651653|65165[7-8]|65166[58]|65167[013468]|651688|65500[138]|65501[568]|65503[6-8]|506748|509049|50907[256]|50908[56]|50909[4-6]|5091[123]\\\\d|50914[0-5]|509150|509159|5091[67]\\\\d|50918[0-2]|50918[45]|50919\\\\d|5092[01]\\\\d|509221|509223|50922[4-9]|5092[34]\\\\d|50925[0-6]|50950[7-9]|5095[1-4]\\\\d|50955[2-9]|5095[6-9]\\\\d|5096[0-2]\\\\d|50963[0-5]|50963[7-9]|5096[4-9]\\\\d|5097[01]\\\\d|50972[01]|50973[013-9]|5097[45]\\\\d|50976[0-4]|65003[3679]|65004[13-57]|650062|65007[2-69]|65008[01]|65057[2-6]|650585|65095[2369]|65096[01]|65097[23]|65097[4-8]|65165[45]|65166[1349]|651672|65168[0-79]|65169\\\\d|65170[1-4]|65500[24]|655010|65501[47]|655039|65504\\\\d|655050)\\\\d{10}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 756,\n \"name\": \"lamarinamx\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.LamarinamxPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"lamarinamx\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 757,\n \"name\": \"Kaiowa\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KaiowaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Kaiowa\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 758,\n \"name\": \"Sured\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SuredPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Sured\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6683727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 759,\n \"name\": \"Pix com Open Finance\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PixCOpenFinancePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pix com Open Finance\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 760,\n \"name\": \"GingaPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GingaPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"GingaPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 761,\n \"name\": \"Online Banking Poland\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.OnlineBankingPolandPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Online Banking Poland\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 762,\n \"name\": \"kushki - Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KushkiTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"kushki - Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 763,\n \"name\": \"Buy Now Pay Later Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BuyNowPayLaterMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Buy Now Pay Later Mercado Pago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 764,\n \"name\": \"CoppelPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CoppelPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CoppelPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 765,\n \"name\": \"Paycash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaycashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Paycash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 766,\n \"name\": \"MSC Payment\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MSCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MSC Payment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 767,\n \"name\": \"99Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments._99PayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"99Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 768,\n \"name\": \"Windcave\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WindcavePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Windcave\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6689068Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 769,\n \"name\": \"Boleto Parcelado Multiloja\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BoletoParceladoMultilojaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BoletoParceladoMultiloja\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 770,\n \"name\": \"Inswitch\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.InswitchPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Inswitch\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 771,\n \"name\": \"Easypay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EasypayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Easypay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 772,\n \"name\": \"WorldlineMercadoPago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldlineMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WorldlineMercadoPago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 773,\n \"name\": \"WorldlinePayPal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldlinePayPalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WorldlinePayPal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 774,\n \"name\": \"Worldline Global Collect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WorldlineGlobalCollectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WorldlineGlobalCollect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 775,\n \"name\": \"2C2P\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments._2C2PPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"2C2P\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 776,\n \"name\": \"APM_PagoEfectivo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.APM_PagoEfectivoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"APM_PagoEfectivo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6694394Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 777,\n \"name\": \"Kushki - Cash\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KushkiCashPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Kushki - Cash\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 778,\n \"name\": \"Bash Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BashPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bash Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 779,\n \"name\": \"Stitch\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.StitchPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Stitch\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 780,\n \"name\": \"Bank Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BankTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bank Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 781,\n \"name\": \"PayPalBCDC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalBCDCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalBCDC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 782,\n \"name\": \"Cencopay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CencopayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cencopay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 783,\n \"name\": \"Cencopay Saldo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CencopaySaldoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cencopay Saldo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 784,\n \"name\": \"DiDi Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DiDiPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DiDi Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 785,\n \"name\": \"Nexi XPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NexiXPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nexi XPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6699638Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 786,\n \"name\": \"Fintoc\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FintocPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Fintoc\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 787,\n \"name\": \"Kushki - Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KushkiCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Kushki - Card\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 788,\n \"name\": \"Zenkipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZenkipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zenkipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 789,\n \"name\": \"Cartes Bancaires (CB)\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CreditCard.CartesBancaires\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"creditCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": true,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": \"^[0-9]{16}$\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 790,\n \"name\": \"Yuno Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Card\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 791,\n \"name\": \"Yuno Bank Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoBankTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Bank Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 792,\n \"name\": \"Yuno Buy Now Pay Later\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoBuyNowPayLaterPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Buy Now Pay Later\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 793,\n \"name\": \"Yuno Payment Link\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoPaymentLinkPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Payment Link\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6704876Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 794,\n \"name\": \"Yuno Ticket\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoTicketPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Ticket\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 795,\n \"name\": \"Yuno Wallet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YunoWalletPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yuno Wallet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 796,\n \"name\": \"Braintree-ApplePay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreeApplePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Braintree-ApplePay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 797,\n \"name\": \"PayPalACDC\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayPalACDCPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayPalACDC\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 798,\n \"name\": \"ITP\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ITPPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ITP\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 799,\n \"name\": \"BNPL\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BNPLPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BNPL\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 800,\n \"name\": \"Woovi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WooviPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Woovi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 801,\n \"name\": \"Braintree-GooglePay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreeGooglePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Braintree-GooglePay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 802,\n \"name\": \"Braintree-Venmo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BraintreeVenmoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Braintree-Venmo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6710117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 803,\n \"name\": \"Dapp\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DappPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Dapp\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 804,\n \"name\": \"Guatapay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GuatapayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Guatapay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 805,\n \"name\": \"TarjetaEstilos\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TarjetaEstilosPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TarjetaEstilos\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 806,\n \"name\": \"Powerpay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PowerpayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Powerpay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 807,\n \"name\": \"Culqi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CulqiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Culqi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 808,\n \"name\": \"Voucher\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Card.VoucherPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"debitCard\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": \"(50671500|50905500|50905700|50905800|50905900|50906000|50906100|50906300|50925902|50926400|50928400|50928500|50929100|50935700|50942200|50946300)[0-9]{8}|1(0(0(0(0([0-9])|[1-9][0-9]{7})|[1-9][0-9]{8})|[1-9][0-9]{9})|[1-9][0-9]{10})|9(9(9(9(9([0-9])|[0-8][0-9]{7})|[0-8][0-9]{8})|[0-8][0-9]{9})|[0-8][0-9]{10})|[2-8][0-9]{11}\",\n \"mask\": \"9999 9999 9999 9999\",\n \"cardCodeMask\": \"999\",\n \"cardCodeRegex\": \"^[0-9]{3}$\",\n \"weights\": [\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2,\n 1,\n 2\n ],\n \"useCvv\": true,\n \"useExpirationDate\": true,\n \"useCardHolderName\": true,\n \"useBillingAddress\": true,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 809,\n \"name\": \"Carrefour\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CarrefourPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Carrefour\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 810,\n \"name\": \"CredSystem\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CredSystemPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CredSystem\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 811,\n \"name\": \"DMCard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DMCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DMCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 812,\n \"name\": \"Belvo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BelvoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Belvo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6715335Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 813,\n \"name\": \"Zapper\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZapperPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zapper\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 814,\n \"name\": \"Ebucks\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EbucksPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ebucks\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 815,\n \"name\": \"Discovery Miles\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DiscoveryMilesPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Discovery Miles\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 816,\n \"name\": \"Zenkipay - Pay with Crypto\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZenkipayCryptoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zenkipay - Pay with Crypto\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 817,\n \"name\": \"Masterpass\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MasterpassPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Masterpass\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 818,\n \"name\": \"Snapscan\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SnapscanPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Snapscan\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 819,\n \"name\": \"DirectDebit\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DirectDebitPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"DirectDebitPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 820,\n \"name\": \"VirtualIBAN\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtualIBANPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtualIBANPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 821,\n \"name\": \"UniversoFlex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.UniversoFlexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"UniversoFlexPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6720655Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 822,\n \"name\": \"SantanderConsumer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SantanderConsumerPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SantanderConsumerPayment\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 823,\n \"name\": \"dimoFinancing\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DimoFinancingPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"dimoFinancing\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 824,\n \"name\": \"Ceibo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CeiboPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ceibo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 825,\n \"name\": \"Woovi Parcelado\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.WooviParceladoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Woovi Parcelado\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 826,\n \"name\": \"ArgonPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ArgonPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ArgonPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 827,\n \"name\": \"Crypto\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.CryptoCurrencyPayments.CryptoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Crypto\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 828,\n \"name\": \"A2A\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.A2APayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"A2A\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 829,\n \"name\": \"Tino\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TinoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Tino\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6725889Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 830,\n \"name\": \"izipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IzipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"izipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 831,\n \"name\": \"Clip\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ClipPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Clip\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 832,\n \"name\": \"Banese\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BanesePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Banese\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 833,\n \"name\": \"BrasilCard\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BrasilCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BrasilCard\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 834,\n \"name\": \"Bancontact\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancontactPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bancontact\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 835,\n \"name\": \"OrkestaPay Card\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.OrkestaPayCardPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"OrkestaPay Card\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 836,\n \"name\": \"Cuotealo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CuotealoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Cuotealo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 837,\n \"name\": \"PagoClasico\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoClasicoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PagoClasico\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 838,\n \"name\": \"Credito\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6731117Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 839,\n \"name\": \"C2P\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.C2PPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"C2P\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 840,\n \"name\": \"P2C\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.P2CPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"P2C\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 841,\n \"name\": \"Credito Inmediato\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoInmediatoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito Inmediato\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 842,\n \"name\": \"Zelle\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ZellePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Zelle\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 843,\n \"name\": \"MagaluPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.MagaluPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"MagaluPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 844,\n \"name\": \"Geru\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GeruPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Geru\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 845,\n \"name\": \"Credito Mendels\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoMendelsPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito Mendels\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 846,\n \"name\": \"Conekta\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ConektaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Conekta\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6736315Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 847,\n \"name\": \"Pagaleve Pix Mensal\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixMensalPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve Pix Mensal\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 848,\n \"name\": \"Pagaleve Pix Mensal Transparente\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagalevePixMensalTransparentePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pagaleve Pix Mensal Transparente\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 849,\n \"name\": \"Plata Difiere\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PlataDifierePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Plata Difiere\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 850,\n \"name\": \"Directo\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.DirectoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Directo\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 851,\n \"name\": \"Transfero Checkout\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TransferoCheckoutPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Transfero Checkout\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 852,\n \"name\": \"PayWay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayWayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayWay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 853,\n \"name\": \"Ideal V3\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.IdealV3Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ideal V3\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 854,\n \"name\": \"PayZen\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PayZenPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PayZen\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6741555Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 855,\n \"name\": \"AddiMarketplace\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AddiMarketplacePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"AddiMarketplace\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 856,\n \"name\": \"ProntoPaga\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ProntoPagaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"ProntoPaga\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 857,\n \"name\": \"VirtualPOS\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VirtualPOSPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"VirtualPOS\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 858,\n \"name\": \"Pago por QR BAZ\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoporQRBAZPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pago por QR BAZ\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 859,\n \"name\": \"Pago referenciado BAZ\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoreferenciadoBAZPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pago referenciado BAZ\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 860,\n \"name\": \"Pago Deeplink BAZ\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PagoDeeplinkBAZPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pago Deeplink BAZ\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 861,\n \"name\": \"Apipay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ApipayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Apipay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6746801Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 862,\n \"name\": \"Scalapay Pay in 3\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ScalapayPayIn3Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Scalapay Pay in 3\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 863,\n \"name\": \"Scalapay Pay in 4\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.ScalapayPayIn4Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Scalapay Pay in 4\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 864,\n \"name\": \"Blix\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BlixPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Blix\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 865,\n \"name\": \"Niubiz\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NiubizPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Niubiz\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 866,\n \"name\": \"Klarna Pay Later\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.KlarnaPayLaterPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Klarna Pay Later\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 867,\n \"name\": \"facilypay_3x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay3xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_3x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 868,\n \"name\": \"facilypay_4x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay4xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_4x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 869,\n \"name\": \"facilypay_10x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay10xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_10x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6752005Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 870,\n \"name\": \"facilypay_12x\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.Facilypay12xPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"facilypay_12x\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 871,\n \"name\": \"PidekyEscala\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PidekyEscalaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PidekyEscala\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 872,\n \"name\": \"Spin MX\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SpinMXPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Spin MX\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 873,\n \"name\": \"FGTS - Quality Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FGTSQualityPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"FGTS - Quality Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 874,\n \"name\": \"Bancontact Mobile\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BancontactMobilePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Bancontact Mobile\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 875,\n \"name\": \"Yape Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.YapeMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Yape Mercado Pago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 876,\n \"name\": \"Red Servi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RedServiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Red Servi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 877,\n \"name\": \"Punto Red\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PuntoRedPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Punto Red\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 878,\n \"name\": \"Gana\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.GanaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Gana\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 879,\n \"name\": \"Pix Parcelado by PayMee\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PixParceladobyPayMeePayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Pix Parcelado by PayMee\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.675727Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 880,\n \"name\": \"Flex\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FlexPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Flex\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 881,\n \"name\": \"Fiserv\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FiservPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Fiserv\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 882,\n \"name\": \"Visa Click To Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.VisaClickToPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Visa Click To Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 883,\n \"name\": \"Azteca\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.AztecaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Azteca\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 884,\n \"name\": \"CrediPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CrediPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CrediPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 885,\n \"name\": \"Epay Transfer\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpayTransferPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Epay Transfer\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 886,\n \"name\": \"Nave QR\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NaveQRPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Nave QR\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6762575Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 887,\n \"name\": \"BCI\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BCIPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"BCI\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 888,\n \"name\": \"SEPA\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.SEPAPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"SEPA\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 889,\n \"name\": \"CoDi\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CoDiPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"CoDi\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 890,\n \"name\": \"TipTopPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.TipTopPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"TipTopPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 891,\n \"name\": \"RedPay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.RedPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"RedPay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 892,\n \"name\": \"Baccredomatic\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.BaccredomaticPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Baccredomatic\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 893,\n \"name\": \"Creditea\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CrediteaPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Creditea\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6767772Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 894,\n \"name\": \"Findomestic\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FindomesticPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Findomestic\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 895,\n \"name\": \"Novaera\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.NovaeraPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Novaera\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 896,\n \"name\": \"Ecart Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EcartPayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Ecart Pay\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 897,\n \"name\": \"Credito Leather Lovers\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CreditoLeatherLoversPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Credito Leather Lovers\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 898,\n \"name\": \"Fintoc Mercado Pago\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.FintocMercadoPagoPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Fintoc Mercado Pago\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 899,\n \"name\": \"EpaycoTransparent\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpaycoTransparentPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpaycoTransparent\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 900,\n \"name\": \"WH Google Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.WalletHubPayments.WHGooglePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WH Google Pay\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6773076Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 901,\n \"name\": \"WH Apple Pay\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.WalletHubPayments.WHApplePay.WHApplePayPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"WH Apple Pay\",\n \"redirect\": false,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": false,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 1000,\n \"name\": \"EpaycoRedirect\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.EpaycoRedirectPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"EpaycoRedirect\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 1001,\n \"name\": \"PaypalACDCV2\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.PaypalACDCV2Payment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"PaypalACDCV2\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 1002,\n \"name\": \"Carnet\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.RedirectPayments.CarnetPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"Carnet\",\n \"redirect\": true,\n \"isCustom\": false,\n \"isSelfAuthorized\": false,\n \"requiresAuthentication\": false,\n \"allowInstallments\": false,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": true,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": null,\n \"supportRecurrence\": false,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-01T13:32:40.6778434Z\",\n \"allowNotification\": false,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n },\n {\n \"id\": 201,\n \"name\": \"Dinheiro\",\n \"requiresDocument\": false,\n \"implementation\": \"Vtex.PaymentGateway.Promissory.PromissoryPayment\",\n \"connectorImplementation\": null,\n \"antifraudConnectorImplementation\": null,\n \"groupName\": \"custom201PaymentGroup\",\n \"redirect\": false,\n \"isCustom\": true,\n \"isSelfAuthorized\": true,\n \"requiresAuthentication\": false,\n \"allowInstallments\": true,\n \"allowBinExclusion\": false,\n \"allowMultiple\": false,\n \"allowIssuer\": false,\n \"allowCountry\": false,\n \"allowCommercialPolicy\": true,\n \"allowCommercialCondition\": true,\n \"allowPeriod\": true,\n \"isAvailable\": true,\n \"description\": \"Pague no dinheiro\",\n \"supportRecurrence\": true,\n \"validator\": {\n \"regex\": null,\n \"mask\": null,\n \"cardCodeMask\": null,\n \"cardCodeRegex\": null,\n \"weights\": null,\n \"useCvv\": false,\n \"useExpirationDate\": false,\n \"useCardHolderName\": false,\n \"useBillingAddress\": false,\n \"validCardLengths\": null\n },\n \"appDependencies\": [],\n \"displayDocument\": false,\n \"dueDate\": \"2025-04-04T13:32:40.6778434Z\",\n \"allowNotification\": true,\n \"affiliationId\": null,\n \"availablePayments\": null,\n \"dueDateMinutes\": 10080\n }\n]" - } - ] - }, - { - "name": "List Collections", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/catalog_system/pvt/collection/search", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "catalog_system", - "pvt", - "collection", - "search" - ] - }, - "description": "**Official Documentation**: [VTEX Catalog API - GET /api/catalog_system/pvt/collection/search](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/collection/search?endpoint=get-/api/catalog_system/pvt/collection/search)\n\nThis API endpoint allows retrieving catalog collection data from a VTEX account.\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/catalog_system/pvt/collection/search\n\n ```\n\n### Response\n\nA successful response returns a JSON object containing pagination information and an array of catalog collection items.\n\n#### Example Response\n\n``` json\n{\n \"paging\": {\n \"page\": 0,\n \"perPage\": 0,\n \"total\": 0,\n \"pages\": 0,\n \"limit\": 0\n },\n \"items\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"searchable\": true,\n \"highlight\": true,\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"totalSku\": 0,\n \"totalProducts\": 0,\n \"type\": \"\",\n \"lastModifiedBy\": null\n }\n ]\n}\n\n ```\n\n### Fields Description\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `paging.page` | number | Current page number. |\n| `paging.perPage` | number | Number of items per page. |\n| `paging.total` | number | Total number of items available. |\n| `paging.pages` | number | Total number of pages available. |\n| `paging.limit` | number | Maximum number of items per page. |\n| `items` | array | Array of collection objects. |\n| `items[].id` | number | ID of the collection. |\n| `items[].name` | string | Name of the collection. |\n| `items[].searchable` | boolean | Indicates if the collection is searchable. |\n| `items[].highlight` | boolean | Indicates if the collection is highlighted. |\n| `items[].dateFrom` | string | Start date of the collection's validity. |\n| `items[].dateTo` | string | End date of the collection's validity. |\n| `items[].totalSku` | number | Total number of SKUs in the collection. |\n| `items[].totalProducts` | number | Total number of products in the collection. |\n| `items[].type` | string | Type of the collection. |\n| `items[].lastModifiedBy` | string/null | User who last modified the collection, if available. |\n\nThis endpoint provides useful information to manage and view catalog collections with pagination support." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/catalog_system/pvt/collection/search", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "catalog_system", - "pvt", - "collection", - "search" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Tue, 25 Mar 2025 13:39:11 GMT" - }, - { - "key": "Content-Encoding", - "value": "gzip" - }, - { - "key": "Vary", - "value": "Accept-Encoding" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "catalogapi-v3.8.11" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-21-30" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.036" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.036" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8925b71bb3654008054231e03eaa658c.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "JqQHOpNuY_gnUOamyfA7oliKXJJfNh7VjDQhJM5tc7acuEBlD60VXg==" - } - ], - "cookie": [], - "body": "{\n \"paging\": {\n \"page\": 1,\n \"perPage\": 1,\n \"total\": 1,\n \"pages\": 1,\n \"limit\": 3000\n },\n \"items\": [\n {\n \"id\": 137,\n \"name\": \"LeroLero\",\n \"searchable\": false,\n \"highlight\": false,\n \"dateFrom\": \"2025-02-12T14:27:00\",\n \"dateTo\": \"2074-02-12T14:27:00\",\n \"totalSku\": 2,\n \"totalProducts\": 2,\n \"type\": \"Manual\",\n \"lastModifiedBy\": null\n }\n ]\n}" - } - ] - }, - { - "name": "List Credit Cards via Checkout", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/checkout/pub/profiles?email={{email}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "checkout", - "pub", - "profiles" - ], - "query": [ - { - "key": "email", - "value": "{{email}}" - } - ] - }, - "description": "**Official Documentation**: [VTEX Checkout API - GET /api/checkout/pub/profiles](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/profiles)\n\nThis API endpoint retrieves the checkout profiles associated with a given email from the VTEX platform.\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/checkout/pub/profiles?email={{email}}\n\n ```\n\n### Response\n\nA successful response returns a JSON object with the user's profile information, available accounts, addresses, and contact details.\n\n#### Example Response\n\n``` json\n{\n \"userProfileId\": \"\",\n \"profileProvider\": \"\",\n \"availableAccounts\": [\n {\n \"accountId\": \"\",\n \"paymentSystem\": \"\",\n \"paymentSystemName\": \"\",\n \"cardNumber\": \"\",\n \"bin\": \"\",\n \"availableAddresses\": [\"\"],\n \"expirationDate\": \"\",\n \"isExpired\": true,\n \"accountStatus\": null\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"\",\n \"receiverName\": \"\",\n \"addressId\": \"\",\n \"isDisposable\": true,\n \"postalCode\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": []\n }\n ],\n \"contactInformation\": [],\n \"contacts\": [],\n \"contactsInfo\": [],\n \"userProfile\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"document\": \"\",\n \"documentType\": \"\",\n \"phone\": \"\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": true,\n \"profileCompleteOnLoading\": null,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"isComplete\": true\n}\n\n ```\n\n### Fields Description\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `userProfileId` | string | Unique identifier of the user profile. |\n| `profileProvider` | string | Profile provider source. |\n| `availableAccounts` | array | Array of available payment accounts. |\n| `availableAccounts[].accountId` | string | Account ID for the payment method. |\n| `availableAccounts[].paymentSystem` | string | Payment system ID. |\n| `availableAccounts[].paymentSystemName` | string | Name of the payment system. |\n| `availableAccounts[].cardNumber` | string | Masked card number. |\n| `availableAccounts[].bin` | string | Card BIN (first digits of the card). |\n| `availableAccounts[].availableAddresses` | array | Associated address IDs. |\n| `availableAccounts[].expirationDate` | string | Card expiration date. |\n| `availableAccounts[].isExpired` | boolean | Indicates whether the card is expired. |\n| `availableAccounts[].accountStatus` | string/null | Account status, if applicable. |\n| `availableAddresses` | array | List of user addresses. |\n| `availableAddresses[].addressType` | string | Type of address (e.g., residential, billing). |\n| `availableAddresses[].receiverName` | string | Name of the address receiver. |\n| `availableAddresses[].addressId` | string | ID of the address. |\n| `availableAddresses[].isDisposable` | boolean | Indicates if the address is disposable. |\n| `availableAddresses[].postalCode` | string | Postal code. |\n| `availableAddresses[].city` | string | City name. |\n| `availableAddresses[].state` | string | State abbreviation. |\n| `availableAddresses[].country` | string | Country code. |\n| `availableAddresses[].street` | string | Street name. |\n| `availableAddresses[].number` | string | Street number. |\n| `availableAddresses[].neighborhood` | string | Neighborhood name. |\n| `availableAddresses[].complement` | string/null | Complement field. |\n| `availableAddresses[].reference` | string/null | Reference info. |\n| `availableAddresses[].geoCoordinates` | array | Geographic coordinates. |\n| `contactInformation` | array | List of contact information fields (deprecated). |\n| `contacts` | array | Contact details. |\n| `contactsInfo` | array | Detailed contact information. |\n| `userProfile` | object | Object containing user profile data. |\n| `userProfile.email` | string | Email address. |\n| `userProfile.firstName` | string | First name. |\n| `userProfile.lastName` | string | Last name. |\n| `userProfile.document` | string | Document number. |\n| `userProfile.documentType` | string | Type of document (e.g., CPF, CNPJ). |\n| `userProfile.phone` | string | Phone number. |\n| `userProfile.corporateName` | string/null | Corporate name (for B2B users). |\n| `userProfile.tradeName` | string/null | Trade name. |\n| `userProfile.corporateDocument` | string/null | Corporate document number. |\n| `userProfile.stateInscription` | string/null | State inscription. |\n| `userProfile.corporatePhone` | string/null | Corporate phone number. |\n| `userProfile.isCorporate` | boolean | Indicates if the profile is corporate. |\n| `userProfile.profileCompleteOnLoading` | boolean/null | Whether profile was complete on loading. |\n| `userProfile.profileErrorOnLoading` | boolean/null | Whether profile had errors on loading. |\n| `userProfile.customerClass` | string/null | Customer class, if defined. |\n| `isComplete` | boolean | Indicates if the profile is complete. |\n\nThis endpoint is useful for retrieving a customer's saved profile and contextual purchase details during the checkout flow." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.myvtex.com/api/checkout/pub/profiles?email={{email}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "myvtex", - "com" - ], - "path": [ - "api", - "checkout", - "pub", - "profiles" - ], - "query": [ - { - "key": "email", - "value": "{{email}}" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Transfer-Encoding", - "value": "chunked" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Tue, 25 Mar 2025 14:04:50 GMT" - }, - { - "key": "Cache-Control", - "value": "no-store,no-cache,must-revalidate" - }, - { - "key": "Content-Encoding", - "value": "gzip" - }, - { - "key": "Pragma", - "value": "no-store,no-cache" - }, - { - "key": "Vary", - "value": "Accept-Encoding" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "chk-v2.333.0" - }, - { - "key": "x-vtex-operation-id", - "value": "9bf92000-3d0e-4417-bbdd-d214d854cafe" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-56-114" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.787" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.784" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 5013aa2969ca99b3a9a086e23ddf216a.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "RX1Nxwo3YzkySxNa5oTm89jObNXFjq8WWTXhIlQcYCLLWeZs5KLh-w==" - } - ], - "cookie": [], - "body": "{\n \"userProfileId\": \"e607f3bf-2ee4-11e8-81cd-0a9938145238\",\n \"profileProvider\": \"QA Store\",\n \"availableAccounts\": [\n {\n \"accountId\": \"E3263B9493B34087A93B0265410BE177\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"444433\",\n \"availableAddresses\": [\n \"a2d8a83b6b0d43bfb12b76c85ba8e822\"\n ],\n \"expirationDate\": \"03/2021\",\n \"isExpired\": true,\n \"accountStatus\": null\n }\n ],\n \"availableAddresses\": [\n {\n \"addressType\": \"residential\",\n \"receiverName\": \"Saul Goodman\",\n \"addressId\": \"a2d8a83b6b0d43bfb12b76c85ba8e822\",\n \"isDisposable\": false,\n \"postalCode\": \"21050-454\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Avenida Dom Hélder Câmara\",\n \"number\": \"34\",\n \"neighborhood\": \"Maria da Graça\",\n \"complement\": null,\n \"reference\": null,\n \"geoCoordinates\": []\n }\n ],\n \"contactInformation\": [],\n \"contacts\": [],\n \"contactsInfo\": [],\n \"userProfile\": {\n \"email\": \"userautomated0.3313241773905462@mailinator.com\",\n \"firstName\": \"Saul\",\n \"lastName\": \"Goodman\",\n \"document\": \"26927864083\",\n \"documentType\": \"cpf\",\n \"phone\": \"+552222222222\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"profileCompleteOnLoading\": null,\n \"profileErrorOnLoading\": null,\n \"customerClass\": null\n },\n \"isComplete\": true\n}" - } - ] - }, - { - "name": "ALTERNATIVE Get BK / List Credit Cards", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/BK/search?userId={{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "BK", - "search" - ], - "query": [ - { - "key": "userId", - "value": "{{contractId}}" - } - ] - }, - "description": "**Official Documentation**: Not officially documented — alternative retrieval method.\n\nThis endpoint provides an alternative way to retrieve credit card information by querying the `BK` data entity using the `userId` (contract ID).\n\n### Request\n\n**Method:** `GET`\n\n**URL:**\n\n``` plaintext\nhttps://{{accountName}}.myvtex.com/api/dataentities/BK/search?userId={{contractId}}\n\n ```\n\n> No request body is required. \n \n\n### Response\n\nReturns a `200 OK` status with an array of objects containing credit card metadata linked to the provided user ID.\n\n#### Example Response\n\n``` json\n[\n {\n \"name\": \"Visa ending 1234\",\n \"userId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"value\": \"someTokenOrValue\",\n \"id\": \"BK-123\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"BK\"\n }\n]\n\n ```\n\n### Fields Description\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `name` | string | Name or label associated with the credit card. |\n| `userId` | string | Unique identifier of the user (contract ID). |\n| `value` | string | Token or reference value for the credit card. |\n| `id` | string | ID of the document within the BK entity. |\n| `accountId` | string | ID of the VTEX account. |\n| `accountName` | string | Name of the VTEX account. |\n| `dataEntityId` | string | Data entity ID (BK in this case). |\n\nThis method is helpful when alternative access to credit card references is needed for integration or validation flows." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/api/dataentities/BK/search?userId={{contractId}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "BK", - "search" - ], - "query": [ - { - "key": "userId", - "value": "{{contractId}}" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "771" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Tue, 25 Mar 2025 13:58:56 GMT" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Content-Encoding", - "value": "gzip" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "Vary", - "value": "x-vtex-api-appKey,x-vtex-api-appToken,REST-Range,Accept" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.11-api" - }, - { - "key": "REST-AcceptRanges", - "value": "resources" - }, - { - "key": "REST-Content-Range", - "value": "resources 0-1/1" - }, - { - "key": "x-vtex-took", - "value": "174" - }, - { - "key": "X-VTEX-ApiCache-Time", - "value": "0" - }, - { - "key": "X-VTEX-Cache-Status-Janus-ApiCache", - "value": "MISS" - }, - { - "key": "X-Powered-By-VTEX-Cache", - "value": "2.5.0" - }, - { - "key": "X-VTEX-Cache-Server", - "value": "ip-172-16-30-248" - }, - { - "key": "X-VTEX-Cache-Time", - "value": "0.181" - }, - { - "key": "X-VTEX-Cache-Backend-Connect-Time", - "value": "0.000" - }, - { - "key": "X-VTEX-Cache-Backend-Header-Time", - "value": "0.180" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 32f5a0e0ae68a54cbbc9d13f80b4f150.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GRU1-C2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "reVcieIW4QBSVksT2Q5ltBdgpIR9cSCS9frWbUbWZO5CYMGf27vWeQ==" - } - ], - "cookie": [], - "body": "[\n {\n \"name\": \"vcs-checkout\",\n \"userId\": \"e607f3bf-2ee4-11e8-81cd-0a9938145238\",\n \"value\": \"{\\\"isToSavePersonalData\\\":\\\"True\\\",\\\"lastPurchasesAddressId\\\":\\\"a2d8a83b6b0d43bfb12b76c85ba8e822\\\",\\\"paymentData\\\":\\\"{\\\\\"availableAccounts\\\\\":[{\\\\\"accountId\\\\\":\\\\\"E3263B9493B34087A93B0265410BE177\\\\\",\\\\\"paymentSystem\\\\\":\\\\\"2\\\\\",\\\\\"paymentSystemName\\\\\":\\\\\"Visa\\\\\",\\\\\"cardNumber\\\\\":\\\\\"************1111\\\\\",\\\\\"bin\\\\\":\\\\\"444433\\\\\",\\\\\"availableAddresses\\\\\":[\\\\\"a2d8a83b6b0d43bfb12b76c85ba8e822\\\\\"],\\\\\"expirationDate\\\\\":\\\\\"03/2021\\\\\",\\\\\"isExpired\\\\\":true,\\\\\"accountStatus\\\\\":null}],\\\\\"availableTokens\\\\\":[],\\\\\"transactions\\\\\":null,\\\\\"giftCards\\\\\":[],\\\\\"giftCardMessages\\\\\":[],\\\\\"numberOfPaymentErrors\\\\\":0,\\\\\"numberOfDeniedTransactions\\\\\":0,\\\\\"lastDeniedTransaction\\\\\":null}\\\",\\\"lastUserPurchases\\\":\\\"[{\\\\\"creationDate\\\\\":\\\\\"2018-03-23T21: 54: 56.1409516Z\\\\\",\\\\\"orderId\\\\\":\\\\\"819663312477-01\\\\\",\\\\\"orderGroup\\\\\":\\\\\"819663312477\\\\\",\\\\\"value\\\\\":5500}]\\\"}\",\n \"id\": \"e5accdd5-2ee4-11e8-81cd-0a8d3a2dca1a\",\n \"accountId\": \"5f1fe23b-9fd1-417d-a4aa-14df38e7746e\",\n \"accountName\": \"qastore\",\n \"dataEntityId\": \"BK\"\n }\n]" - } - ] - } - ], - "description": "These APIs are auxiliary and must support the completion of contracts, especially the Restrictions fields." - }, - { - "name": "Card Token Systems", - "item": [ - { - "name": "Get Card Token by ID", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "payments", - "pvt", - "accounts", - "{{id}}" - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `ViewPayments` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nRetrieves data for a specific token by its ID (unique identifier automatically generated during token creation).\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n\n## Response\n\n### Successful response\n\n- Status Code: `200 OK` - Returns a card token object.\n \n- Body:\n \n\n``` json\n{\n \"id\": \"string\",\n \"providerId\": \"string\",\n \"orderGroup\": \"string\",\n \"profileId\": \"string\",\n \"shopperId\": \"string\",\n \"email\": \"string\",\n \"card\": {\n \"paymentSystemId\": \"string\",\n \"paymentSystemName\": \"string\",\n \"firstDigits\": \"000000\",\n \"lastDigits\": \"0000\",\n \"address\": {\n \"addressType\": \"string\",\n \"addressId\": \"string\",\n \"postalCode\": \"string\",\n \"street\": \"string\",\n \"neighborhood\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"number\": \"string\",\n \"complement\": \"string\"\n },\n \"holderName\": \"string\"\n },\n \"cardTokenData\": {\n \"type\": \"string\",\n \"value\": \"string\",\n \"expiration\": \"YYYY-MM\",\n \"label\": \"string\",\n \"providerCardTokenId\": \"string\",\n \"useCvvForAuthorization\": \"boolean\",\n \"href\": \"string\"\n },\n \"extraData\": {\n \"string\": \"string\"\n }\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| id | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n| providerId | string | Name of the connector's owner account (`accountName`) used to create the token. |\n| orderGroup | string | Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`, the order group ID is `v71021570str`. |\n| profileId | string | Profile ID in the Profile System (used for contract identification). |\n| shopperId | string | Shopper identification. |\n| email | string | Email is used only if neither `profileId` nor `orderGroup` are provided (rare use). |\n| card | object | Card object. |\n| card.paymentSystemId | string | Payment system ID in the Payment Gateway. |\n| card.paymentSystemName | string | Card brand, e.g. Visa, Mastercard. |\n| card.firstDigits | string | Card BIN (first six digits). |\n| card.lastDigits | string | The last four digits of the card. |\n| card.address | object | Card address object. |\n| card.address.addressType | string | Address type. For example, `Residential` or `Pickup`. |\n| card.address.addressId | string | Address identifier. |\n| card.address.postalCode | string | Postal code (ZIP/CEP). |\n| card.address.street | string | Street name. |\n| card.address.neighborhood | string | Neighborhood name. |\n| card.address.city | string | City name. |\n| card.address.state | string | State name. |\n| card.address.country | string | Country name. |\n| card.address.number | string | Street number. |\n| card.address.complement | string | Address complement (e.g., apartment, building). |\n| card.holderName | string | Name of the cardholder as printed on the card. |\n| cardTokenData | object | Card token data object. |\n| cardTokenData.type | string | Type of token (e.g., FILE, TOKEN_CLIENT_ID, TOKEN_VALUE). |\n| cardTokenData.value | string | The token value to be used in transactions. |\n| cardTokenData.expiration | string | Token expiration date in `YYYY-MM` format. |\n| cardTokenData.label | string | Token alias (an alternative name to simplify token identification). |\n| cardTokenData.providerCardTokenId | string | Client ID used to retrieve the token from the provider. |\n| cardTokenData.useCvvForAuthorization | boolean | Flag indicating if CVV is required (`true`) or not (`false`). |\n| cardTokenData.href | string | URL of the token file stored by the provider. |\n| extraData | object | Dictionary for additional data. |\n\n#### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Invalid request data. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Token not previously registered. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - }, - { - "name": "Create Card Token", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"providerId\":\"string\",\r\n \"profileId\":\"string optional if email or orderGroup exists\",\r\n \"email\": \"string optional if profileId or orderGroup exists\",\r\n \"orderGroup\": \"string optional if profileId or email exists\",\r\n \"card\":{\r\n \"paymentSystemName\":\"string\",\r\n \"paymentSystemId\":\"string optional\",\r\n \"firstDigits\":\"string\",\r\n \"lastDigits\":\"string\",\r\n \"address\":{\r\n \"addressType\":\"string\",\r\n \"addressId\":\"string\",\r\n \"postalCode\":\"string\",\r\n \"street\":\"string\",\r\n \"neighborhood\":\"string\",\r\n \"city\":\"string\",\r\n \"state\":\"string\",\r\n \"country\":\"string\",\r\n \"number\":\"string\",\r\n \"complement\":\"string\"\r\n },\r\n \"holderName\":\"string\"\r\n },\r\n \"cardTokenData\":{\r\n \"type\":\"string\",\r\n \"value\":\"string required if type is TOKEN_VALUE\",\r\n \"expiration\":\"string\",\r\n \"label\":\"string optional\",\r\n \"href\":\"string required if type is FILE\",\r\n \"providerCardTokenId\":\"string required if type is TOKEN_CLIENT_ID\",\r\n \"useCvvForAuthorization\": false // boolean optional default false\r\n },\r\n \"extraData\":{\r\n \"additionalProp1\":\"string\",\r\n \"additionalProp2\":\"string\",\r\n \"additionalProp3\":\"string\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "card-token-vault", - "tokens" - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `CreateCardTokens` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nRegisters a new card token in the system.\n\n### Request body\n\n``` json\n{\n \"providerId\": \"string\",\n \"profileId\": \"string optional if email or orderGroup exists\",\n \"shopperId\": \"string optional, mandatory only if a personal card is used\",\n \"email\": \"string optional if profileId or orderGroup exists\",\n \"orderGroup\": \"string optional if profileId or email exists\",\n \"card\":{\n \"paymentSystemName\": \"string\",\n \"paymentSystemId\": \"string optional\",\n \"firstDigits\": \"string\",\n \"lastDigits\": \"string\",\n \"address\":{\n \"addressType\": \"string\",\n \"addressId\": \"string\",\n \"postalCode\": \"string\",\n \"street\": \"string\",\n \"neighborhood\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"number\": \"string\",\n \"complement\": \"string\"\n },\n \"holderName\": \"string\"\n },\n \"cardTokenData\":{\n \"type\": \"string\",\n \"value\": \"string required if type is TOKEN_VALUE\",\n \"expiration\": \"string\",\n \"label\": \"string optional\",\n \"href\": \"string required if type is FILE\",\n \"providerCardTokenId\": \"string required if type is TOKEN_CLIENT_ID\",\n \"useCvvForAuthorization\": \"boolean optional, default false\"\n },\n \"extraData\":{\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| providerId | Yes | string | Name of the connector's owner account (`accountName`) used to create the token. |\n| profileId | No | string | Profile ID in the Profile System (used for contract identification). This field is optional if `email` or `orderGroup` exists. |\n| shopperId | No | string | Shopper identification. This field is optional and only applicable if a personal card is used. |\n| email | No | string | Email is used only if neither `profileId` nor `orderGroup` are provided (rare use). |\n| orderGroup | No | string | Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`, the order group ID is `v71021570str`. This field is optional if `email` or `profileId` exists. |\n| card | yes | object | Card object. |\n| card.paymentSystemId | No | string | Payment system ID in the Payment Gateway. |\n| card.paymentSystemName | Yes | string | Card brand, e.g. Visa, Mastercard. |\n| card.firstDigits | Yes | string | Card BIN (first six digits). |\n| card.lastDigits | Yes | string | The last four digits of the card. |\n| card.address | No | object | Card address object. |\n| card.address.addressType | No | string | Address type. For example, `Residential` or `Pickup`. |\n| card.address.addressId | No | string | Address identifier. |\n| card.address.postalCode | No | string | Postal code (ZIP/CEP). |\n| card.address.street | No | string | Street name. |\n| card.address.neighborhood | No | string | Neighborhood name. |\n| card.address.city | No | string | City name. |\n| card.address.state | No | string | State name. |\n| card.address.country | No | string | Country name. |\n| card.address.number | No | string | Street number. |\n| card.address.complement | No | string | Address complement (e.g., apartment, building). |\n| card.holderName | No | string | Name of the cardholder as printed on the card. |\n| cardTokenData | Yes | object | Card token data object. |\n| cardTokenData.type | Yes | string | Type of token (e.g., FILE, TOKEN_CLIENT_ID, TOKEN_VALUE). |\n| cardTokenData.value | No | string | The token value to be used in transactions. This field is required if the `type` is TOKEN_VALUE. |\n| cardTokenData.expiration | Yes | string | Token expiration date in `YYYY-MM` format. |\n| cardTokenData.label | No | string | Token alias (an alternative name to simplify token identification). |\n| cardTokenData.href | No | string | URL of the token file stored by the provider. This field is required if the `type` is FILE. |\n| cardTokenData.providerCardTokenId | No | string | Client ID used to retrieve the token from the provider. This field is required if the `type` is TOKEN_CLIENT_ID. |\n| cardTokenData.useCvvForAuthorization | No | boolean | Flag indicating if CVV is required (`true`) or not (`false`). Default: `false`. |\n| extraData | No | object | Dictionary for additional data. |\n\n### Response\n\n#### Successful response\n\n- Status Code: `201 Created` - token saved.\n \n- Body: No content.\n \n\n#### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Problem validating request data. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 409 | Token already exists. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - }, - { - "name": "Update Card Token", - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"providerId\":\"string\",\r\n \"profileId\":\"string optional if email or orderGroup exists\",\r\n \"email\": \"string optional if profileId or orderGroup exists\",\r\n \"orderGroup\": \"string optional if profileId or email exists\",\r\n \"cardTokenData\":{\r\n \"type\":\"string\",\r\n \"value\":\"string required if type is TOKEN_VALUE\",\r\n \"expiration\":\"string\",\r\n \"label\":\"string optional\",\r\n \"href\":\"string required if type is FILE\",\r\n \"providerCardTokenId\":\"string required if type is TOKEN_CLIENT_ID\",\r\n \"useCvvForAuthorization\":\"boolean optional, default false\"\r\n },\r\n \"extraData\":{\r\n \"additionalProp1\":\"string\",\r\n \"additionalProp2\":\"string\",\r\n \"additionalProp3\":\"string\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/{{id}}", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "card-token-vault", - "tokens", - "{{id}}" - ] - }, - "description": "## Request\n\n- **Method**: `PUT`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/{{id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `ManageCardTokens` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nUpdates data for an existing token.\n\nThis endpoint requires sending the complete request body from the **Create Card Token** endpoint, except for the `card` object.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n\n### Request body\n\n``` json\n{\n \"providerId\":\"string\",\n \"profileId\": \"string optional if email or orderGroup exists\",\n \"shopperId\": \"string optional, mandatory only if a personal card is used\",\n \"email\": \"string optional if profileId or orderGroup exists\",\n \"orderGroup\": \"string optional if profileId or email exists\",\n \"cardTokenData\":{\n \"type\": \"string\",\n \"value\": \"string required if type is TOKEN_VALUE\",\n \"expiration\": \"string\",\n \"label\": \"string optional\",\n \"href\": \"string required if type is FILE\",\n \"providerCardTokenId\": \"string required if type is TOKEN_CLIENT_ID\",\n \"useCvvForAuthorization\": \"boolean optional, default false\"\n },\n \"extraData\":{\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| providerId | Yes | string | Name of the owner account of the connector used to create the token. |\n| profileId | No | string | Profile ID in the Profile System. This field is optional if `email` or `orderGroup` exists. |\n| shopperId | No | string | Shopper identification. This field is optional and only applicable if a personal card is used. |\n| email | No | string | Email is used only if neither `profileId` nor `orderGroup` are provided (rare use). |\n| orderGroup | No | string | Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`, the order group ID is `v71021570str`. This field is optional if `email` or `profileId` exists. |\n| cardTokenData | Yes | object | Card token data object. |\n| cardTokenData.type | Yes | string | Type of token (e.g., FILE, TOKEN_CLIENT_ID, TOKEN_VALUE). |\n| cardTokenData.value | No | string | The token value to be used in transactions. This field is required if the `type` is TOKEN_VALUE. |\n| cardTokenData.expiration | Yes | string | Token expiration date in `YYYY-MM` format. |\n| cardTokenData.label | No | string | Token alias (an alternative name to simplify token identification). |\n| cardTokenData.href | No | string | URL of the token file stored by the provider. This field is required if the `type` is FILE. |\n| cardTokenData.providerCardTokenId | No | string | Client ID used to retrieve the token from the provider. This field is required if the `type` is TOKEN_CLIENT_ID. |\n| cardTokenData.useCvvForAuthorization | No | boolean | Flag indicating if CVV is required (`true`) or not (`false`). Default: `false`. |\n| extraData | No | object | Dictionary for additional data. |\n\n### Response\n\n#### Successful response\n\n- Status Code: `201 Created` - token saved.\n \n- Body: No content.\n \n\n#### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Problem validating request data. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Token not previously registered. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - }, - { - "name": "Delete Card Token", - "request": { - "method": "DELETE", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "payments", - "pvt", - "accounts", - "{{id}}" - ] - }, - "description": "## Request\n\n- **Method**: `DELETE`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/payments/pvt/accounts/{{id}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `MakePayments` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nDeletes a token from the system.\n\nThis endpoint doesn’t require a request body.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Token ID (unique identifier automatically generated during token creation and stored in the system). |\n\n## Response\n\n### Successful response\n\n- Status Code: `200 OK` - token deleted.\n \n- Body: No content.\n \n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Token not previously registered. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - }, - { - "name": "Import Token", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "multipart/form-data", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "'file=@\"/C:/test/test.xlsx\"'", - "options": { - "raw": { - "language": "text" - } - } - }, - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "card-token-vault", - "tokens", - "import" - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `multipart/form-data`\n \n- **Permissions**: The user or application key must have the `ImportCardToken` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nImports tokens in bulk via an XLSX file. Note that:\n\n- **File size and type:** Only XLSX files with a maximum size of 20MB are allowed.\n \n- **Simultaneous imports:** Each account can only trigger one import at a time. If an import is in progress, you need to wait for it to finish to trigger another import.\n \n- **Auditing:** All import actions are audited.\n \n\n### Request body\n\n```\n'file=@\"/C:/test/test.xlsx\"'\n\n ```\n\nThe body of the request will contain your XLSX file, which you'll send as a form data part.\n\nThe XLSX file must have the first row with the following headers:\n\n``` json\naccountName,providerId,profileId,paymentSystemName,cardFirstDigits,cardLastDigits,cardAddressType,cardAddressPostalCode,cardAddressStreet,cardAddressNeighborhood,cardAddressCity,cardAddressState,cardAddressCountry,cardAddressNumber,cardAddressComplement,cardHolderName,tokenType,tokenValue,tokenExpiration,tokenLabel,tokenProviderCardTokenId,tokenUseCvvForAuthorization,tokenHref,extraData,email,shopperId\n\n ```\n\nThe `extraData` field should contain a JSON with a dictionary of additional data, or an empty JSON.\n\n## Response\n\n### Successful response\n\n- Status Code: `202 Accepted` - File received.\n \n- Body: Returns an import the Token ID in the system, which can be used to retrieve the import status and the report from the import.\n \n\n``` json\n{\n\"id\": \"string\"\n}\n\n ```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| id | string | Import ID. |\n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 400 | Incorrect `Content-Type` or invalid file type. |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - }, - { - "name": "Retrieve Import Current Status", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "card-token-vault", - "tokens", - "import", - "{{importId}}" - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `GetImportCardTokenStatus` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nReturns the status and progress percentage of an import.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| importId | Yes | string | Import ID. |\n\n## Response\n\n### Successful response\n\n- Status Code: `200 OK` - import data obtained.\n \n- Body: Returns the import status.\n \n\n``` json\n{\n \"status\": \"RUNNING\",\n \"id\": \"string\",\n \"completionPercentage\":\"integer\",\n \"createdDate\": \"string\",\"\n \"updatedDate\": \"string\",\n \"reportUrl\":\"string optional if the import process had any error\"\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| status | string | Response status, which can be: `DONE`, `RUNNING`, `CREATED` or `FAILED`. |\n| id | string | Import ID. |\n| completionPercentage | integer | Importing completion percentage. |\n| createdDate | string | Creation date. |\n| updatedDate | string | Last update date. |\n| reportUrl | string | Report URL. This field is optional if the import process had an error. |\n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Import not found. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - }, - { - "name": "Retrieve Import Report", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - } - ], - "url": { - "raw": "{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}/report", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "card-token-vault", - "tokens", - "import", - "{{importId}}", - "report" - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/card-token-vault/tokens/import/{{importId}}/report`\n \n- **Authentication**: Requires `VtexIdclientAutCookie` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `GetImportCardTokensReport` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n \n\nReturns the import report, indicating lines with issues.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| importId | Yes | string | Import ID. |\n\n## Response\n\n### Successful response\n\n- Status Code: `302 Found` - redirects the user to the report download URL.\n \n\n### Unsuccessful responses\n\n| HTTP Status Code | Description |\n| --- | --- |\n| 401 | Invalid or unauthorized auth headers. |\n| 403 | Missing auth headers. |\n| 404 | Import not found. |\n| 500 | Internal server error – unexpected issue on the server. Retry after a short delay or contact support if the problem persists. |" - }, - "response": [] - } - ], - "description": "The Card Token Vault API is responsible for creating and updating card tokens, as well as supporting bulk imports. Card tokens are unique identifiers that represent securely stored credit card data. The Payment Gateway API enables the retrieval and deletion of card tokens.\n\n> ℹ️ This API's endpoints can be used for personal cards (cards associated with a single buyer) and shared cards (cards used by more than one person and associated with a specific contract). However, in a scenario of operations with personal cards, the `shopperId` must be additionally sent in the [Created Card Token](https://documenter.getpostman.com/view/2352637/2sAYkKGcHD#7fe79cbd-2f5b-420b-9993-f4b4af8265d1) or [Update Card Token](https://documenter.getpostman.com/view/2352637/2sAYkKGcHD#cba5b948-a4ad-4eb8-8659-7c32a3bd232b) endpoints." - }, - { - "name": "B2B User Migration", - "item": [ - { - "name": "1. Create User", - "request": { - "method": "POST", - "header": [ - { - "key": "Cookie", - "value": "VtexIdclientAutCookie_b2bfaststoredev={{VtexIdclientAutCookie}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"identifier\": \"unique_login_key\",\n \"identifierType\": \"username\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountname}}.vtexcommercestable.com.br/api/authenticator/storefront/users?isLegacyPassword=false", - "protocol": "https", - "host": [ - "{{accountname}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "authenticator", - "storefront", - "users" - ], - "query": [ - { - "key": "isLegacyPassword", - "value": "false" - } - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountname}}.vtexcommercestable.com.br/api/authenticator/storefront/users?isLegacyPassword=false`\n \n- **Authentication**: Requires `VtexIdclientAutCookie_{{accountname}}={{VtexIdclientAutCookie}}` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Create user` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (VTEX ID > User Management).\n \n\nRegister a new user in the [VTEX ID](https://developers.vtex.com/docs/api-reference/vtex-id-api).\n\n> ℹ️ All users are created without any Organization Unit or storefront permissions assigned to them. \n \n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| isLegacyPassword | Yes | boolean | Indicates whether the user’s password recovery should be handled by an external service or by the user themself during their first login. The default value is `false`, meaning the user will set their password. |\n\n### Request body\n\n``` json\n{\n \"identifier\": \"unique_login_key\",\n \"identifierType\": \"username\"\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| identifier | Yes | string | This user will be registered with a `unique_login_key`, which is their unique identifier during the login process. The `unique_login_key` is an open, case-insensitive field that accepts 3 to 70 characters, including special characters and whitespace. |\n| identifierType | Yes | string | Indicate the type of login key added, including values such as `username`, `email`, or `telephone`. Currently, only the `username` value is supported. |\n\n> ⚠️ Once you create a user, you cannot edit or delete it. If any data was entered incorrectly, the easiest solution is to create a new username with the correct details." - }, - "response": [] - }, - { - "name": "2. Get User by Identifier", - "request": { - "method": "GET", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}" - } - ], - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/pvt/user/info?user={{identifier}}", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "vtexid", - "pvt", - "user", - "info" - ], - "query": [ - { - "key": "user", - "value": "{{identifier}}" - } - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/vtexid/pvt/user/info?user={{identifier}}`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n\nSearch for a user by their identifier (username, email, or telephone).\n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| identifier | Yes | string | This information must be provided in URL-encoded format. |" - }, - "response": [] - }, - { - "name": "3. Get List of Organization Units", - "request": { - "method": "GET", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}" - } - ], - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1?page=4&pageSize=100", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "organization-units", - "v1" - ], - "query": [ - { - "key": "page", - "value": "4" - }, - { - "key": "pageSize", - "value": "100" - } - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1?page=4&pageSize=100`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nRetrieves a paginated list of all Organization Units, which can be navigated using the `page` and `pageSize` parameters.\n\n> ℹ️ Organization Units represent the organizations to which a buyer user belongs. \n \n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| page | Yes | number | Page number of the results. |\n| pageSize | Yes | number | Number of items per page. |" - }, - "response": [] - }, - { - "name": "4. Create Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"{{Unit Name}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "organization-units", - "v1" - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/organization-units/v1`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nCreates a new Organization Unit. All units are initially created at the root level.\n\n### Request body\n\n``` json\n{\n \"name\": \"Unit Name\"\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| name | Yes | string | Name of the Organization Unit to be created. |" - }, - "response": [] - }, - { - "name": "5. Assign user to Organization Unit", - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text", - "disabled": true - }, - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"userIds\": [\"userId\"]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{organizationUnit}}", - "users" - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nLinks a user to an Organization Unit.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| organizationUnit | Yes | string | Name of the Organizational Unit where the user will be assigned. |\n\n### Request body\n\n``` json\n{\n \"userIds\": [\"userId\"]\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| userIds | Yes | array | Identification of the user to whom an Organization Unit will be assigned. |" - }, - "response": [] - }, - { - "name": "6. Get Users from Unit", - "request": { - "method": "GET", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "vtexid", - "organization-units", - "{{organizationUnit}}", - "users" - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/vtexid/organization-units/{{organizationUnit}}/users`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `View Organization Unit` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Organization Units > Units).\n \n\nLists all users stored in an Organization Unit.\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| organizationUnit | Yes | string | Name of the Organizational Unit where users are stored. |" - }, - "response": [] - }, - { - "name": "7. Assign Roles to User", - "request": { - "method": "POST", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"userId\",\n \"roleIds\": [1, 2, 3]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "license-manager", - "storefront", - "users" - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Edit Storefront User Permissions` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (License manager > Services access control).\n \n\nAssigns one or more administrative roles to a buyer user within an organization.\n\nEach administrative role is identified by a unique `roleId`, represented as a number. You can find the available `roleId` values and their corresponding permissions in the table below:\n\n| Permission | Available Actions | RoleID |\n| --- | --- | --- |\n| **Organizational Unit Admin** | Manage Organization & Contract | 1 |\n| **Order Approver** | Approve Orders | 2 |\n| **Order Modifier** | Modify Orders | 3 |\n| **Buyer** | Place Orders | 4 |\n| **Personal Cards User** | Use ad hoc credit card | 5 |\n| **Contract Manager** | View My Contract Orders | 6 |\n| **Buyer Organization Manager** | View My Org Unit Orders | 7 |\n| **Contract Viewer** | Manage Authentication
View My Cards
View Addresses | 8 |\n| **Address Manager** | Manage Addresses | 9 |\n\n### Request body\n\n``` json\n{\n \"id\": \"userId\",\n \"roleIds\": [1, 2, 3]\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | Yes | string | Identification of the user to whom one or more roles will be assigned. |\n| rolesIds | Yes | array of numbers | Identification number of the assigned role. |" - }, - "response": [] - }, - { - "name": "8. Verify User Roles", - "request": { - "method": "GET", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "url": { - "raw": "https://{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users/{{username}}/roles", - "protocol": "https", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "license-manager", - "storefront", - "users", - "{{username}}", - "roles" - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `https://{{accountName}}.vtexcommercestable.com.br/api/license-manager/storefront/users/{{username}}/roles`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Save Storefront User Permissions` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (License manager > Services access control).\n \n\nList the administrative roles for a storefront user. For more information, see [Fetch storefront user roles by ID](https://developers.vtex.com/docs/api-reference/storefront-permissions-api#get-/api/license-manager/storefront/users/-userId-/roles).\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| username | Yes | string | Username identification. |" - }, - "response": [] - }, - { - "name": "9. Save shopper data", - "request": { - "method": "POST", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n\t\"userId\": \"userId\",\n\t\"firstName\": \"User First Name 2\",\n\t\"lastName\": \"User Last Name\",\n\t\"document\": \"111.444.000-00\",\n \"email\": \"user@vtex.com\",\n \"phone\": \"5583987499600\",\n\t\"documentType\": \"cpf\",\n\t\"cards\": [],\n \"unitId\": \"{{organizationUnit}}\"\n}\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1", - "protocol": "http", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "dataentities", - "shopper", - "documents" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - } - ] - }, - "description": "## Request\n\n- **Method**: `POST`\n \n- **URL**: `http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/documents?_schema=v1`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Dynamic storage generic resources` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Dynamic Storage).\n \n\nPopulates and manages users’ profile information. Shopper data serves as the source of truth for details as first and last name, document, telephone, email, and more.\n\nFor more information, see [VTEX Developers - Master Data APIs](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents).\n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| _schema | Yes | string | Version identification. |\n\n### Request body\n\n``` json\n{\n \"userId\": \"userId\",\n \"firstName\": \"User First Name 2\",\n \"lastName\": \"User Last Name\",\n \"document\": \"111.444.000-00\",\n \"email\": \"user@vtex.com\",\n \"phone\": \"5583987499600\",\n \"documentType\": \"cpf\",\n \"cards\": []\n}\n\n ```\n\n| Field | Required | Type | Description |\n| --- | --- | --- | --- |\n| userId | Yes | string | User identification. |\n| firstName | Yes | string | The first name of the user. |\n| lastName | Yes | string | The last name of the user. |\n| document | Yes | string | The document number of the user. |\n| email | Yes | string | The email of the user. |\n| phone | Yes | string | The phone number of the user. |\n| documentType | Yes | string | Type of document (e.g., CPF, CNPJ). |\n| cards | Yes | array | Cards information. |" - }, - "response": [] - }, - { - "name": "10. Get shopper data", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "X-VTEX-API-AppKey", - "value": "{{X-VTEX-API-AppKey}}", - "type": "text" - }, - { - "key": "X-VTEX-API-AppToken", - "value": "{{X-VTEX-API-AppToken}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/search?_schema=v1&_where=userId={{userId}}&_fields=_all", - "protocol": "http", - "host": [ - "{{accountName}}", - "vtexcommercestable", - "com", - "br" - ], - "path": [ - "api", - "dataentities", - "shopper", - "search" - ], - "query": [ - { - "key": "_schema", - "value": "v1" - }, - { - "key": "_where", - "value": "userId={{userId}}" - }, - { - "key": "_fields", - "value": "_all" - } - ] - }, - "description": "## Request\n\n- **Method**: `GET`\n \n- **URL**: `http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/shopper/search?_schema=v1&_where=userId={{userId}}&_fields=_all`\n \n- **Authentication**: Requires `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` in the headers.\n \n- **HTTP Headers**: Accept `application/json` / Content-Type `application/json`\n \n- **Permissions**: The user or application key must have the `Dynamic storage generic resources` [License Manager resource](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) (Dynamic Storage).\n \n\nList the stored shopper data. For more information, see [VTEX Developers - Master Data APIs](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents).\n\n### Query parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| _schema | Yes | string | Version identification. |\n| _where | Yes | string | Username identification. |\n| _fields | Yes | string | Identification of the shopper profile fields that will be displayed. |\n\n### Path parameter\n\n| Parameter | Required | Type | Description |\n| --- | --- | --- | --- |\n| userId | Yes | string | Username identification. |" - }, - "response": [] - } - ], - "description": "This guide explains a secure process for migrating a merchant’s user base - including user passwords - from external platforms to VTEX.\n\nThe migration involves the following operations:\n\n1. Creating users at VTEX\n \n2. Adding users to Buyer Organizations\n \n3. Assigning administrative roles within Buyer Organizations\n \n4. Registering profile information" - }, - { - "name": "🧪 EXPERIMENTAL 🧪", - "item": [ - { - "name": "Prospects", - "item": [ - { - "name": "Create Prospect", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "PUT", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"businessDocument\": \"{{businessDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"fancyName\": \"{{fancyName}}\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/PS/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "PS", - "documents" - ] - }, - "description": "This endpoint allows you to add a new document entity to the system.\n\n#### Request Body\n\n- `email` (string): The email of the entity.\n \n- `firstName` (string): The first name of the entity.\n \n- `lastName` (string): The last name of the entity.\n \n- `document` (string): The document number of the entity.\n \n- `documentType` (string): The type of document.\n \n- `businessDocument` (string): The business document of the entity.\n \n- `homePhone` (string): The home phone number of the entity.\n \n- `cellPhone` (string): The cell phone number of the entity.\n \n- `corporateName` (string): The corporate name of the entity.\n \n- `fancyName` (string): The fancy name of the entity.\n \n- `isPJ` (boolean): Indicates if the entity is a legal entity.\n \n- `stateRegistration` (string): The state registration of the entity.\n \n- `isFreeStateRegistration` (boolean): Indicates if the state registration is free.\n \n\n#### Response\n\n- `Id` (string): The ID of the newly added document entity.\n \n- `Href` (string): The URL of the newly added document entity.\n \n- `DocumentId` (string): The document ID of the newly added document entity." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"business-klub-spc@email.com\",\r\n \"firstName\": \"Business Klub\",\r\n \"lastName\": \"SPC\",\r\n \"document\": \"00000000000000\",\r\n \"documentType\": \"CNPJ\",\r\n \"businessDocument\": \"00000000000000\",\r\n \"homePhone\": \"1122223333\",\r\n \"cellPhone\": \"11999991111\",\r\n \"businessPhone\": \"1122223333\",\r\n \"corporateName\": \"Business Klub SPC\",\r\n \"fancyName\": \"Business Klub SPC\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "202" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Wed, 19 Mar 2025 21:43:29 GMT" - }, - { - "key": "x-vtex-took", - "value": "135" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.8-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "V7-IZnmhGRFbCKMOxAt_deklX3uTFhSkxJZ4UYnFRnif2Y10V_eL4Q==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/PS/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}" - } - ] - }, - { - "name": "List Prospects", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{vault:VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"firstName\": \"{{firstName}}\",\r\n \"lastName\": \"{{lastName}}\",\r\n \"document\": \"{{document}}\",\r\n \"documentType\": \"{{documentType}}\",\r\n \"businessDocument\": \"{{businessDocument}}\",\r\n \"homePhone\": \"{{homePhone}}\",\r\n \"cellPhone\": \"{{cellPhone}}\",\r\n \"corporateName\": \"{{corporateName}}\",\r\n \"fancyName\": \"{{fancyName}}\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/PS/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "PS", - "documents" - ] - }, - "description": "### Add New ProspectEntity\n\nThis endpoint allows you to add a new document entity to the system.\n\n#### Request Body\n\n- `email` (string): The email of the entity.\n \n- `firstName` (string): The first name of the entity.\n \n- `lastName` (string): The last name of the entity.\n \n- `document` (string): The document number of the entity.\n \n- `documentType` (string): The type of document.\n \n- `businessDocument` (string): The business document of the entity.\n \n- `homePhone` (string): The home phone number of the entity.\n \n- `cellPhone` (string): The cell phone number of the entity.\n \n- `corporateName` (string): The corporate name of the entity.\n \n- `fancyName` (string): The fancy name of the entity.\n \n- `isPJ` (boolean): Indicates if the entity is a legal entity.\n \n- `stateRegistration` (string): The state registration of the entity.\n \n- `isFreeStateRegistration` (boolean): Indicates if the state registration is free.\n \n\n#### Response\n\n- `Id` (string): The ID of the newly added document entity.\n \n- `Href` (string): The URL of the newly added document entity.\n \n- `DocumentId` (string): The document ID of the newly added document entity." - }, - "response": [ - { - "name": "Success", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "VtexIdclientAutCookie", - "value": "{{VtexIdclientAutCookie}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"email\": \"business-klub-spc@email.com\",\r\n \"firstName\": \"Business Klub\",\r\n \"lastName\": \"SPC\",\r\n \"document\": \"00000000000000\",\r\n \"documentType\": \"CNPJ\",\r\n \"businessDocument\": \"00000000000000\",\r\n \"homePhone\": \"1122223333\",\r\n \"cellPhone\": \"11999991111\",\r\n \"businessPhone\": \"1122223333\",\r\n \"corporateName\": \"Business Klub SPC\",\r\n \"fancyName\": \"Business Klub SPC\",\r\n \"isPJ\": \"true\",\r\n \"stateRegistration\": \"\",\r\n \"isFreeStateRegistration\": \"true\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/dataentities/CL/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "dataentities", - "CL", - "documents" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json; charset=utf-8" - }, - { - "key": "Content-Length", - "value": "202" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "Date", - "value": "Wed, 19 Mar 2025 21:43:29 GMT" - }, - { - "key": "x-vtex-took", - "value": "135" - }, - { - "key": "Access-Control-Allow-Origin", - "value": "*" - }, - { - "key": "Access-Control-Expose-Headers", - "value": "REST-Content-Range" - }, - { - "key": "Cache-Control", - "value": "no-cache" - }, - { - "key": "Expires", - "value": "-1" - }, - { - "key": "Pragma", - "value": "no-cache" - }, - { - "key": "X-VTEX-Janus-Router-Backend-App", - "value": "ds-api-v10.210.8-api" - }, - { - "key": "X-AspNet-Version", - "value": "4.0.30319" - }, - { - "key": "X-Powered-By", - "value": "ASP.NET" - }, - { - "key": "X-Cache", - "value": "Miss from cloudfront" - }, - { - "key": "Via", - "value": "1.1 8db1498f1236a36c9d5ac3af2a9d7f90.cloudfront.net (CloudFront)" - }, - { - "key": "X-Amz-Cf-Pop", - "value": "GIG51-P2" - }, - { - "key": "X-Amz-Cf-Id", - "value": "V7-IZnmhGRFbCKMOxAt_deklX3uTFhSkxJZ4UYnFRnif2Y10V_eL4Q==" - } - ], - "cookie": [], - "body": "{\n \"Id\": \"CL-2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"Href\": \"http://qastore.myvtex.com/api/dataentities/PS/documents/2da4e9ab-050b-11f0-b37f-f4b136dbcce1\",\n \"DocumentId\": \"2da4e9ab-050b-11f0-b37f-f4b136dbcce1\"\n}" - } - ] - } - ], - "description": "These APIs are for creating the contract, and are expected to be used only for store management. \nIn this collection there are auxiliary APIs to support filling out the contract, especially the restrictions object." - } - ] - } - ], - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "accountName", - "value": "{{accountName}}" - }, - { - "key": "unitId", - "value": "{{unitId}}" - }, - { - "key": "userId", - "value": "{{userId}}" - }, - { - "key": "baseUrl", - "value": "https://{{accountName}}.myvtex.com" - }, - { - "key": "scope", - "value": "{{contractIds|addresses|paymentSystemIds|priceTables|collectionIds|creditCards|customFields}}" - }, - { - "key": "term", - "value": "{{term}}" - }, - { - "key": "resourceKey", - "value": "{{resourceKey}}" - }, - { - "key": "budgetId", - "value": "{{budgetId}}" - }, - { - "key": "allocationId", - "value": "{{allocationId}}" - }, - { - "key": "reservationId", - "value": "{{reservationId}}" - }, - { - "key": "transactionId", - "value": "{{transactionId}}" - }, - { - "key": "contractId", - "value": "{{contractId}}" - }, - { - "key": "addressId", - "value": "{{addressId}}" - }, - { - "key": "unitName", - "value": "{{unitName}}" - }, - { - "key": "customFieldValueId", - "value": "{{customFieldValueId}}" - }, - { - "key": "customField", - "value": "{{customField}}" - }, - { - "key": "email", - "value": "{{email}}" - } - ] -} \ No newline at end of file From b6d59a2ee00c7c72ca17b583a67f67c010152841 Mon Sep 17 00:00:00 2001 From: Ricardo Correia Date: Mon, 18 May 2026 11:01:56 -0300 Subject: [PATCH 4/8] EDU-18335 - Update List Payment Provider Manifest endpoint --- VTEX - Payment Provider Protocol.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Payment Provider Protocol.json b/VTEX - Payment Provider Protocol.json index 01ca6bb80..365cf6f2d 100644 --- a/VTEX - Payment Provider Protocol.json +++ b/VTEX - Payment Provider Protocol.json @@ -24,7 +24,7 @@ "Payment Flow" ], "summary": "List Payment Provider Manifest", - "description": "Exposes the provider manifest, including metadata settings such as payment methods, split configuration, and custom fields.\r\n\r\n> ℹ️ This request is made from VTEX to the payment provider.\r\n\r\n## Available payment methods\r\n\r\n| Payment Method | Type | Country |\r\n|---|---|---|\r\n| `Visa` | Credit Card | Global |\r\n| `Mastercard` | Credit Card | Global |\r\n| `American Express` | Credit Card | Global |\r\n| `Discover` | Credit Card | Global |\r\n| `JCB` | Credit Card | Global |\r\n| `Diners` | Credit Card | Global |\r\n| `Elo` | Credit Card | Brazil |\r\n| `Hipercard` | Credit Card | Brazil |\r\n| `Aura` | Credit Card | Brazil |\r\n| `Banricompras` | Credit Card | Brazil |\r\n| `Credz` | Credit Card | Brazil |\r\n| `Cabal` | Credit Card | Argentina, Brazil, Uruguay, Paraguay |\r\n| `Cartes Bancaires (CB)` | Credit Card | France |\r\n| `VirtualDebitElo` | Debit Card | Brazil |\r\n| `Visa Electron` | Debit Card | Global |\r\n| `Maestro` | Debit Card | Global |\r\n| `Mastercard Debit` | Debit Card | Global |\r\n| `D\u00e9bito Online` | Debit Card | Brazil |\r\n| `Cobranded` | Card | Global |\r\n| `Privatelabels` | Card | Global |\r\n| `Apple Pay` | Digital Wallet | Global |\r\n| `Google Pay` | Digital Wallet | Global |\r\n| `Promissories` | Generic | Global |\r\n| `Cash` | Generic | Global |\r\n| `Pix` | Online Transfer | Brazil |\r\n| `Safetypay` | Online Transfer | Americas and Europe |\r\n| `BankInvoice` | Offline/Voucher | Brazil (Boleto Banc\u00e1rio) |\r\n| `FichaDeposito` | Offline/Voucher | Mexico |\r\n| `Rapipago` | Offline/Voucher | Argentina |\r\n| `OXXO` | Offline/Voucher | Mexico |\r\n| `Voucher` | Offline/Voucher | Mexico |\r\n| `Bitcoin` | Cryptocurrency | Global |\r\n| `Venda Direta Credito` | Credit Card (Physical) | Global |\r\n| `Venda Direta Debito` | Debit Card (Physical) | Global | \r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "description": "Exposes the provider manifest, including metadata settings such as payment methods, split configuration, and custom fields.\r\n\r\n> ℹ️ This request is made from VTEX to the payment provider.\r\n\r\n## Available payment methods\r\n\r\n| Payment Method | Type | Country |\r\n|---|---|---|\r\n| `Visa` | Credit Card | Global |\r\n| `Mastercard` | Credit Card | Global |\r\n| `American Express` | Credit Card | Global |\r\n| `Discover` | Credit Card | Global |\r\n| `JCB` | Credit Card | Global |\r\n| `Diners` | Credit Card | Global |\r\n| `Elo` | Credit Card | Brazil |\r\n| `Hipercard` | Credit Card | Brazil |\r\n| `Aura` | Credit Card | Brazil |\r\n| `Banricompras` | Credit Card | Brazil |\r\n| `Credz` | Credit Card | Brazil |\r\n| `Cabal` | Credit Card | Argentina, Brazil, Uruguay, Paraguay |\r\n| `Patagonia 365` | Credit Card | Argentina |\r\n| `Cartes Bancaires (CB)` | Credit Card | France |\r\n| `VirtualDebitElo` | Debit Card | Brazil |\r\n| `Visa Electron` | Debit Card | Global |\r\n| `Maestro` | Debit Card | Global |\r\n| `Mastercard Debit` | Debit Card | Global |\r\n| `D\u00e9bito Online` | Debit Card | Brazil |\r\n| `Cobranded` | Card | Global |\r\n| `Privatelabels` | Card | Global |\r\n| `Apple Pay` | Digital Wallet | Global |\r\n| `Google Pay` | Digital Wallet | Global |\r\n| `Promissories` | Generic | Global |\r\n| `Cash` | Generic | Global |\r\n| `Pix` | Online Transfer | Brazil |\r\n| `Safetypay` | Online Transfer | Americas and Europe |\r\n| `BankInvoice` | Offline/Voucher | Brazil (Boleto Banc\u00e1rio) |\r\n| `FichaDeposito` | Offline/Voucher | Mexico |\r\n| `Rapipago` | Offline/Voucher | Argentina |\r\n| `OXXO` | Offline/Voucher | Mexico |\r\n| `Voucher` | Offline/Voucher | Mexico |\r\n| `Bitcoin` | Cryptocurrency | Global |\r\n| `Venda Direta Credito` | Credit Card (Physical) | Global |\r\n| `Venda Direta Debito` | Debit Card (Physical) | Global | \r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "operationId": "Manifest", "security": [], "parameters": [ From acba90573963e93910acbdfa0dcd55dbd31f53e0 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Mon, 18 May 2026 14:05:31 +0000 Subject: [PATCH 5/8] chore: update postman files --- .../VTEX - Payment Provider Protocol.json | 138 +++++++++--------- 1 file changed, 69 insertions(+), 69 deletions(-) diff --git a/PostmanCollections/VTEX - Payment Provider Protocol.json b/PostmanCollections/VTEX - Payment Provider Protocol.json index 6671ee708..b33387ded 100644 --- a/PostmanCollections/VTEX - Payment Provider Protocol.json +++ b/PostmanCollections/VTEX - Payment Provider Protocol.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "ea0c0b2a-83d2-4ce0-ae41-d02033689827" + "postman_id": "887d88da-926b-4f59-a4b1-d0970283c8d1" }, "item": [ { - "id": "6fc4c158-6e7f-4e1f-a09c-998dbdf94cb4", + "id": "31853ffb-f70d-4a25-af82-279d7fcea7dc", "name": "Payment Flow", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "4970eb22-748e-4493-892c-8c53090e5017", + "id": "88ad60b0-b0ab-4359-8a05-c41b3dfb7bba", "name": "List Payment Provider Manifest", "request": { "name": "List Payment Provider Manifest", "description": { - "content": "Exposes the provider manifest, including metadata settings such as payment methods, split configuration, and custom fields.\r\n\r\n> ℹ️ This request is made from VTEX to the payment provider.\r\n\r\n## Available payment methods\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
Payment MethodTypeCountry
VisaCredit CardGlobal
MastercardCredit CardGlobal
American ExpressCredit CardGlobal
DiscoverCredit CardGlobal
JCBCredit CardGlobal
DinersCredit CardGlobal
EloCredit CardBrazil
HipercardCredit CardBrazil
AuraCredit CardBrazil
BanricomprasCredit CardBrazil
CredzCredit CardBrazil
CabalCredit CardArgentina, Brazil, Uruguay, Paraguay
Cartes Bancaires (CB)Credit CardFrance
VirtualDebitEloDebit CardBrazil
Visa ElectronDebit CardGlobal
MaestroDebit CardGlobal
Mastercard DebitDebit CardGlobal
Débito OnlineDebit CardBrazil
CobrandedCardGlobal
PrivatelabelsCardGlobal
Apple PayDigital WalletGlobal
Google PayDigital WalletGlobal
PromissoriesGenericGlobal
CashGenericGlobal
PixOnline TransferBrazil
SafetypayOnline TransferAmericas and Europe
BankInvoiceOffline/VoucherBrazil (Boleto Bancário)
FichaDepositoOffline/VoucherMexico
RapipagoOffline/VoucherArgentina
OXXOOffline/VoucherMexico
VoucherOffline/VoucherMexico
BitcoinCryptocurrencyGlobal
Venda Direta CreditoCredit Card (Physical)Global
Venda Direta DebitoDebit Card (Physical)Global
\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "content": "Exposes the provider manifest, including metadata settings such as payment methods, split configuration, and custom fields.\r\n\r\n> ℹ️ This request is made from VTEX to the payment provider.\r\n\r\n## Available payment methods\r\n\r\n| Payment Method | Type | Country |\r\n|---|---|---|\r\n| `Visa` | Credit Card | Global |\r\n| `Mastercard` | Credit Card | Global |\r\n| `American Express` | Credit Card | Global |\r\n| `Discover` | Credit Card | Global |\r\n| `JCB` | Credit Card | Global |\r\n| `Diners` | Credit Card | Global |\r\n| `Elo` | Credit Card | Brazil |\r\n| `Hipercard` | Credit Card | Brazil |\r\n| `Aura` | Credit Card | Brazil |\r\n| `Banricompras` | Credit Card | Brazil |\r\n| `Credz` | Credit Card | Brazil |\r\n| `Cabal` | Credit Card | Argentina, Brazil, Uruguay, Paraguay |\r\n| `Patagonia 365` | Credit Card | Argentina |\r\n| `Cartes Bancaires (CB)` | Credit Card | France |\r\n| `VirtualDebitElo` | Debit Card | Brazil |\r\n| `Visa Electron` | Debit Card | Global |\r\n| `Maestro` | Debit Card | Global |\r\n| `Mastercard Debit` | Debit Card | Global |\r\n| `Débito Online` | Debit Card | Brazil |\r\n| `Cobranded` | Card | Global |\r\n| `Privatelabels` | Card | Global |\r\n| `Apple Pay` | Digital Wallet | Global |\r\n| `Google Pay` | Digital Wallet | Global |\r\n| `Promissories` | Generic | Global |\r\n| `Cash` | Generic | Global |\r\n| `Pix` | Online Transfer | Brazil |\r\n| `Safetypay` | Online Transfer | Americas and Europe |\r\n| `BankInvoice` | Offline/Voucher | Brazil (Boleto Bancário) |\r\n| `FichaDeposito` | Offline/Voucher | Mexico |\r\n| `Rapipago` | Offline/Voucher | Argentina |\r\n| `OXXO` | Offline/Voucher | Mexico |\r\n| `Voucher` | Offline/Voucher | Mexico |\r\n| `Bitcoin` | Cryptocurrency | Global |\r\n| `Venda Direta Credito` | Credit Card (Physical) | Global |\r\n| `Venda Direta Debito` | Debit Card (Physical) | Global | \r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "type": "text/plain" }, "url": { @@ -62,7 +62,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e1db3580-f3cc-4a0c-9dac-63b827095b50", + "id": "40b93487-0498-40e0-b5fc-f4d8e233894f", "name": "OK", "originalRequest": { "url": { @@ -118,7 +118,7 @@ { "listen": "test", "script": { - "id": "a326b210-561b-4e5b-904b-f060f4032677", + "id": "bf2227d5-5696-43f0-9ef4-256b9d47834e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/manifest - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -134,7 +134,7 @@ } }, { - "id": "10d47943-894c-4e54-a302-831f0fd4575d", + "id": "5f180bbe-b5a9-40b6-ab6a-a1f010d771c2", "name": "Create payment", "request": { "name": "Create payment", @@ -235,7 +235,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "249892a4-73e9-495e-8d78-1ffd0ba2ceb9", + "id": "bbb877b2-d2ed-420b-9acb-1bc671de5e5d", "name": "Success", "originalRequest": { "url": { @@ -329,7 +329,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "499233a1-e155-40b2-8dee-85c5ee79f672", + "id": "38d20f08-ef26-4a4c-b039-66b541bafdd7", "name": "Success - PIX", "originalRequest": { "url": { @@ -423,7 +423,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8323a971-b4e7-4fe8-aaee-1fe7cdcf9529", + "id": "afe6ebdd-d6d4-41c4-8060-1935b7ec45d3", "name": "Success - Credit Card", "originalRequest": { "url": { @@ -517,7 +517,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "facd9929-ddc4-44da-8a2a-4187ec6ea79b", + "id": "1ea3059b-749b-4a6c-b461-122a8c225ab6", "name": "Success - Bank invoice", "originalRequest": { "url": { @@ -611,7 +611,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6cb632b1-1f68-4a6c-a42b-dced52354c64", + "id": "488c69cb-9056-4f57-ac12-1ee70e1fca22", "name": "Success - Payment App", "originalRequest": { "url": { @@ -705,7 +705,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c133e0b9-841a-4fb0-b29a-621d02d15f6e", + "id": "002fffdb-88fb-409b-8423-7bf2b591f2e9", "name": "Success - Redirect", "originalRequest": { "url": { @@ -799,7 +799,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ebc5aa9c-66bc-4be4-9593-0f0f3f2a106d", + "id": "eb1bc5e7-e759-4bca-a72b-30c40fe83079", "name": "Success - Callback", "originalRequest": { "url": { @@ -893,7 +893,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0a96eb7d-9489-4e63-a1a0-972a9543e33a", + "id": "a4285272-86a8-4ac9-be00-23072f2c4ab3", "name": "Redirect Success Undefined", "originalRequest": { "url": { @@ -987,7 +987,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e8c2e966-2c15-4ab0-be2a-e8043f47a444", + "id": "b97cfcaf-faf5-4847-988e-eb63114dce8d", "name": "Redirect Success Approved", "originalRequest": { "url": { @@ -1081,7 +1081,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2e339be3-d2e1-43b0-abd1-29a644493a1c", + "id": "9bf42827-6e2d-4b8a-8376-c6826d6f00e5", "name": "Fail Generic Error", "originalRequest": { "url": { @@ -1175,7 +1175,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "47eac0d5-710c-4774-a383-59439ab68be1", + "id": "c6ca98b5-abde-4a4f-b7fd-43abf70ab599", "name": "Fail Bad Request", "originalRequest": { "url": { @@ -1269,7 +1269,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c99ba60e-64b7-4056-8a65-c61a1cbe365e", + "id": "3767ec00-3839-4c86-bedf-37baaee72571", "name": "Credit Card Success Approved", "originalRequest": { "url": { @@ -1363,7 +1363,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "647ae114-cf92-4ef5-b3c0-f8b53b7d2f8a", + "id": "715ef7ab-37a3-42b6-a917-585760833fa7", "name": "Pix Success Approved", "originalRequest": { "url": { @@ -1457,7 +1457,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c633287a-5a9b-481d-a12b-3dc1e8610667", + "id": "386d9581-ba18-4429-ae7f-53bec64bee64", "name": "Success Undefined", "originalRequest": { "url": { @@ -1551,7 +1551,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6cd0f2b6-efe1-4386-8c3a-fb0b6eaf0b33", + "id": "20cd6ad8-273b-4921-978e-60902bb19463", "name": "BankInvoice Success Undefined", "originalRequest": { "url": { @@ -1645,7 +1645,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7fa9f9c8-00f1-4870-b2a7-8daaf7b4e0e5", + "id": "44ceafe5-ddf6-4581-a0a1-e454f6d2a543", "name": "Success Denied", "originalRequest": { "url": { @@ -1739,7 +1739,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d8d7e08f-4616-4f3e-a7b4-b885aac3e484", + "id": "25e02e6f-0760-4032-9d46-81015e258e05", "name": "BankInvoice Success Approved", "originalRequest": { "url": { @@ -1833,7 +1833,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "acc9d2e6-72d1-49ba-87fb-749e539df38f", + "id": "f647b520-129d-40f7-a347-139293a539bb", "name": "Payment App + Inbound Request Success Undefined", "originalRequest": { "url": { @@ -1927,7 +1927,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7c04de29-e4b1-43bb-b305-6c8955f16da8", + "id": "32a41b0c-b5b6-461b-a588-854e7a22cb59", "name": "Redirect Success Undefined", "originalRequest": { "url": { @@ -2021,7 +2021,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "03d3bb9d-0722-4aee-b66e-9544d8ead777", + "id": "6f255aaa-9bb6-42e4-adec-817e61c3a0e3", "name": "Redirect Success Approved", "originalRequest": { "url": { @@ -2115,7 +2115,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "10ed5d26-448c-4489-9017-064ab9844216", + "id": "470edf6b-505c-48f5-bafb-47dcde4b74c8", "name": "Fail Generic Error", "originalRequest": { "url": { @@ -2209,7 +2209,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "77a36466-2bfe-4ec6-a6e0-7c9edfc8e9e4", + "id": "a4aed752-7af2-48b3-8a1c-7f368737ad54", "name": "Fail Bad Request", "originalRequest": { "url": { @@ -2303,7 +2303,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5f8e404d-6048-4640-a418-4361558fbe2d", + "id": "e49fec1a-c256-47f1-8231-a0a019aaf4e6", "name": "Credit Card Success Approved", "originalRequest": { "url": { @@ -2397,7 +2397,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "15b64815-60ce-4c42-9843-8cd4b5a38e27", + "id": "939bb91a-92aa-476a-9917-3ddcfed77139", "name": "Pix Success Approved", "originalRequest": { "url": { @@ -2491,7 +2491,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "efc1884f-5560-4ab3-b2bd-1e8b24ac529b", + "id": "42140477-1460-4489-ac39-57c86a63e684", "name": "Success Undefined", "originalRequest": { "url": { @@ -2585,7 +2585,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f463e0f7-e754-43bb-8f15-ef24e22ab381", + "id": "7e2c7c33-aa3b-43df-8ba4-5186609ac5f8", "name": "BankInvoice Success Undefined", "originalRequest": { "url": { @@ -2679,7 +2679,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8c42edcc-8898-4c24-b67e-4f2e1f96be8a", + "id": "644e6014-1aef-4f1e-9aff-ecb14b757014", "name": "Success Denied", "originalRequest": { "url": { @@ -2773,7 +2773,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "91bba79e-d8fc-4d31-bf6f-8241845d0aef", + "id": "fe79cd03-6b7d-4ecc-a45c-6c91e29ab3bc", "name": "BankInvoice Success Approved", "originalRequest": { "url": { @@ -2867,7 +2867,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3215ac2a-c155-483b-9062-d509e2ce4458", + "id": "b111e045-7b11-4a36-b9fc-8c3f01b95078", "name": "Payment App + Inbound Request Success Undefined", "originalRequest": { "url": { @@ -2961,7 +2961,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c04dcce3-a022-47a0-bbcd-58a3f4a37f83", + "id": "9a79c61e-5b30-425b-beda-41dd44c289ea", "name": "Redirect Success Undefined", "originalRequest": { "url": { @@ -3055,7 +3055,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ff3ee7c7-8129-45c1-b681-f6c5c174bba7", + "id": "e60c3743-25c1-4d8b-b7b4-9f2b968f7976", "name": "Redirect Success Approved", "originalRequest": { "url": { @@ -3149,7 +3149,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a80d6b0f-d4f4-4ce9-8157-6c0ce7bc31e7", + "id": "1570163a-cf2f-47ce-b949-92f896234aba", "name": "Fail Generic Error", "originalRequest": { "url": { @@ -3243,7 +3243,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "96d076db-e111-4f0b-b3d8-79eb100a6205", + "id": "5d3dee2c-0b59-43ea-b1e6-6dd4536126a9", "name": "Fail Bad Request", "originalRequest": { "url": { @@ -3338,7 +3338,7 @@ { "listen": "test", "script": { - "id": "473c8c4d-df29-4110-8c61-2eada75aa248", + "id": "2a2dec23-4c14-4352-94bf-bf5077e555e7", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/payments - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3354,7 +3354,7 @@ } }, { - "id": "31e41994-1df8-4e6e-a2d1-f3d101cd9e49", + "id": "3dbc407d-7b5c-4f2f-bb6f-6450cd4ba76d", "name": "Cancel payment", "request": { "name": "Cancel payment", @@ -3468,7 +3468,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "20cd6ff2-4b2a-446a-8529-5fbb304d2e1f", + "id": "a82d7112-e9ec-405e-86b9-95ba815573e2", "name": "OK", "originalRequest": { "url": { @@ -3564,7 +3564,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e5bf9a83-c69d-4377-b1d6-5f6ea676bf88", + "id": "a89eea59-e9dc-417c-bf6f-ae28a4f99cd7", "name": "Internal Server Error", "originalRequest": { "url": { @@ -3660,7 +3660,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "449616a8-4e96-45a5-8fff-68faeaa6186f", + "id": "cfe7590b-7ca4-4510-a725-e9c37d7ca83c", "name": "Not Implemented", "originalRequest": { "url": { @@ -3757,7 +3757,7 @@ { "listen": "test", "script": { - "id": "ef61103f-56b5-452f-adae-340ea6b2d46a", + "id": "7205c11e-37c3-42e7-8cff-e856c789339b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/payments/:paymentId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3773,7 +3773,7 @@ } }, { - "id": "5378ff2e-fc5b-4e8b-84d8-3bef1ddbe82e", + "id": "12371b9a-609d-483a-b8c9-0c57e6e5ced1", "name": "Settle payment", "request": { "name": "Settle payment", @@ -3887,7 +3887,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5875c05b-4fe7-4bad-a2a4-0382018b6bfe", + "id": "79ba53da-99fd-4793-aee0-0a48327d9760", "name": "OK", "originalRequest": { "url": { @@ -3983,7 +3983,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6a9f8549-fffe-463b-bdfe-9028c130bf65", + "id": "c208cddc-c5fe-40fa-9aed-f125c8df8b42", "name": "Internal Server Error", "originalRequest": { "url": { @@ -4080,7 +4080,7 @@ { "listen": "test", "script": { - "id": "91c1cd5c-8b37-427b-8d70-251946cbb4c3", + "id": "21151e7a-d81d-491b-a5ca-315317a04c74", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/payments/:paymentId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4096,7 +4096,7 @@ } }, { - "id": "aca0502c-9c66-4ff6-bf74-d36e339a8a38", + "id": "9efed36d-88fd-45d2-bb8c-70676813172f", "name": "Refund payment", "request": { "name": "Refund payment", @@ -4210,7 +4210,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "12c081b1-de80-443a-bf91-f48b7e8af601", + "id": "f7604274-fdc7-4de8-8c3d-cf048552cded", "name": "OK", "originalRequest": { "url": { @@ -4306,7 +4306,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "022cedf0-c288-4406-85e6-005ef6413f36", + "id": "f20b7eca-a448-40b4-bd7e-2235e24f7e1e", "name": "Internal Server Error", "originalRequest": { "url": { @@ -4402,7 +4402,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "12a8f892-d762-4003-a784-dcdbd9c13180", + "id": "7b767424-b852-4301-a22d-1deabd333a42", "name": "Not Implemented", "originalRequest": { "url": { @@ -4499,7 +4499,7 @@ { "listen": "test", "script": { - "id": "54a46e33-036a-4b8e-b69b-5bd5d5f6ac80", + "id": "53245d52-fdee-4f1b-b76c-4ca5ec1af67c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/payments/:paymentId/refunds - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4515,7 +4515,7 @@ } }, { - "id": "255f5dd5-24fe-4377-82cd-48fa539a7500", + "id": "80abd909-397b-44b9-a424-23e1be64365c", "name": "Inbound request (BETA)", "request": { "name": "Inbound request (BETA)", @@ -4640,7 +4640,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3b10e89d-cf9a-404d-9db5-da15b08536a4", + "id": "f9275752-00ae-494d-832e-93785c25fffe", "name": "OK", "originalRequest": { "url": { @@ -4738,7 +4738,7 @@ { "listen": "test", "script": { - "id": "5d31efa3-a786-44a8-b587-81d7ed435e20", + "id": "056cd42c-fecc-4ffb-bab1-c9e623200cc3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/payments/:paymentId/inbound/:action - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4757,7 +4757,7 @@ "event": [] }, { - "id": "8034e155-12a7-4b43-9dd7-8311b2e1feba", + "id": "a54a445b-afcd-458c-bf73-faf7b0d8866c", "name": "Configuration Flow", "description": { "content": "", @@ -4765,7 +4765,7 @@ }, "item": [ { - "id": "7bd3caa9-27ae-486d-9975-1fcaa701a3b9", + "id": "ca330463-6d9f-43eb-a87a-2f6d92874e22", "name": "Create authorization token", "request": { "name": "Create authorization token", @@ -4867,7 +4867,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "95dd9c8f-4bdf-4a3c-a342-e4412fa3919f", + "id": "04763a83-ce6e-4fcf-b14e-1b67a4e42255", "name": "OK", "originalRequest": { "url": { @@ -4963,7 +4963,7 @@ { "listen": "test", "script": { - "id": "0f7d3f63-e0d2-459c-8f5c-0ef68e74e5f8", + "id": "f55aaedf-2550-478c-9cb9-7e5b50e6783f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/authorization/token - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4979,7 +4979,7 @@ } }, { - "id": "88384ada-e62e-4714-b94e-d2c83ef3bc1c", + "id": "090b62a4-c204-486a-ad10-9291422e548a", "name": "Provider authentication", "request": { "name": "Provider authentication", @@ -5083,7 +5083,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7e3a3215-de1f-4d7b-8959-cf83a7143b2f", + "id": "aa3b035e-e652-49c1-bfc3-e3f0a0981a92", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -5175,7 +5175,7 @@ { "listen": "test", "script": { - "id": "68c515e3-a6a5-42b4-bf40-d4a00bf9d910", + "id": "50eb5533-45ff-4754-897c-eca2829a43c4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/authorization/redirect - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5188,7 +5188,7 @@ } }, { - "id": "32f583b6-c676-44ff-a570-13a6a9637168", + "id": "ee0d04be-34ed-494b-961d-524aee92c438", "name": "Get credentials", "request": { "name": "Get credentials", @@ -5296,7 +5296,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "479676d3-f20a-4205-9f12-499a3da8d9e1", + "id": "96c8defd-e555-46ed-806e-7479754b4105", "name": "OK", "originalRequest": { "url": { @@ -5398,7 +5398,7 @@ { "listen": "test", "script": { - "id": "045eddb3-0597-4efe-ab14-3c892f56793f", + "id": "c6517c82-8b6a-4ba6-baee-1e5e0abb2b40", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/authorization/credentials - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5431,7 +5431,7 @@ } ], "info": { - "_postman_id": "ea0c0b2a-83d2-4ce0-ae41-d02033689827", + "_postman_id": "887d88da-926b-4f59-a4b1-d0970283c8d1", "name": "Payment Provider Protocol API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 882979b7447ddfd1262a0a236329bfe29a8e86cb Mon Sep 17 00:00:00 2001 From: Pedro Antunes <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Fri, 15 May 2026 22:37:12 -0300 Subject: [PATCH 6/8] feat(spectral): document anyOf/oneOf branches and accept examples plural --- .spectral.yml | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/.spectral.yml b/.spectral.yml index edb4d5a5c..3aac3e824 100644 --- a/.spectral.yml +++ b/.spectral.yml @@ -27,12 +27,17 @@ rules: function: defined must-include-response-examples: - description: At least one example should be included for each API response + description: At least one example must be included for each API response, declared as a sibling of `schema` at the content-type level. Use `example` (singular) for a single payload, or `examples` (plural, an object of named entries with `summary` and `value`) when the schema uses `anyOf`/`oneOf` and each branch needs its own illustrative payload. severity: error given: "$.paths..responses.*.content.*" then: - - field: "example" - function: defined + function: schema + functionOptions: + schema: + type: object + anyOf: + - required: ["example"] + - required: ["examples"] must-include-response-schemas: description: Each API response must contain a schema @@ -156,12 +161,31 @@ rules: match: "^(?:VTEX|SKU|SKUs|ID|API|CMS|EAN|URL|JSON|OAuth|SLA|Session Manager|Storefront Permissions|B2B|[A-Z][a-z0-9]*(?:-[a-z][a-z0-9]*)*)(?:\\s+(?:VTEX|SKU|SKUs|ID|API|CMS|EAN|URL|JSON|OAuth|SLA|Session Manager|Storefront Permissions|B2B|[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*))*$" request-example-parallel-to-schema: - description: The example for request body must be at the same level as the schema (as siblings), not nested inside schema properties. Place the example at the content-type level alongside the schema. + description: The request body must declare an example at the content-type level (as a sibling of `schema`), not nested inside schema properties. Use `example` (singular) for a single payload, or `examples` (plural, an object of named entries with `summary` and `value`) when the schema uses `anyOf`/`oneOf` and each branch needs its own illustrative payload. severity: error given: "$.paths..requestBody.content.*" then: - field: "example" - function: defined + function: schema + functionOptions: + schema: + type: object + anyOf: + - required: ["example"] + - required: ["examples"] + + anyof-oneof-branches-must-be-documented: + description: Each subschema of an `anyOf` or `oneOf` (in a request body or response body) must declare both a `title` and a `description`, per the VTEX API reference guidelines (sections 4.7.1 and 4.8.1). The rendered API reference uses the `title` to label each variant tab and the `description` to explain when that variant applies; without them, consumers see anonymous "Option 1 / Option 2" entries and cannot tell the branches apart. + severity: error + given: + - "$.paths.*.*.requestBody.content.*.schema..anyOf[*]" + - "$.paths.*.*.requestBody.content.*.schema..oneOf[*]" + - "$.paths.*.*.responses.*.content.*.schema..anyOf[*]" + - "$.paths.*.*.responses.*.content.*.schema..oneOf[*]" + then: + - field: "title" + function: defined + - field: "description" + function: defined no-chained-refs-in-components: description: Components cannot use a $ref that points to another component which also contains a $ref (chained refs are not allowed). This may cause rendering errors on the Developer Portal. When this error is shown, check the $ref at the next level and rearrange the content to allow it to be removed, eliminating the need for cascading $refs. From 467ee981ad45c7445f9af8b9497e84bd00678022 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Mon, 18 May 2026 16:20:28 +0000 Subject: [PATCH 7/8] chore: update postman files --- .../VTEX - Payment Policies API.json | 2973 +++++++++++++++++ 1 file changed, 2973 insertions(+) create mode 100644 PostmanCollections/VTEX - Payment Policies API.json diff --git a/PostmanCollections/VTEX - Payment Policies API.json b/PostmanCollections/VTEX - Payment Policies API.json new file mode 100644 index 000000000..5c22c6705 --- /dev/null +++ b/PostmanCollections/VTEX - Payment Policies API.json @@ -0,0 +1,2973 @@ +{ + "_": { + "postman_id": "f87aadb6-0651-43d1-8608-ad36d16e160d" + }, + "item": [ + { + "id": "d93e751d-604b-49a1-972b-11d18fc65919", + "name": "Payment policy rules", + "description": { + "content": "", + "type": "text/plain" + }, + "item": [ + { + "id": "83a29a1a-ce6f-45b8-ba5a-974f691bd557", + "name": "Create policy rule", + "request": { + "name": "Create policy rule", + "description": { + "content": "Creates a payment policy rule for the VTEX account informed in 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": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "9980ff41-3d34-4456-bc0d-5be2001c0ff2", + "name": "Created", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"accountName\": \"cosmetics2\",\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ],\n \"createdAt\": \"2026-04-01T10:00:00Z\",\n \"updatedAt\": \"2026-04-01T10:00:00Z\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "4387af5c-9640-4ced-89b3-cc448eb56d9f", + "name": "Bad Request", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid JSONLogic expression, malformed request body, or policy rule limit exceeded.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "966bafc4-8844-4e6a-8145-cfeab2a989ad", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "306f3f04-5e53-4d0f-a4d9-afb2062a6328", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "e9da6194-82c8-4102-95ae-83e33e244877", + "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", + "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Payment policy rule returned by the API.\",\"required\":[\"id\",\"accountName\",\"name\",\"expression\",\"enabled\",\"priority\",\"action\",\"paymentSystems\",\"createdAt\",\"updatedAt\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"Unique identifier of the policy rule.\"},\"accountName\":{\"type\":\"string\",\"description\":\"VTEX account that owns the policy rule.\"},\"name\":{\"type\":\"string\",\"description\":\"Policy rule name.\"},\"expression\":{\"type\":\"object\",\"description\":\"JSONLogic expression evaluated against item context. Currently supports `and`, `or`, `==`, and `in`, with `collectionIds` and `shippingState` as available variables.\",\"additionalProperties\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the policy rule is active.\"},\"priority\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Rule priority. Lower values have higher precedence when conflicting rules match the same item.\"},\"action\":{\"type\":\"string\",\"description\":\"Action applied to the payment systems when the rule expression matches.\",\"enum\":[\"Include\",\"Exclude\"]},\"paymentSystems\":{\"type\":\"array\",\"description\":\"Payment system IDs affected by the rule.\",\"items\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"}},\"createdAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was created in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"updatedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was last updated in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/payment-configuration-service/policy-rules - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "100167bd-2033-4e00-98d8-50fb41d8dd7d", + "name": "List policy rules", + "request": { + "name": "List policy rules", + "description": { + "content": "Lists the payment policy rules configured for the VTEX account informed in 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 | **ViewPayments** |\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": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "fd18cb14-9adc-4009-b9cb-28f965dd3c90", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"accountName\": \"cosmetics2\",\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ],\n \"createdAt\": \"2026-04-01T10:00:00Z\",\n \"updatedAt\": \"2026-04-01T10:00:00Z\"\n }\n]", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "dfd8a52b-7e17-44ec-b729-9dd6117953e5", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "f93cf973-455d-49a0-a8c7-3bb2c9cab593", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "55fcbf18-8d49-4fda-b65f-c0cf3297c5a2", + "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", + "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of policy rules configured for the account.\",\"items\":{\"type\":\"object\",\"description\":\"Payment policy rule returned by the API.\",\"required\":[\"id\",\"accountName\",\"name\",\"expression\",\"enabled\",\"priority\",\"action\",\"paymentSystems\",\"createdAt\",\"updatedAt\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"Unique identifier of the policy rule.\"},\"accountName\":{\"type\":\"string\",\"description\":\"VTEX account that owns the policy rule.\"},\"name\":{\"type\":\"string\",\"description\":\"Policy rule name.\"},\"expression\":{\"type\":\"object\",\"description\":\"JSONLogic expression evaluated against item context. Currently supports `and`, `or`, `==`, and `in`, with `collectionIds` and `shippingState` as available variables.\",\"additionalProperties\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the policy rule is active.\"},\"priority\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Rule priority. Lower values have higher precedence when conflicting rules match the same item.\"},\"action\":{\"type\":\"string\",\"description\":\"Action applied to the payment systems when the rule expression matches.\",\"enum\":[\"Include\",\"Exclude\"]},\"paymentSystems\":{\"type\":\"array\",\"description\":\"Payment system IDs affected by the rule.\",\"items\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"}},\"createdAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was created in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"updatedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was last updated in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "06051bd8-4ea3-4ead-bac6-1a6cb253f082", + "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 informed in 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 | **ViewPayments** |\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": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Unique identifier of the policy rule.", + "type": "text/plain" + }, + "type": "any", + "value": "urn:uuid:f42cc30d-fc70-2790-f480-02d5baa0249e", + "key": "id" + } + ] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "cb2ccb23-7ac4-432b-883f-ec37b46f349b", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"accountName\": \"cosmetics2\",\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ],\n \"createdAt\": \"2026-04-01T10:00:00Z\",\n \"updatedAt\": \"2026-04-01T10:00:00Z\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "d4ec8534-9c69-449c-9a9d-3c5484c01999", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "823d2b76-e081-42f8-b8e8-97434a3f8934", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "3ccd7ca3-c3e9-4ac2-a3d2-a2fd089bc42f", + "name": "Not Found", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Policy rule not found for the account.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "9cb49cdb-09e0-4480-9a87-44a5b5affd9d", + "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", + "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Payment policy rule returned by the API.\",\"required\":[\"id\",\"accountName\",\"name\",\"expression\",\"enabled\",\"priority\",\"action\",\"paymentSystems\",\"createdAt\",\"updatedAt\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"Unique identifier of the policy rule.\"},\"accountName\":{\"type\":\"string\",\"description\":\"VTEX account that owns the policy rule.\"},\"name\":{\"type\":\"string\",\"description\":\"Policy rule name.\"},\"expression\":{\"type\":\"object\",\"description\":\"JSONLogic expression evaluated against item context. Currently supports `and`, `or`, `==`, and `in`, with `collectionIds` and `shippingState` as available variables.\",\"additionalProperties\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the policy rule is active.\"},\"priority\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Rule priority. Lower values have higher precedence when conflicting rules match the same item.\"},\"action\":{\"type\":\"string\",\"description\":\"Action applied to the payment systems when the rule expression matches.\",\"enum\":[\"Include\",\"Exclude\"]},\"paymentSystems\":{\"type\":\"array\",\"description\":\"Payment system IDs affected by the rule.\",\"items\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"}},\"createdAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was created in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"updatedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was last updated in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/payment-configuration-service/policy-rules/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5b741a10-9bde-4290-b5e8-f301e96c0670", + "name": "Update policy rule", + "request": { + "name": "Update policy rule", + "description": { + "content": "Replaces a payment policy rule for the VTEX account informed in the `an` query parameter. Send the same response body as the `POST` request, excluding `id`, `accountName`, createdAt`, or `updatedAt`.\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": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Unique identifier of the policy rule.", + "type": "text/plain" + }, + "type": "any", + "value": "urn:uuid:f42cc30d-fc70-2790-f480-02d5baa0249e", + "key": "id" + } + ] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "b264e2d9-25dc-426e-a6e0-8bcfeaedf312", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"accountName\": \"cosmetics2\",\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ],\n \"createdAt\": \"2026-04-01T10:00:00Z\",\n \"updatedAt\": \"2026-04-01T10:00:00Z\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "83ed68a2-62ce-43dd-93df-25997285cd3e", + "name": "Bad Request", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid JSONLogic expression, malformed request body, or policy rule limit exceeded.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "80ebc2b9-c81f-45b4-b246-c9a1899ecf0d", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "24ce24be-9be5-4985-b3ce-f13c61381756", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "55d9db20-161d-4ab8-8a2e-4081f5b14c74", + "name": "Not Found", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": true,\n \"priority\": 90,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Policy rule not found for the account.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "6f5e6f58-779f-444a-bed6-1738dcf21e51", + "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", + "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Payment policy rule returned by the API.\",\"required\":[\"id\",\"accountName\",\"name\",\"expression\",\"enabled\",\"priority\",\"action\",\"paymentSystems\",\"createdAt\",\"updatedAt\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"Unique identifier of the policy rule.\"},\"accountName\":{\"type\":\"string\",\"description\":\"VTEX account that owns the policy rule.\"},\"name\":{\"type\":\"string\",\"description\":\"Policy rule name.\"},\"expression\":{\"type\":\"object\",\"description\":\"JSONLogic expression evaluated against item context. Currently supports `and`, `or`, `==`, and `in`, with `collectionIds` and `shippingState` as available variables.\",\"additionalProperties\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the policy rule is active.\"},\"priority\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Rule priority. Lower values have higher precedence when conflicting rules match the same item.\"},\"action\":{\"type\":\"string\",\"description\":\"Action applied to the payment systems when the rule expression matches.\",\"enum\":[\"Include\",\"Exclude\"]},\"paymentSystems\":{\"type\":\"array\",\"description\":\"Payment system IDs affected by the rule.\",\"items\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"}},\"createdAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was created in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"updatedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was last updated in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/payment-configuration-service/policy-rules/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c1c64832-5141-46b7-a3ac-d34bb0e7ec2c", + "name": "Update policy rule partially", + "request": { + "name": "Update policy rule partially", + "description": { + "content": "Updates one or more fields of a payment policy rule for the VTEX account informed in 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": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Unique identifier of the policy rule.", + "type": "text/plain" + }, + "type": "any", + "value": "urn:uuid:f42cc30d-fc70-2790-f480-02d5baa0249e", + "key": "id" + } + ] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"priority\": 50,\n \"paymentSystems\": [\n 100,\n 200\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "dbf8651a-2b23-4c57-bb4a-14b633bf3b76", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"priority\": 50,\n \"paymentSystems\": [\n 100,\n 200\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"accountName\": \"cosmetics2\",\n \"name\": \"Exclude EBT for collection 139 in NY\",\n \"expression\": {\n \"and\": [\n {\n \"in\": [\n 139,\n {\n \"var\": \"collectionIds\"\n }\n ]\n },\n {\n \"==\": [\n {\n \"var\": \"shippingState\"\n },\n \"NY\"\n ]\n }\n ]\n },\n \"enabled\": false,\n \"priority\": 50,\n \"action\": \"Exclude\",\n \"paymentSystems\": [\n 100,\n 200\n ],\n \"createdAt\": \"2026-04-01T10:00:00Z\",\n \"updatedAt\": \"2026-04-01T11:00:00Z\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "d943b4d5-c51f-475b-bad0-2503a30cf0d3", + "name": "Bad Request", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"priority\": 50,\n \"paymentSystems\": [\n 100,\n 200\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid JSONLogic expression, malformed request body, or policy rule limit exceeded.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "91f81889-a98f-494c-a4b1-d8dfc36870ba", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"priority\": 50,\n \"paymentSystems\": [\n 100,\n 200\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "657ce510-2060-4205-b02e-56dd6e07b342", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"priority\": 50,\n \"paymentSystems\": [\n 100,\n 200\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "6adc9166-8278-4ce2-aa49-65ad12a55bc8", + "name": "Not Found", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"priority\": 50,\n \"paymentSystems\": [\n 100,\n 200\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Policy rule not found for the account.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "9f554bcf-1d69-49a1-8493-8069a4a9f170", + "type": "text/javascript", + "exec": [ + "// Validate status 2xx \npm.test(\"[PATCH]::/api/payment-configuration-service/policy-rules/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", + "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/payment-configuration-service/policy-rules/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/payment-configuration-service/policy-rules/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Payment policy rule returned by the API.\",\"required\":[\"id\",\"accountName\",\"name\",\"expression\",\"enabled\",\"priority\",\"action\",\"paymentSystems\",\"createdAt\",\"updatedAt\"],\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"Unique identifier of the policy rule.\"},\"accountName\":{\"type\":\"string\",\"description\":\"VTEX account that owns the policy rule.\"},\"name\":{\"type\":\"string\",\"description\":\"Policy rule name.\"},\"expression\":{\"type\":\"object\",\"description\":\"JSONLogic expression evaluated against item context. Currently supports `and`, `or`, `==`, and `in`, with `collectionIds` and `shippingState` as available variables.\",\"additionalProperties\":true},\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether the policy rule is active.\"},\"priority\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Rule priority. Lower values have higher precedence when conflicting rules match the same item.\"},\"action\":{\"type\":\"string\",\"description\":\"Action applied to the payment systems when the rule expression matches.\",\"enum\":[\"Include\",\"Exclude\"]},\"paymentSystems\":{\"type\":\"array\",\"description\":\"Payment system IDs affected by the rule.\",\"items\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"}},\"createdAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was created in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"},\"updatedAt\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the policy rule was last updated in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/payment-configuration-service/policy-rules/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4fa1f5b0-ad82-4b3a-bfe5-507720916330", + "name": "Delete policy rule", + "request": { + "name": "Delete policy rule", + "description": { + "content": "Deletes a payment policy rule for the VTEX account informed in 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": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Unique identifier of the policy rule.", + "type": "text/plain" + }, + "type": "any", + "value": "urn:uuid:f42cc30d-fc70-2790-f480-02d5baa0249e", + "key": "id" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "_": { + "postman_previewlanguage": "text" + }, + "id": "28591d64-6731-4d27-bcea-71cb19b09dbb", + "name": "No Content", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "73fbc49f-1693-46b6-a9ba-7548c9f0da1c", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "cedae0bc-2d95-4c75-9d51-f95dce55d831", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "f4d1231e-a062-4a71-a827-3226567fe726", + "name": "Not Found", + "originalRequest": { + "url": { + "path": [ + "api", + "payment-configuration-service", + "policy-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Policy rule not found for the account.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "83c076e2-17fd-48ab-a2ac-9f528f98120e", + "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", + "// Validate if response has empty Body \npm.test(\"[DELETE]::/api/payment-configuration-service/policy-rules/:id - Response has empty Body\", function () {\n pm.response.to.not.be.withBody;\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "440feb01-fa06-4360-a0d8-5d432bcf0f36", + "name": "Payment policy evaluation", + "description": { + "content": "", + "type": "text/plain" + }, + "item": [ + { + "id": "ae588a57-33c9-4567-a125-62ed7918fe0b", + "name": "Evaluate payment policies", + "request": { + "name": "Evaluate payment policies", + "description": { + "content": "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.\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 | **ViewPayments** |\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": { + "path": [ + "api", + "pvt", + "payment-systems", + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": \"sku-01\",\n \"collectionIds\": [\n 139,\n 45\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n },\n {\n \"id\": \"sku-02\",\n \"collectionIds\": [\n 200\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "04887e31-7894-45f1-8b7b-c9a72016bc44", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "pvt", + "payment-systems", + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": \"sku-01\",\n \"collectionIds\": [\n 139,\n 45\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n },\n {\n \"id\": \"sku-02\",\n \"collectionIds\": [\n 200\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"paymentSystemAssignments\": [\n {\n \"paymentSystem\": 1,\n \"itemIds\": [\n \"sku-01\",\n \"sku-02\"\n ]\n },\n {\n \"paymentSystem\": 4,\n \"itemIds\": [\n \"sku-01\",\n \"sku-02\"\n ]\n },\n {\n \"paymentSystem\": 100,\n \"itemIds\": [\n \"sku-02\"\n ]\n }\n ],\n \"paymentSystemDefinitions\": [\n {\n \"id\": 1,\n \"name\": \"Debit Card\",\n \"groupName\": \"debitCard\"\n },\n {\n \"id\": 4,\n \"name\": \"Mastercard\",\n \"groupName\": \"creditCard\"\n },\n {\n \"id\": 100,\n \"name\": \"EBT Card\",\n \"groupName\": \"ebt\"\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "a0d5ae63-0165-48a6-8c0b-e562a14d63f9", + "name": "Bad Request", + "originalRequest": { + "url": { + "path": [ + "api", + "pvt", + "payment-systems", + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": \"sku-01\",\n \"collectionIds\": [\n 139,\n 45\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n },\n {\n \"id\": \"sku-02\",\n \"collectionIds\": [\n 200\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid JSONLogic expression, malformed request body, or policy rule limit exceeded.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "be9db25d-c998-4081-9960-7b4c369254e7", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "api", + "pvt", + "payment-systems", + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": \"sku-01\",\n \"collectionIds\": [\n 139,\n 45\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n },\n {\n \"id\": \"sku-02\",\n \"collectionIds\": [\n 200\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Missing or invalid credentials.\"\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "d05c58f3-0076-4fe2-ad87-e81417f80d77", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "api", + "pvt", + "payment-systems", + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", + "type": "text/plain" + }, + "key": "an", + "value": "cosmetics2" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"items\": [\n {\n \"id\": \"sku-01\",\n \"collectionIds\": [\n 139,\n 45\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n },\n {\n \"id\": \"sku-02\",\n \"collectionIds\": [\n 200\n ],\n \"shippingData\": {\n \"state\": \"NY\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The user or API key does not have the required permission.\"\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "64a78111-922e-48af-be81-3b654c42cab0", + "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", + "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/pvt/payment-systems/search - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[POST]::/api/pvt/payment-systems/search - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Payment policy evaluation result returned by the Payment Information Service.\",\"required\":[\"paymentSystemAssignments\",\"paymentSystemDefinitions\"],\"properties\":{\"paymentSystemAssignments\":{\"type\":\"array\",\"description\":\"Relationship between payment systems and the item IDs for which each payment system is available.\",\"items\":{\"type\":\"object\",\"description\":\"Payment system availability for one or more items.\",\"required\":[\"paymentSystem\",\"itemIds\"],\"properties\":{\"paymentSystem\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"},\"itemIds\":{\"type\":\"array\",\"description\":\"Item IDs for which the payment system is available.\",\"items\":{\"type\":\"string\",\"description\":\"Item ID.\"}}}}},\"paymentSystemDefinitions\":{\"type\":\"array\",\"description\":\"Payment system metadata for the payment systems returned in the assignments.\",\"items\":{\"type\":\"object\",\"description\":\"Payment system metadata.\",\"required\":[\"id\",\"name\",\"groupName\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment system ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment system display name.\"},\"groupName\":{\"type\":\"string\",\"description\":\"Payment system group name.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/pvt/payment-systems/search - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "auth": { + "type": "apikey", + "apikey": [ + { + "type": "any", + "value": "X-VTEX-API-AppKey", + "key": "key" + }, + { + "type": "any", + "value": "{{apiKey}}", + "key": "value" + }, + { + "type": "any", + "value": "header", + "key": "in" + } + ] + }, + "event": [], + "variable": [ + { + "type": "any", + "value": "vtexcommercestable", + "key": "environment" + }, + { + "type": "any", + "value": "https://pcs.{{environment}}.com.br", + "key": "baseUrl" + } + ], + "info": { + "_postman_id": "f87aadb6-0651-43d1-8608-ad36d16e160d", + "name": "Payment Policies API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "The Payment Policies API allows VTEX merchants to configure rules that include or exclude payment systems for specific cart items. The Payment Configuration Service (PCS) stores policy rules, while the Payment Information Service (PIS) evaluates those rules during checkout and returns the payment systems available for each item.\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## Index\r\n\r\n### Payment policy rules\r\n\r\n- `POST` [Create policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/payment-configuration-service/policy-rules)\r\n- `GET` [List policy rules](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules)\r\n- `GET` [Get policy rule by ID](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PUT` [Update policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#put-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PATCH` [Update policy rule partially](https://developers.vtex.com/docs/api-reference/payment-policies-api#patch-/api/payment-configuration-service/policy-rules/-id-)\r\n- `DELETE` [Delete policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#delete-/api/payment-configuration-service/policy-rules/-id-)\r\n\r\n### Payment policy evaluation\r\n\r\n- `POST` [Evaluate payment policies](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/pvt/payment-systems/search)\r\n\r\n## Rule engine\r\n\r\n> ℹ️ Currently the Payment policies feature supports `and`, `or`, `==`, and `in` operators, with a limit of 500 operators per expression. Available context variables are `collectionIds`, containing the collection IDs associated with the item, and `shippingState`, containing the delivery state code.", + "type": "text/plain" + } + } +} \ No newline at end of file From ed57245faeabbc5351666be92eb6e8e8c1929e66 Mon Sep 17 00:00:00 2001 From: Ricardo Correia Date: Thu, 21 May 2026 08:48:57 -0300 Subject: [PATCH 8/8] Fix comments --- VTEX - Payment Policies API.json | 358 ++++++++++++------------------- 1 file changed, 134 insertions(+), 224 deletions(-) diff --git a/VTEX - Payment Policies API.json b/VTEX - Payment Policies API.json index f1d03e17c..79510e1d8 100644 --- a/VTEX - Payment Policies API.json +++ b/VTEX - Payment Policies API.json @@ -2,21 +2,18 @@ "openapi": "3.0.0", "info": { "title": "Payment Policies API", - "description": "The Payment Policies API allows VTEX merchants to configure rules that include or exclude payment systems for specific cart items. The Payment Configuration Service (PCS) stores policy rules, while the Payment Information Service (PIS) evaluates those rules during checkout and returns the payment systems available for each item.\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## Index\r\n\r\n### Payment policy rules\r\n\r\n- `POST` [Create policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/payment-configuration-service/policy-rules)\r\n- `GET` [List policy rules](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules)\r\n- `GET` [Get policy rule by ID](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PUT` [Update policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#put-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PATCH` [Update policy rule partially](https://developers.vtex.com/docs/api-reference/payment-policies-api#patch-/api/payment-configuration-service/policy-rules/-id-)\r\n- `DELETE` [Delete policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#delete-/api/payment-configuration-service/policy-rules/-id-)\r\n\r\n### Payment policy evaluation\r\n\r\n- `POST` [Evaluate payment policies](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/pvt/payment-systems/search)\r\n\r\n## Rule engine\r\n\r\n> ℹ️ Currently the Payment policies feature supports `and`, `or`, `==`, and `in` operators, with a limit of 500 operators per expression. Available context variables are `collectionIds`, containing the collection IDs associated with the item, and `shippingState`, containing the delivery state code.", + "description": "The Payment Policies API allows VTEX merchants to configure rules that include or exclude payment systems for specific cart items. The Payment Configuration Service (PCS) stores policy rules, while the Payment Information Service (PIS) evaluates those rules during checkout and returns the payment systems available for each item.\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## Index\r\n\r\n### Payment policy rules\r\n\r\n- `POST` [Create policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/payment-configuration-service/policy-rules)\r\n- `GET` [List policy rules](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules)\r\n- `GET` [Get policy rule by ID](https://developers.vtex.com/docs/api-reference/payment-policies-api#get-/api/payment-configuration-service/policy-rules/-id-)\r\n- `PUT` [Update policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#put-/api/payment-configuration-service/policy-rules/-id-)\r\n- `DELETE` [Delete policy rule](https://developers.vtex.com/docs/api-reference/payment-policies-api#delete-/api/payment-configuration-service/policy-rules/-id-)\r\n\r\n### Payment policy evaluation\r\n\r\n- `POST` [Evaluate payment policies](https://developers.vtex.com/docs/api-reference/payment-policies-api#post-/api/pvt/payment-systems/search)\r\n\r\n## Rule engine\r\n\r\n> ℹ️ Currently the Payment policies feature supports `and`, `or`, `==`, and `in` operators, with a limit of 500 operators per expression. Available context variables are `collectionIds`, containing the collection IDs associated with the item, and `shippingState`, containing the delivery state code.", "contact": {}, "version": "1.0" }, "servers": [ { - "url": "https://pcs.{environment}.com.br", + "url": "https://{accountName}.pcs.vtexcommercestable.com.br", "description": "Payment Configuration Service server URL.", "variables": { - "environment": { - "description": "Environment to use. Used as part of the URL.", - "enum": [ - "vtexcommercestable" - ], - "default": "vtexcommercestable" + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" } } }, @@ -35,15 +32,12 @@ "/api/payment-configuration-service/policy-rules": { "servers": [ { - "url": "https://pcs.{environment}.com.br", + "url": "https://{accountName}.pcs.vtexcommercestable.com.br", "description": "Payment Configuration Service server URL.", "variables": { - "environment": { - "description": "Environment to use. Used as part of the URL.", - "enum": [ - "vtexcommercestable" - ], - "default": "vtexcommercestable" + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" } } } @@ -54,11 +48,8 @@ ], "summary": "Create policy rule", "operationId": "createPolicyRule", - "description": "Creates a payment policy rule for the VTEX account informed in 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.", + "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": [ - { - "$ref": "#/components/parameters/AccountName" - }, { "$ref": "#/components/parameters/Content-Type" }, @@ -115,7 +106,6 @@ }, "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "accountName": "cosmetics2", "name": "Exclude EBT for collection 139 in NY", "expression": { "and": [ @@ -157,6 +147,9 @@ }, "403": { "$ref": "#/components/responses/Forbidden" + }, + "422": { + "$ref": "#/components/responses/UnprocessableContent" } } }, @@ -166,11 +159,8 @@ ], "summary": "List policy rules", "operationId": "listPolicyRules", - "description": "Lists the payment policy rules configured for the VTEX account informed in 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 | **ViewPayments** |\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 `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": [ - { - "$ref": "#/components/parameters/AccountName" - }, { "$ref": "#/components/parameters/Accept" } @@ -190,7 +180,6 @@ "example": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "accountName": "cosmetics2", "name": "Exclude EBT for collection 139 in NY", "expression": { "and": [ @@ -237,15 +226,12 @@ "/api/payment-configuration-service/policy-rules/{id}": { "servers": [ { - "url": "https://pcs.{environment}.com.br", + "url": "https://{accountName}.pcs.vtexcommercestable.com.br", "description": "Payment Configuration Service server URL.", "variables": { - "environment": { - "description": "Environment to use. Used as part of the URL.", - "enum": [ - "vtexcommercestable" - ], - "default": "vtexcommercestable" + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" } } } @@ -256,14 +242,11 @@ ], "summary": "Get policy rule by ID", "operationId": "getPolicyRuleById", - "description": "Retrieves a payment policy rule by ID for the VTEX account informed in 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 | **ViewPayments** |\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 `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": [ { "$ref": "#/components/parameters/PolicyRuleId" }, - { - "$ref": "#/components/parameters/AccountName" - }, { "$ref": "#/components/parameters/Accept" } @@ -278,7 +261,6 @@ }, "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "accountName": "cosmetics2", "name": "Exclude EBT for collection 139 in NY", "expression": { "and": [ @@ -329,14 +311,11 @@ ], "summary": "Update policy rule", "operationId": "updatePolicyRule", - "description": "Replaces a payment policy rule for the VTEX account informed in the `an` query parameter. Send the same response body as the `POST` request, excluding `id`, `accountName`, createdAt`, or `updatedAt`.\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 `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": [ { "$ref": "#/components/parameters/PolicyRuleId" }, - { - "$ref": "#/components/parameters/AccountName" - }, { "$ref": "#/components/parameters/Content-Type" }, @@ -393,7 +372,6 @@ }, "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "accountName": "cosmetics2", "name": "Exclude EBT for collection 139 in NY", "expression": { "and": [ @@ -438,103 +416,12 @@ }, "404": { "$ref": "#/components/responses/NotFound" - } - } - }, - "patch": { - "tags": [ - "Payment policy rules" - ], - "summary": "Update policy rule partially", - "operationId": "patchPolicyRule", - "description": "Updates one or more fields of a payment policy rule for the VTEX account informed in 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/PolicyRuleId" - }, - { - "$ref": "#/components/parameters/AccountName" - }, - { - "$ref": "#/components/parameters/Content-Type" - }, - { - "$ref": "#/components/parameters/Accept" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyRulePatch" - }, - "example": { - "priority": 50, - "paymentSystems": [ - 100, - 200 - ] - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyRule" - }, - "example": { - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "accountName": "cosmetics2", - "name": "Exclude EBT for collection 139 in NY", - "expression": { - "and": [ - { - "in": [ - 139, - { - "var": "collectionIds" - } - ] - }, - { - "==": [ - { - "var": "shippingState" - }, - "NY" - ] - } - ] - }, - "enabled": false, - "priority": 50, - "action": "Exclude", - "paymentSystems": [ - 100, - 200 - ], - "createdAt": "2026-04-01T10:00:00Z", - "updatedAt": "2026-04-01T11:00:00Z" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" }, - "401": { - "$ref": "#/components/responses/Unauthorized" + "409": { + "$ref": "#/components/responses/Conflict" }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" + "422": { + "$ref": "#/components/responses/UnprocessableContent" } } }, @@ -544,13 +431,10 @@ ], "summary": "Delete policy rule", "operationId": "deletePolicyRule", - "description": "Deletes a payment policy rule for the VTEX account informed in 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.", + "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": [ { "$ref": "#/components/parameters/PolicyRuleId" - }, - { - "$ref": "#/components/parameters/AccountName" } ], "responses": { @@ -588,11 +472,8 @@ ], "summary": "Evaluate payment policies", "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.\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 | **ViewPayments** |\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": "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| 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/AccountName" - }, { "$ref": "#/components/parameters/Content-Type" }, @@ -743,7 +624,8 @@ "properties": { "name": { "type": "string", - "description": "Policy rule name." + "description": "Policy rule name.", + "minLength": 1 }, "expression": { "$ref": "#/components/schemas/JsonLogicExpression" @@ -755,11 +637,13 @@ "priority": { "type": "integer", "format": "int32", - "description": "Rule priority. Lower values have higher precedence when conflicting rules match the same item." + "description": "Rule priority, from `0` to `999`. Lower values have higher precedence when conflicting rules match the same item.", + "minimum": 0, + "maximum": 999 }, "action": { "type": "string", - "description": "Action applied to the payment systems when the rule expression matches.", + "description": "Action applied to the payment systems when the rule expression matches. Accepts `Include` or `Exclude`; value matching is case-insensitive.", "enum": [ "Include", "Exclude" @@ -772,46 +656,8 @@ "type": "integer", "format": "int32", "description": "Payment system ID." - } - } - } - }, - "PolicyRulePatch": { - "type": "object", - "description": "Payload used to update one or more fields of a payment policy rule.", - "properties": { - "name": { - "type": "string", - "description": "Policy rule name." - }, - "expression": { - "$ref": "#/components/schemas/JsonLogicExpression" - }, - "enabled": { - "type": "boolean", - "description": "Indicates whether the policy rule is active." - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "Rule priority. Lower values have higher precedence when conflicting rules match the same item." - }, - "action": { - "type": "string", - "description": "Action applied to the payment systems when the rule expression matches.", - "enum": [ - "Include", - "Exclude" - ] - }, - "paymentSystems": { - "type": "array", - "description": "Payment system IDs affected by the rule.", - "items": { - "type": "integer", - "format": "int32", - "description": "Payment system ID." - } + }, + "minItems": 1 } } }, @@ -820,7 +666,6 @@ "description": "Payment policy rule returned by the API.", "required": [ "id", - "accountName", "name", "expression", "enabled", @@ -836,13 +681,10 @@ "format": "uuid", "description": "Unique identifier of the policy rule." }, - "accountName": { - "type": "string", - "description": "VTEX account that owns the policy rule." - }, "name": { "type": "string", - "description": "Policy rule name." + "description": "Policy rule name.", + "minLength": 1 }, "expression": { "$ref": "#/components/schemas/JsonLogicExpression" @@ -854,11 +696,13 @@ "priority": { "type": "integer", "format": "int32", - "description": "Rule priority. Lower values have higher precedence when conflicting rules match the same item." + "description": "Rule priority, from `0` to `999`. Lower values have higher precedence when conflicting rules match the same item.", + "minimum": 0, + "maximum": 999 }, "action": { "type": "string", - "description": "Action applied to the payment systems when the rule expression matches.", + "description": "Action applied to the payment systems when the rule expression matches. Accepts `Include` or `Exclude`; value matching is case-insensitive.", "enum": [ "Include", "Exclude" @@ -871,7 +715,8 @@ "type": "integer", "format": "int32", "description": "Payment system ID." - } + }, + "minItems": 1 }, "createdAt": { "type": "string", @@ -1014,13 +859,39 @@ } } }, - "Error": { + "ProblemDetails": { "type": "object", - "description": "Error response returned when the request cannot be completed.", + "description": "RFC 7807 Problem Details response returned when the request cannot be completed.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], "properties": { - "message": { + "type": { + "type": "string", + "description": "URI reference that identifies the problem type." + }, + "title": { + "type": "string", + "description": "Short, human-readable summary of the problem type." + }, + "status": { + "type": "integer", + "format": "int32", + "minimum": 100, + "maximum": 599, + "description": "HTTP status code generated by the server for this occurrence of the problem." + }, + "detail": { + "type": "string", + "description": "Human-readable explanation specific to this occurrence of the problem." + }, + "instance": { "type": "string", - "description": "Error message." + "description": "URI reference that identifies the specific occurrence of the problem." } } } @@ -1048,17 +919,6 @@ "example": "application/json" } }, - "AccountName": { - "name": "an", - "in": "query", - "description": "Name of the VTEX account whose payment policies should be created, retrieved, updated, deleted, or evaluated.", - "required": true, - "style": "form", - "schema": { - "type": "string", - "example": "cosmetics2" - } - }, "PolicyRuleId": { "name": "id", "in": "path", @@ -1074,12 +934,16 @@ "BadRequest": { "description": "Bad Request", "content": { - "application/json": { + "application/problem+json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/ProblemDetails" }, "example": { - "message": "Invalid JSONLogic expression, malformed request body, or policy rule limit exceeded." + "type": "https://httpstatuses.com/400", + "title": "Bad Request", + "status": 400, + "detail": "The request body is malformed.", + "instance": "/api/payment-configuration-service/policy-rules" } } } @@ -1087,12 +951,16 @@ "Unauthorized": { "description": "Unauthorized", "content": { - "application/json": { + "application/problem+json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/ProblemDetails" }, "example": { - "message": "Missing or invalid credentials." + "type": "https://httpstatuses.com/401", + "title": "Unauthorized", + "status": 401, + "detail": "Missing or invalid credentials.", + "instance": "/api/payment-configuration-service/policy-rules" } } } @@ -1100,12 +968,16 @@ "Forbidden": { "description": "Forbidden", "content": { - "application/json": { + "application/problem+json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/ProblemDetails" }, "example": { - "message": "The user or API key does not have the required permission." + "type": "https://httpstatuses.com/403", + "title": "Forbidden", + "status": 403, + "detail": "The user or API key does not have the required permission.", + "instance": "/api/payment-configuration-service/policy-rules" } } } @@ -1113,12 +985,50 @@ "NotFound": { "description": "Not Found", "content": { - "application/json": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "example": { + "type": "https://httpstatuses.com/404", + "title": "Not Found", + "status": 404, + "detail": "Policy rule not found for the account.", + "instance": "/api/payment-configuration-service/policy-rules" + } + } + } + }, + "Conflict": { + "description": "Conflict", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "example": { + "type": "https://httpstatuses.com/409", + "title": "Conflict", + "status": 409, + "detail": "The policy rule was updated by another request. Retry with the latest data.", + "instance": "/api/payment-configuration-service/policy-rules" + } + } + } + }, + "UnprocessableContent": { + "description": "Unprocessable Content", + "content": { + "application/problem+json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/ProblemDetails" }, "example": { - "message": "Policy rule not found for the account." + "type": "https://httpstatuses.com/422", + "title": "Unprocessable Content", + "status": 422, + "detail": "Validation failed, the JSONLogic expression is invalid, or a domain invariant was violated.", + "instance": "/api/payment-configuration-service/policy-rules" } } }