Skip to content

Commit

Permalink
Fix format comment
Browse files Browse the repository at this point in the history
  • Loading branch information
@ricardoaerobr
ricardoaerobr authored Dec 5, 2023
1 parent e85a3cc commit 9affdfb
Showing 1 changed file with 35 additions and 53 deletions.
88 changes: 35 additions & 53 deletions VTEX - Antifraud Provider API.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@
"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).",
"operationId": "SendAntifraudPreAnalysisData",
"parameters": [
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppKey"
},
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppToken"
},
{
"$ref": "#/components/parameters/Content-Type"
},
Expand All @@ -45,6 +39,10 @@
"appKey": [],
"appToken": []
},
{
"X-PROVIDER-API-AppKey": [],
"X-PROVIDER-API-AppToken": []
},
{
"VtexIdclientAutCookie": []
}
Expand Down Expand Up @@ -100,12 +98,6 @@
"description": "Receives a new transaction anti-fraud data. This step is performed only if all payments are authorized.\r\n\r\nVTEX expects that your anti-fraud provider process this request and retrieves the process result. After that, the VTEX order flow will check the response status to cancel or approve the transaction.\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": "SendAntifraudData",
"parameters": [
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppKey"
},
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppToken"
},
{
"$ref": "#/components/parameters/Content-Type"
},
Expand All @@ -118,6 +110,10 @@
"appKey": [],
"appToken": []
},
{
"X-PROVIDER-API-AppKey": [],
"X-PROVIDER-API-AppToken": []
},
{
"VtexIdclientAutCookie": []
}
Expand Down Expand Up @@ -169,12 +165,6 @@
"description": "Receives a new transaction anti-fraud data. This step is performed only if all payments are authorized.\r\n\r\nVTEX expects that your anti-fraud provider process this request and retrieves the process result. After that, the VTEX order flow will check the response status to cancel or approve the transaction.\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": "UpdateAntifraudTransactions(optional)",
"parameters": [
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppKey"
},
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppToken"
},
{
"$ref": "#/components/parameters/Content-Type"
},
Expand All @@ -190,6 +180,10 @@
"appKey": [],
"appToken": []
},
{
"X-PROVIDER-API-AppKey": [],
"X-PROVIDER-API-AppToken": []
},
{
"VtexIdclientAutCookie": []
}
Expand Down Expand Up @@ -401,12 +395,6 @@
"description": "Retrieves the anti-fraud analysis status. This request is performed every two hours up to 5 days. After 5 days in `undefined` status, the order will expire and be cancelled.\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": "GetAntifraudStatus",
"parameters": [
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppKey"
},
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppToken"
},
{
"$ref": "#/components/parameters/Content-Type"
},
Expand All @@ -422,6 +410,10 @@
"appKey": [],
"appToken": []
},
{
"X-PROVIDER-API-AppKey": [],
"X-PROVIDER-API-AppToken": []
},
{
"VtexIdclientAutCookie": []
}
Expand Down Expand Up @@ -461,12 +453,6 @@
"description": "Notifies whether the order has been canceled by the store or the buyer before completing the anti-fraud analysis status.\r\n\r\n This endpoint is not mandatory for the antifraud flow to work. Check this [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works) for more details.\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": "StopAntifraudAnalysis(optional)",
"parameters": [
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppKey"
},
{
"$ref": "#/components/parameters/X-PROVIDER-API-AppToken"
},
{
"$ref": "#/components/parameters/Content-Type"
},
Expand All @@ -482,6 +468,10 @@
"appKey": [],
"appToken": []
},
{
"X-PROVIDER-API-AppKey": [],
"X-PROVIDER-API-AppToken": []
},
{
"VtexIdclientAutCookie": []
}
Expand Down Expand Up @@ -755,7 +745,21 @@
"in": "header",
"name": "VtexIdclientAutCookie",
"description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours."
}
},
"X-PROVIDER-API-AppKey": {
"type": "apiKey",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"description": "The AppKey configured by the merchant."
}
},
"X-PROVIDER-API-AppToken": {
"type": "apiKey",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"description": "The AppToken configured by the merchant."
}
},
},
"parameters": {
"Content-Type": {
Expand Down Expand Up @@ -790,28 +794,6 @@
"type": "string",
"example": "D3AA1FC8372E430E8236649DB5EBD08E"
}
},
"X-PROVIDER-API-AppKey": {
"name": "X-PROVIDER-API-AppKey",
"in": "header",
"description": "The AppKey configured by the merchant.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{X-PROVIDER-API-AppKey}}"
}
},
"X-PROVIDER-API-AppToken": {
"name": "X-PROVIDER-API-AppToken",
"in": "header",
"description": "The AppToken configured by the merchant.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{X-PROVIDER-API-AppToken}}"
}
}
},
"schemas": {
Expand Down

0 comments on commit 9affdfb

Please sign in to comment.