Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update information Enable Risk Pre Analysis #1364

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Update information Enable Risk Pre Analysis #1364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e2eca2
Update information Enable Risk Pre Analysis
ricardoaerobr Nov 28, 2024
f1faf38
Update generated files by portman
Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions PostmanCollections/VTEX - Antifraud Provider API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{
"_": {
"postman_id": "18cfb68d-7778-420d-bb3b-19e47b8d03d9"
"postman_id": "f4808f49-b5b2-4886-ba1b-986d28346cec"
},
"item": [
{
"id": "0069de79-3a2c-410d-9d4d-a52d3d6d60c2",
"id": "aa8d2b55-3209-42b0-9d58-a6482b276ff5",
"name": "Anti-fraud Flow",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "50030a5f-f1a7-46b8-870c-beb77b859dbd",
"id": "9f0ad826-fafa-4e6c-aa9d-14f0f9e73d5c",
"name": "Send anti-fraud pre-analysis data (optional)",
"request": {
"name": "Send anti-fraud pre-analysis data (optional)",
"description": {
"content": "Receives a new transaction anti-fraud data for (synchronous) pre-analysis. This step is performed before payments authorization.\r\n\r\n>⚠️ This endpoint can only be used if your anti-fraud provider already has the pre-analysis function configured within VTEX. To check if it is already configured, in the VTEX Admin, go to **Store Settings > Payments > Settings> Gateway affiliations tab > {your anti-fraud provider option}** and verify if the **Enable risk Pre-Analysis** field is available to be selected. If the **Enable risk Pre-Analysis** field is not available, check with your anti-fraud provider if this feature is available in their integration and open a ticket in our VTEX support to update the connector.\r\n\r\n>⚠️ The pre-analysis does not exclude the need for full analysis after payments authorization.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
"content": "Receives a new transaction anti-fraud data for (synchronous) pre-analysis. This step is performed before payments authorization.\r\n\r\n>⚠️ This endpoint can only be used if your anti-fraud provider already has the pre-analysis function configured within VTEX. To check if it is already configured, in the VTEX Admin, go to **Store Settings > Payment > Providers**, click the name of your anti-fraud provider, and verify if the **Enable Risk Pre-Analysis** field is available to be selected. If the **Enable Risk Pre-Analysis** field is not available, check with your anti-fraud provider if this feature is available in their integration and open a ticket in our [VTEX Support](https://help.vtex.com/en/support) to update the connector.\r\n\r\n>⚠️ The pre-analysis does not exclude the need for full analysis after payments authorization.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
"type": "text/plain"
},
"url": {
Expand Down Expand Up @@ -113,7 +113,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "b50d39f8-0b70-46f9-8008-02f7b5596770",
"id": "4dbd6dd6-729a-4a70-ad4b-eb1b0690a446",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -208,7 +208,7 @@
{
"listen": "test",
"script": {
"id": "bf7e5b3c-0e11-4943-8aee-84e6d82aad6c",
"id": "c16365b1-5c22-43ba-8e85-90388b48a79a",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/pre-analysis - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -224,7 +224,7 @@
}
},
{
"id": "154f9eed-6e03-43d5-a378-f9dfa9395d94",
"id": "2a4345b5-9295-43ed-9c97-e14cc414cb73",
"name": "Send anti-fraud data",
"request": {
"name": "Send anti-fraud data",
Expand Down Expand Up @@ -325,7 +325,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "fb8ba722-f04e-4211-ba6c-0032408cf133",
"id": "e39bd1b9-9cfa-4c1a-92d9-5d0dc8e0c65c",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -420,7 +420,7 @@
{
"listen": "test",
"script": {
"id": "34fea2c7-9608-4d93-a226-89361e5ae2f8",
"id": "ee7371d5-a56c-4fe7-8d88-a5d06a5824b0",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -436,7 +436,7 @@
}
},
{
"id": "a4667d73-cd7e-4702-8e30-aef901059362",
"id": "f587e9fb-afb7-4edf-83d6-df2e76b69371",
"name": "Update anti-fraud transactions (optional)",
"request": {
"name": "Update anti-fraud transactions (optional)",
Expand Down Expand Up @@ -553,7 +553,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "9d04b05d-04fc-4976-8e96-cc07eec3f335",
"id": "0041b2f3-9a40-4635-b4a1-b403edc5ccc3",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -649,7 +649,7 @@
{
"listen": "test",
"script": {
"id": "a075f361-117a-4388-ab39-2c94c9481f20",
"id": "327e7fdd-d942-4618-b9bd-cde77f30321f",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[PUT]::/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -665,7 +665,7 @@
}
},
{
"id": "a83177d0-7b15-4079-9995-f7b957adbe5b",
"id": "32dda435-51ce-43d4-839d-ae2598089956",
"name": "List anti-fraud provider manifest",
"request": {
"name": "List anti-fraud provider manifest",
Expand Down Expand Up @@ -715,7 +715,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "791e0b72-89c1-46e6-bbed-5966f926c5dd",
"id": "09e17a36-cd46-450d-8c23-9c92cb5886f1",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -771,13 +771,13 @@
{
"listen": "test",
"script": {
"id": "a36d0930-29df-46d8-b28f-dbb5728bdcd5",
"id": "6e4cd6dc-9c09-4ea5-bc53-225082644ec4",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/manifest - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
"// Validate if response header has matching content-type\npm.test(\"[GET]::/manifest - 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]::/manifest - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n",
"// Response Validation\nconst schema = {\"required\":[\"customFields\"],\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"cardholderDocument\":{\"type\":\"string\",\"description\":\"Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.\"},\"allowAntifraudOnGiftCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether the anti-fraud provider can process payment transactions made using gift cards.\"},\"customFields\":{\"type\":\"array\",\"description\":\"Describes the customized fields supported by the connector.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"type\":{\"type\":\"string\",\"description\":\"Custom field type. Sensitive or security data should be defined as `password`.\",\"enum\":[\"text\",\"password\",\"select\"]},\"options\":{\"type\":\"array\",\"description\":\"In case of `select` type, the possible params are `text` and `value`.\",\"items\":{\"type\":\"object\",\"description\":\"Custom field information.\",\"properties\":{\"text\":{\"type\":\"string\",\"description\":\"Custom field description.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/manifest - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n"
"// Response Validation\nconst schema = {\"required\":[\"customFields\"],\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"cardholderDocument\":{\"type\":\"string\",\"description\":\"Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.\"},\"allowAntifraudOnGiftCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether the anti-fraud provider can process payment transactions made using [gift cards](https://developers.vtex.com/docs/guides/gift-card-integration-guide).\"},\"customFields\":{\"type\":\"array\",\"description\":\"Describes the customized fields supported by the connector.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"type\":{\"type\":\"string\",\"description\":\"Custom field type. Sensitive or security data should be defined as `password`.\",\"enum\":[\"text\",\"password\",\"select\"]},\"options\":{\"type\":\"array\",\"description\":\"In case of `select` type, the possible params are `text` and `value`.\",\"items\":{\"type\":\"object\",\"description\":\"Custom field information.\",\"properties\":{\"text\":{\"type\":\"string\",\"description\":\"Custom field description.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/manifest - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n"
]
}
}
Expand All @@ -787,7 +787,7 @@
}
},
{
"id": "8ed1d9e3-8253-4881-9782-e45ddd26372e",
"id": "869422f2-326c-45d4-941e-94735f206f9b",
"name": "Get anti-fraud status",
"request": {
"name": "Get anti-fraud status",
Expand Down Expand Up @@ -891,7 +891,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "d25fd4b9-40da-416e-9765-16b690a494e6",
"id": "a64a55c2-7aa4-407c-9509-acc9d6e004a0",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -974,7 +974,7 @@
{
"listen": "test",
"script": {
"id": "fbcd603e-d5bb-4b63-9e23-33e9497cbd98",
"id": "643709bb-c0bb-4ad3-8576-028ab9bb3902",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/transactions/:transactions.id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -990,7 +990,7 @@
}
},
{
"id": "b3e6ed15-1a76-4b73-9762-c8b5810cb110",
"id": "6bb6748c-8b56-4d54-bbed-e8d97bffc6f8",
"name": "Stop anti-fraud analysis (optional)",
"request": {
"name": "Stop anti-fraud analysis (optional)",
Expand Down Expand Up @@ -1094,7 +1094,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "70ffc9c7-7927-4fe3-aad7-d2c886edce14",
"id": "830d16be-7022-4f28-bff7-47eedb367d12",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1177,7 +1177,7 @@
{
"listen": "test",
"script": {
"id": "0b36d805-b8c3-4cde-abac-d2a0dc8edc4c",
"id": "73a4a23f-28f2-4a6d-95ee-8ab70e133b24",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[DELETE]::/transactions/:transactions.Id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1196,15 +1196,15 @@
"event": []
},
{
"id": "4fabcf4b-bef9-46c6-b448-57781a1e8a25",
"id": "99efddac-f453-4d04-9133-6a660c88238d",
"name": "OAuth Flow",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "6e9a5ad7-3faf-41c6-9e37-60dd0f69a1cb",
"id": "857b4c54-6663-457f-9479-ddb24e309ee8",
"name": "1. Retrieve token",
"request": {
"name": "1. Retrieve token",
Expand Down Expand Up @@ -1306,7 +1306,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "63b60b62-c6fa-421f-bd0d-26940f4874be",
"id": "dd33670e-14a1-433a-b09e-023c7bf440a9",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1402,7 +1402,7 @@
{
"listen": "test",
"script": {
"id": "5836a4f3-33cf-4e7c-93e8-e21f00cad9a9",
"id": "ef44594b-7668-4695-86a5-9c00fec0a6cf",
"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",
Expand All @@ -1418,7 +1418,7 @@
}
},
{
"id": "1bec7005-85de-447d-8e4c-84ab66d14104",
"id": "15f6df85-698b-48db-8502-a45ae9b8a3de",
"name": "2. Redirect",
"request": {
"name": "2. Redirect",
Expand Down Expand Up @@ -1521,7 +1521,7 @@
"_": {
"postman_previewlanguage": "text"
},
"id": "dea0ed0b-f7c7-458f-85c3-e1ba02ec0535",
"id": "beb70a60-79b1-464a-a8ee-498b32e0cbd6",
"name": "OK. This endpoint does not return any data in the response body.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1612,7 +1612,7 @@
{
"listen": "test",
"script": {
"id": "d7a1a395-0df6-49d5-9eec-64aeda2c6886",
"id": "4327b04c-c02c-474c-bad4-02c5a4b18e33",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/redirect - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
Expand All @@ -1625,7 +1625,7 @@
}
},
{
"id": "72935870-653f-4bc4-8833-4899f42cf8ae",
"id": "9ec23cdc-8f36-40c6-93ea-979a0a879489",
"name": "3. Return to VTEX",
"request": {
"name": "3. Return to VTEX",
Expand Down Expand Up @@ -1701,7 +1701,7 @@
"_": {
"postman_previewlanguage": "text"
},
"id": "2b3a1ee5-a9a5-408c-8d2d-d712066082f7",
"id": "da0092f5-45c7-4de5-a5cc-ab1978bf017e",
"name": "OK. This endpoint does not return any data in the response body.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1765,7 +1765,7 @@
{
"listen": "test",
"script": {
"id": "5fe24823-182e-45a0-8e0d-e06587eb144c",
"id": "fcd8eecb-3f52-4a1d-99fe-ea1457f07fc8",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/authorizationCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
Expand All @@ -1778,7 +1778,7 @@
}
},
{
"id": "7bb6adee-d43a-4ab2-8c26-7d2cecca52c9",
"id": "fad96a2f-a7f6-489d-bcfa-7ae81ddc1906",
"name": "4. Get credentials",
"request": {
"name": "4. Get credentials",
Expand Down Expand Up @@ -1868,7 +1868,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "5f27fcb3-107a-4239-9222-1836c1da7450",
"id": "5d19c444-da72-4d80-a582-94ba5c5ee8e1",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1952,7 +1952,7 @@
{
"listen": "test",
"script": {
"id": "5e003f42-9c67-49ae-88c9-e43246c99679",
"id": "846e77b2-12ad-4de7-acea-a324e818e3cf",
"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",
Expand Down Expand Up @@ -1985,7 +1985,7 @@
}
],
"info": {
"_postman_id": "18cfb68d-7778-420d-bb3b-19e47b8d03d9",
"_postman_id": "f4808f49-b5b2-4886-ba1b-986d28346cec",
"name": "Anti-fraud Provider API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
Expand Down
2 changes: 1 addition & 1 deletion VTEX - Antifraud Provider API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"Anti-fraud Flow"
],
"summary": "Send anti-fraud pre-analysis data (optional)",
"description": "Receives a new transaction anti-fraud data for (synchronous) pre-analysis. This step is performed before payments authorization.\r\n\r\n>⚠️ This endpoint can only be used if your anti-fraud provider already has the pre-analysis function configured within VTEX. To check if it is already configured, in the VTEX Admin, go to **Store Settings > Payments > Settings> Gateway affiliations tab > {your anti-fraud provider option}** and verify if the **Enable risk Pre-Analysis** field is available to be selected. If the **Enable risk Pre-Analysis** field is not available, check with your anti-fraud provider if this feature is available in their integration and open a ticket in our VTEX support to update the connector.\r\n\r\n>⚠️ The pre-analysis does not exclude the need for full analysis after payments authorization.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
"description": "Receives a new transaction anti-fraud data for (synchronous) pre-analysis. This step is performed before payments authorization.\r\n\r\n>⚠️ This endpoint can only be used if your anti-fraud provider already has the pre-analysis function configured within VTEX. To check if it is already configured, in the VTEX Admin, go to **Store Settings > Payment > Providers**, click the name of your anti-fraud provider, and verify if the **Enable Risk Pre-Analysis** field is available to be selected. If the **Enable Risk Pre-Analysis** field is not available, check with your anti-fraud provider if this feature is available in their integration and open a ticket in our [VTEX Support](https://help.vtex.com/en/support) to update the connector.\r\n\r\n>⚠️ The pre-analysis does not exclude the need for full analysis after payments authorization.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
"operationId": "SendAntifraudPreAnalysisData",
"parameters": [
{
Expand Down