openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account Holidays API description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)" version: '1.0' servers: - url: https://{providerApiEndpoint} description: Anti-fraud provider endpoint URL. variables: providerApiEndpoint: description: Anti-fraud provider endpoint URL. default: '{providerApiEndpoint}' tags: - name: Holidays paths: /api/logistics/pvt/configuration/holidays/{holidayId}: put: tags: - Holidays summary: VTex Create/update holiday description: Creates or updates holidays through holiday ID. operationId: Create/UpdateHoliday parameters: - 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 default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json; charset=utf-8 - name: holidayId in: path description: '' required: true style: simple schema: type: string requestBody: content: application/json; charset=utf-8: schema: title: Create/UpdateHolidayRequest required: - name - startDate type: object properties: name: type: string startDate: type: string example: name: Natal startDate: '2016-12-25' example: name: Natal startDate: '2016-12-25' required: true responses: '200': description: OK headers: {} deprecated: false get: tags: - Holidays summary: VTex List holiday by ID description: Lists holiday's information by holiday ID. operationId: HolidayById parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json; charset=utf-8 - 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 default: application/json - name: holidayId in: path description: '' required: true style: simple schema: type: string responses: '200': description: OK headers: {} deprecated: false delete: tags: - Holidays summary: VTex Delete holiday description: Deletes given holidays set up in your store. operationId: Holiday parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json; charset=utf-8 - 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 default: application/json - name: holidayId in: path description: '' required: true style: simple schema: type: string responses: '200': description: OK headers: {} deprecated: false /api/logistics/pvt/configuration/holidays: get: tags: - Holidays summary: VTex List all holidays description: Lists information of all holidays. operationId: AllHolidays parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json; charset=utf-8 - 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 default: application/json responses: '200': description: OK headers: {} deprecated: false components: securitySchemes: 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.'