openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account Configuration 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: Configuration paths: /api/checkout/pvt/configuration/orderForm: get: tags: - Configuration summary: VTex Get orderForm configuration description: "Retrieves the settings that are currently applied to every orderForm in the account.\n\r\n\rThese settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm).\n\r\n\rAlways use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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| Checkout | CheckoutResources | **Save OrderForm Configuration** |\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.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: GetorderFormconfiguration parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' responses: '200': description: OK content: application/json: schema: type: object properties: paymentConfiguration: type: object description: Payment configuration information. properties: requiresAuthenticationForPreAuthorizedPaymentOption: type: boolean description: Determines whether pre-authorized payments require authentication. allowInstallmentsMerge: type: boolean description: By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case. taxConfiguration: type: object description: External tax service configuration information. nullable: true properties: url: type: string description: Endpoint URL. nullable: true authorizationHeader: type: string description: Authorization header. nullable: true appId: type: string description: Custom data ID sent to the tax system. isMarketplaceResponsibleForTaxes: type: boolean description: Indicates whether the marketplace is responsible for the products taxes. minimumQuantityAccumulatedForItems: type: integer description: Minimum SKU quantity by cart. decimalDigitsPrecision: type: integer description: Number of price digits. minimumValueAccumulated: type: integer description: Minimum cart value. nullable: true apps: type: array nullable: true description: Array of objects containing Apps configuration information. items: type: object properties: id: type: string description: App ID. fields: type: array description: Array of fields available to the app. items: type: string major: type: integer description: App major version. allowMultipleDeliveries: type: boolean description: On the same purchase, allows the selection of items from multiple delivery channels. nullable: true allowManualPrice: type: boolean description: Allows the editing of SKU prices right in the cart. nullable: true savePersonalDataAsOptIn: type: boolean description: Allows users to select whether they want the store to keep their personal and payment data saved. nullable: true maxNumberOfWhiteLabelSellers: type: integer description: Allows the input of a limit of white label sellers involved on the cart. nullable: true maskFirstPurchaseData: type: boolean description: Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data. nullable: true recaptchaValidation: type: string description: "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX's algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option." example: vtexCriteria requiresLoginToPlaceOrder: type: boolean description: Indicates whether authentication is required for completing purchases. example: true minimumPurchaseDowntimeSeconds: type: integer description: Minimum interval (in seconds) between successive purchases. example: 90 cartAgeToUseNewCardSeconds: type: integer description: Minimum cart existence period (in seconds) before allowing the use of a new credit card. example: 30 example: paymentConfiguration: requiresAuthenticationForPreAuthorizedPaymentOption: false allowInstallmentsMerge: false blockPaymentSession: null taxConfiguration: null minimumQuantityAccumulatedForItems: 1 decimalDigitsPrecision: 2 minimumValueAccumulated: null apps: - fields: - name - age id: abcd major: 1 allowMultipleDeliveries: false allowManualPrice: true savePersonalDataAsOptIn: false maxNumberOfWhiteLabelSellers: null maskFirstPurchaseData: null recaptchaValidation: vtexCriteria requiresLoginToPlaceOrder: true minimumPurchaseDowntimeSeconds: 90 cartAgeToUseNewCardSeconds: 30 deprecated: false post: tags: - Configuration summary: VTex Update orderForm configuration description: "Determines settings that will apply to every orderForm in the account.\n\r\n\rFor example, if you create an app using this request, every orderForm of this account will have the custom fields created though it.\n\r\n\r>ℹ️ Always retrieve the current configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To retrieve the current configuration, use the request [Get orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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| Checkout | CheckoutResources | **Save OrderForm Configuration** |\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.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: UpdateorderFormconfiguration parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateorderFormconfigurationRequest' example: paymentConfiguration: requiresAuthenticationForPreAuthorizedPaymentOption: false taxConfiguration: null minimumQuantityAccumulatedForItems: 1 decimalDigitsPrecision: 2 minimumValueAccumulated: null apps: null allowMultipleDeliveries: null allowManualPrice: null requiresLoginToPlaceOrder: true minimumPurchaseDowntimeSeconds: 90 cartAgeToUseNewCardSeconds: 30 required: true responses: '204': description: No Content. The request has succeeded. deprecated: false /api/checkout/pvt/configuration/window-to-change-seller: get: tags: - Configuration summary: VTex Get window to change seller description: "Retrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\r> The default period for this window is of 2 days, but it can be configured by the request Update window to change seller.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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| Checkout | CheckoutResources | **Save OrderForm Configuration** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: GetWindowToChangeSeller parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' responses: '200': description: OK content: text/plain: example: '2' deprecated: false post: tags: - Configuration summary: VTex Update window to change seller description: "Updates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\r> It is possible to check the current window using the request Get window to change seller.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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| Checkout | CheckoutResources | **Save OrderForm Configuration** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: UpdateWindowToChangeSeller parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: $ref: '#/components/schemas/WaitingTime' example: waitingTime: 4 required: true responses: '201': description: Created deprecated: false /api/checkout/pub/orderForm/{orderFormId}/messages/clear: post: tags: - Configuration summary: VTex Clear orderForm messages description: "This request removes all messages from the `messages` field of the orderForm , leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\r\n\r\n**Important**: **Request Body** must always be sent with empty value \"{ }\" in this endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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| Checkout | CheckoutResources | **Read Shopping Cart** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: ClearorderFormMessages security: [] parameters: - name: orderFormId in: path description: ID of the orderForm corresponding to the cart whose messages you want to remove. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: object description: This object must be empty. default: {} responses: '200': description: OK content: application/json: schema: type: object properties: response: description: Object response. type: object properties: value: description: Object with response value. type: object properties: orderFormId: type: string description: ID of the orderForm corresponding to a specific cart. salesChannel: type: string description: Attribute created by the seller, in their VTEX store configuration. loggedIn: type: boolean description: Indicates whether the user is logged into the store. isCheckedIn: type: boolean description: Indicates whether order is checked in. storeId: type: string description: ID of the store. nullable: true allowManualPrice: type: boolean description: Permission to modify item price manually. canEditData: type: boolean description: Data can be edited. userProfileId: type: string description: Unique ID associated with the customer profile. profileProvider: type: string description: Profile provider. availableAccounts: type: array description: Available accounts. items: type: string description: Available account. availableAddresses: type: array description: Information on each available address. items: type: object properties: addressType: type: string description: Address type. receiverName: type: string description: Name of the receiver. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. city: type: string description: City of the address. state: type: string description: State of the address. country: type: string description: Country of the address. ISO three-letter code. street: type: string description: Street of the address. number: type: string description: Number of the address. neighborhood: type: string description: Neighborhood of the address. complement: type: string description: Complement to the address. nullable: true reference: type: string description: Reference that may help in the location of the address. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. userType: type: string description: User type. nullable: true ignoreProfileData: type: boolean description: Ignore customer profile data. value: type: integer description: Total value of the order without separating cents. For example, $24.99 is represented `2499`. messages: type: array description: Array containing an object for each message generated by our servers while processing the request. items: type: string description: Message. items: type: array description: Information on each item in the order. items: type: object properties: uniqueId: type: string description: Unique ID. id: type: string description: ID of the item. productId: type: string description: Product ID. productRefId: type: string description: Product Ref ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. nullable: true name: type: string description: Product name. skuName: type: string description: SKU name. modalType: type: string description: Modal type. nullable: true parentItemIndex: type: integer description: Parent item index. nullable: true parentAssemblyBinding: type: string description: Parent assembly binding. nullable: true priceValidUntil: type: string description: Price expiration date and time. tax: type: integer description: Tax value in cents. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. manualPrice: type: integer description: Manual price in cents. nullable: true manualPriceAppliedBy: type: string description: User that applied the manual price, if that is the case. nullable: true sellingPrice: type: integer description: Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead. rewardValue: type: integer description: Reward value in cents. isGift: type: boolean description: Indicates whether item is a gift. additionalInfo: type: object description: Additional information. properties: dimension: type: string description: Dimension. nullable: true brandName: type: string description: Brand name. brandId: type: string description: Brand ID. offeringInfo: type: string description: Offering information. nullable: true offeringType: type: string description: Offering type. nullable: true offeringTypeId: type: string description: Offering type ID. nullable: true preSaleDate: type: string description: Presale date. nullable: true productCategoryIds: type: string description: Product category IDs. productCategories: type: object description: Object, where each field is an ID from `productCategoryIds`. properties: '{ID}': type: string description: Product category corresponding to the ID in the field key. quantity: type: integer description: Quantity. seller: type: string description: Seller. sellerChain: type: array description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. items: type: string description: Seller. imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. bundleItems: type: array description: 'Information on services sold along with the SKU. Example: a gift package.' items: type: object properties: type: type: string description: Service type. id: type: integer description: Service identifier. name: type: string description: Service name. price: type: integer description: Service price in cents. attachments: type: array description: Array containing information on attachments. items: type: string description: Attachment information. priceTags: type: array description: Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order. items: type: object properties: identifier: type: string description: Price tag identifier. nullable: true isPercentual: type: boolean description: Indicates whether price tag value is applied through a percentage. name: type: string description: Price tag name. rawValue: type: integer description: Price tag raw value. value: type: integer description: Price tag value. availability: type: string description: Availability. measurementUnit: type: string description: Measurement unit. unitMultiplier: type: integer description: Unit multiplier. manufacturerCode: type: string description: Manufacturer code. nullable: true priceDefinition: type: object description: Price information for all units of a specific item. properties: calculatedSellingPrice: type: integer description: Item's calculated unitary selling price in cents. total: type: integer description: Total value for all units of the item in cents. sellingPrices: type: array description: Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total. items: type: object properties: value: type: integer description: Value in cents for that specific rounding. quantity: type: integer description: Rounding quantity, meaning how many items are rounded to this value. selectableGifts: type: array description: Array containing the data of the item selected as a gift. items: type: string description: Gift. totalizers: type: array description: Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value). items: type: object description: Totalizer of purchases. shippingData: type: object description: Shipping information pertinent to the order. nullable: true properties: address: type: object description: Address information. nullable: true properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. nullable: true reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. logisticsInfo: type: array description: Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`. items: type: object properties: itemIndex: type: integer description: Index corresponding to the position of the object in the `items` array. selectedSla: type: string description: SLA selected by the customer. nullable: true selectedDeliveryChannel: type: string description: Delivery channel selected by the customer. nullable: true addressId: type: string description: Address ID. nullable: true slas: type: array description: Information on available SLAs. items: type: object properties: id: type: string description: SLA ID. deliveryChannel: type: string description: Delivery channel. name: type: string description: SLA name. deliveryIds: type: array description: Information on each delivery ID. items: type: object properties: courierId: type: string description: Courier ID. warehouseId: type: string description: Warehouse ID. dockId: type: string description: Warehouse ID. courierName: type: string description: Courier name. quantity: type: integer description: Quantity. shippingEstimate: type: string description: Shipping estimate. For instance, Three business days will be represented `3bd`. shippingEstimateDate: type: string description: Shipping estimate date. nullable: true lockTTL: type: string description: Estimate date of delivery. nullable: true price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. tax: type: integer description: Tax in cents. pickupStoreInfo: type: object description: Information on the pickup store. properties: isPickupStore: type: boolean description: Indicates whether it is the pickup store. friendlyName: type: string description: Friendly name. nullable: true address: type: object description: Address information. nullable: true properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. nullable: true reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. additionalInfo: type: string description: Additional information. nullable: true dockId: type: string description: Corresponding dock ID. nullable: true pickupPointId: type: string description: Pickup point ID. nullable: true pickupDistance: type: integer description: Pickup point distance. polygonName: type: string description: Polygon name. nullable: true transitTime: type: string description: Transit time. For instance, "three business days" is represented `3bd`. shipsTo: type: array description: List of countries that the item may be shipped to. items: type: string description: Three letter country code. itemId: type: string description: Item ID. deliveryChannels: type: array description: List of available delivery channels. items: type: object properties: id: type: string description: Delivery channel ID. selectedAddresses: type: array description: Array with information on the selected addresses for the order. items: type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. availableAddresses: type: array description: Array with information on the available addresses for the order. items: type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. clientProfileData: type: object nullable: true description: Customer's profile information. properties: email: type: string description: Email address. nullable: true firstName: type: string description: First name. nullable: true lastName: type: string description: Last name. documentType: type: string description: Type of the document informed by the customer. document: type: string description: Document informed by the customer. phone: type: string description: Phone number. corporateName: type: string description: Company name, if the customer is a legal entity. nullable: true tradeName: type: string description: Trade name, if the customer is a legal entity. nullable: true corporateDocument: type: string description: Corporate document, if the customer is a legal entity. nullable: true stateInscription: type: string description: State inscription, if the customer is a legal entity. nullable: true corporatePhone: type: string description: Corporate phone number, if the customer is a legal entity. nullable: true isCorporate: type: boolean description: Indicates whether the customer is a legal entity. profileCompleteOnLoading: type: boolean description: Indicates whether profile is complete on loading. profileErrorOnLoading: type: boolean description: Indicates whether profile presents error on loading. nullable: true customerClass: type: string description: Customer class. nullable: true paymentData: type: object description: Information on the order's payment. properties: giftCards: type: array description: Gift card information, if it applies to the order. items: type: object properties: redemptionCode: type: string description: Gift card redemption code. value: type: integer description: Gift card value in cents. balance: type: integer description: Gift card balance in cents. name: type: string description: Gift card name. id: type: string description: Gift card ID. inUse: type: boolean description: Indicates whether gift card is in use. isSpecialCard: type: boolean description: Indicates whether gift card is special. transactions: type: array description: Information on each transaction pertinent to the order. items: type: object properties: isActive: type: boolean description: Indicates whether transaction is active. transactionId: type: string description: Transaction ID. merchantName: type: string description: Merchant name. payments: type: array description: Information on each payment. items: type: object properties: accountId: type: string description: Account ID. nullable: true bin: type: string description: Bin. nullable: true installments: type: integer description: Number of installments. paymentSystem: type: integer description: Payment system. referenceValue: type: integer description: Reference value for calculating interest rates, in case it applies. Displayed in cents. value: type: integer description: Value including interest, in case it applies. Displayed in cents. sharedTransaction: type: boolean description: Indicates whather transaction is shared. marketingData: type: object description: Object containing promotion data such as coupon tracking information and internal or external UTMs. nullable: true properties: coupon: type: string description: Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order. example: free-shipping utmSource: type: string description: UTM source. example: Facebook utmMedium: type: string description: UTM medium. example: CPC utmCampaign: type: string description: UTM campaign example: Black friday utmiPage: type: string description: utmi_page (internal utm) example: utmi_page-example nullable: true utmiPart: type: string description: utmi_part (internal utm). example: utmi_part-example nullable: true utmiCampaign: type: string description: utmi_campaign (internal utm). example: utmi_campaign-example nullable: true sellers: type: array description: Information on each seller. items: type: object properties: id: type: string description: Seller ID. name: type: string description: Seller name. logo: type: string description: Seller logo. nullable: true clientPreferencesData: type: object description: Object containing preferences from the client who placed the order. properties: locale: type: string description: 'Client''s locale. Examples: `pt-BR` and `en-US`.' optinNewsLetter: type: boolean description: '`true` if the client opted to receive newsletter from the store.' example: false nullable: true commercialConditionData: type: object description: Object containing commercial condition information. nullable: true storePreferencesData: type: object description: Object containing data from the store's configuration (stored in VTEX's License Manager). giftRegistryData: type: object description: Gift registry list information. nullable: true openTextField: type: string description: Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1). example: open-text-example nullable: true invoiceData: type: object description: Object containing information pertinent to the order's invoice. nullable: true customData: type: object description: Customer additional information. nullable: true itemMetadata: type: object description: Item metadata. properties: items: type: array description: List of objects containing metadata on each item in the order. items: type: object properties: id: type: string description: Item ID. seller: type: string description: Seller. name: type: string description: Product name. skuName: type: string description: SKU name. productId: type: string description: Product ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. nullable: true imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. hooksData: type: object description: Hooks information. nullable: true ratesAndBenefitsData: type: object description: Information on rates and benefits that apply to the order. properties: rateAndBenefitsIdentifiers: type: array description: List with rates and benefits identifiers. items: type: string description: Benefit identifier. teaser: type: array description: List with rates and benefits teasers. items: type: string description: Benefit teaser. subscriptionData: type: object description: Subscription information. nullable: true itemsOrdination: type: object description: Object containing information about the ordering of items within the orderForm. properties: criteria: type: string description: Criteria adopted to order the items in the list. ascending: type: boolean description: Indicates whether the ordering is ascending. examples: response: value: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 profileProvider: VTEX availableAccounts: [] availableAddresses: - addressType: residential receiverName: Clark Kent addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 userType: User type ignoreProfileData: false value: 34390 messages: [] items: - uniqueId: 9D6E447B3FF64CEDA33B17C01379C119 id: '2' productId: '2' productRefId: '1' refId: CBC30L ean: null name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2022-07-13T18:30:46Z' tax: 0 price: 32890 listPrice: 49900 manualPrice: null manualPriceAppliedBy: null sellingPrice: 32890 rewardValue: 0 isGift: false additionalInfo: dimension: null brandName: Brahma brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/ productCategories: '1': Bebidas quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null priceDefinition: calculatedSellingPrice: 32890 total: 32890 sellingPrices: - value: 32890 quantity: 1 selectableGifts: [] totalizers: - id: Items name: Total Items value: 32890 shippingData: address: addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: teste slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: [] deliveryWindow: null price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd shipsTo: - BRA - COL - USA itemId: '2' deliveryChannels: - id: delivery - id: pickup-in-point selectedAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 availableAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 pickupPoints: [] clientProfileData: email: clark.kent@example.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5521998765432' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: giftCards: [] transactions: - isActive: true transactionId: 296D6D245C17437E823EB77E403FC88D merchantName: MYSTORE payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null sharedTransaction: false marketingData: coupon: free-shipping utmSource: app utmMedium: CPC utmCampaign: Black friday utmipage: null utmiPart: null utmiCampaign: null sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: false commercialConditionData: null storePreferencesData: {} giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '2' seller: '1' name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L productId: '2' refId: CBC30L ean: null imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true deprecated: false /api/pvt/affiliations: get: tags: - Configuration summary: VTex List all affiliations description: "Returns all affiliations (payment and anti-fraud providers) that are already configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: Affiliations parameters: - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' responses: '200': description: OK content: application/json: schema: type: array required: - id - implementation - name - configuration - isdelivered - isConfigured items: type: object description: Affiliations information. properties: id: type: string description: Provider identification. implementation: type: string description: Provider implementation class name. name: type: string description: Provider name. configuration: type: array description: Array containing configuration information fields. items: type: object description: Provider configuration information. required: - name - value - valueKey properties: name: type: string description: Configuration parameter name. value: type: string description: Configuration parameter value. nullable: true valueKey: type: string description: Value key information. nullable: true isdelivered: type: boolean description: Indicates whether the provider is published and available for use. isConfigured: type: boolean description: Indicates whether the provider is configured. example: - id: c4c0d24d-b9b8-468d-af98-916b4ada930d implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector name: CieloV3 - 3ds2 prod configuration: - name: HowTo value: https://developercielo.github.io/payment-method-enablement/ valueKey: null - name: MerchantId value: 56b93f46-2b3a-480f-8f9e-ec8e1fde97c0 valueKey: null - name: MerchantKey value: '**********' valueKey: null - name: softDescriptor value: vtex test valueKey: null - name: bankInvoiceProvider value: BancoDoBrasil2 valueKey: null - name: bankDebitProvider value: BancoDoBrasil valueKey: null - name: Registered value: 'true' valueKey: null - name: use3ds value: 'true' valueKey: null - name: EstablishmentCode value: '1119338171' valueKey: null - name: MerchantName value: VTEX valueKey: null - name: MCC value: '7372' valueKey: null - name: ClientId value: 6b4853d7-44f8-4c58-8d48-811d4cb49e1a valueKey: null - name: ClientSecret value: '**********' valueKey: null - name: BpmpiAuth value: 'true' valueKey: null - name: BpmpiAuthNotifyOnly value: 'false' valueKey: null - name: BpmpiAuthSuppresschallenge value: 'false' valueKey: null - name: useEarlySecurityCapture value: '0' valueKey: null - name: autoSettleDelay value: '' valueKey: null - name: isProduction value: 'true' valueKey: null isdelivered: true isConfigured: true - id: 42bc3c4c-f8ca-4be0-870c-edfe263546b6 implementation: Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector name: Gift Card configuration: - name: usesOnlineRefund value: 'true' valueKey: null - name: useEarlySecurityCapture value: '1' valueKey: null isdelivered: true isConfigured: true - id: 1bd6e98e-6986-4ff3-ab58-78a37bd2a2ef implementation: Vtex.PaymentGateway.Connectors.AdyenConnector name: Adyen configuration: - name: username value: ws_399958@Company.VtexBR valueKey: null - name: password value: '**********' valueKey: null - name: account value: VTEXPubliEventos valueKey: null - name: liveEndpointPrefix value: 99e86b1244882cda-VtexBR valueKey: null - name: marketPayAccount value: '' valueKey: null - name: marketPayCommission value: '' valueKey: null - name: subMerchantId value: '' valueKey: null - name: Currency value: BRL valueKey: null - name: Brand value: boletobancario_bradesco valueKey: null - name: ShopperStatement value: '' valueKey: null - name: SoftDescriptor value: '' valueKey: null - name: SkinCode value: '' valueKey: null - name: LanguageCode value: pt valueKey: null - name: expirationDays value: '7' valueKey: null - name: HmacKey value: '' valueKey: null - name: useMultipleRefund value: 'false' valueKey: null - name: use3DS value: 'true' valueKey: null - name: threeDSecureMode value: 3ds2-auth valueKey: null - name: requireLiabilityShift value: 'false' valueKey: null - name: applePay_MerchantId value: '' valueKey: null - name: applePay_MerchantCertificate value: null valueKey: null - name: applePay_MerchantPassword value: '' valueKey: null - name: autoSettle value: '4' valueKey: null - name: countryCode value: AT valueKey: null - name: useEarlySecurityCapture value: '0' valueKey: null - name: useAntifraud value: 'false' valueKey: null - name: isProduction value: 'true' valueKey: null - name: LinkHelp value: '' valueKey: null isdelivered: true isConfigured: true - id: 400b66d3-bc9a-4eb8-afc0-f32fe63c7121 implementation: Vtex.PaymentGateway.Connectors.BankIssuedInvoiceItauConnector name: BankInvoice Itau configuration: - name: CompanyName value: TESTE valueKey: null - name: Document value: '1111111111111111' valueKey: null - name: BranchCode value: '1158' valueKey: null - name: Account value: '1160' valueKey: null - name: ExpiryDays value: '5' valueKey: null - name: Instructions value: xpto valueKey: null - name: Portfolio value: '11' valueKey: null - name: BankAgreement value: '000111' valueKey: null - name: TransferorCode value: a valueKey: null - name: companyAddress value: '' valueKey: null - name: Registered value: 'true' valueKey: null - name: configurationTemplate value: '{"name":"Registered","template":[{"value":"true","configuration":[{"name":"AuthEnvironment","hidden":false},{"name":"EnvironmentType","hidden":false},{"name":"ClientId","hidden":false},{"name":"ClientSecret","hidden":false},{"name":"ItauKey","hidden":false}]}]}' valueKey: null - name: AuthEnvironment value: '' valueKey: null - name: EnvironmentType value: '' valueKey: null - name: ClientId value: '' valueKey: null - name: ClientSecret value: '' valueKey: null - name: ItauKey value: '' valueKey: null - name: TransactionExpirationDays value: '20' valueKey: null - name: isProduction value: 'true' valueKey: null isdelivered: true isConfigured: true - id: 1d884ffd-13d7-419e-a487-da55a2205792 implementation: Vtex.PaymentGateway.Connectors.TestConnector name: Test Connector configuration: - name: OperationTime value: '1000' valueKey: null - name: applePay_MerchantId value: '' valueKey: null - name: applePay_MerchantCertificate value: null valueKey: null - name: applePay_MerchantPassword value: '' valueKey: null - name: SamsungPayServiceId value: '' valueKey: null isdelivered: false isConfigured: true deprecated: false post: tags: - Configuration summary: VTex Insert new affiliation description: "Registers a new affiliation (payment or anti-fraud provider) in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: InsertAffiliation parameters: - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/InsertAffiliationRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AffiliationResponse' example: id: fg8b4ea5-0b24-47dc-971e-2f6635ea1f14 implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector name: CieloV3 - Test configuration: - name: HowTo value: https://developercielo.github.io/payment-method-enablement/ valueKey: null - name: MerchantId value: sampleData valueKey: null - name: MerchantKey value: '**********' valueKey: null - name: softDescriptor value: teste valueKey: null - name: bankInvoiceProvider value: Disabled valueKey: null - name: bankIDebitProvider value: Disabled valueKey: null - name: useEarlySecurityCapture value: '0' valueKey: null - name: isProduction value: 'false' valueKey: null - name: bankDebitProvider value: Disabled valueKey: null - name: Registered value: 'false' valueKey: null isdelivered: true isConfigured: true deprecated: false /api/pvt/affiliations/{affiliationId}: put: tags: - Configuration summary: VTex Update affiliation by ID description: "Updates information about an affiliation (payment or anti-fraud provider) configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: UpdateAffiliation parameters: - $ref: '#/components/parameters/affiliationId' - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAffiliationRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AffiliationResponse' example: id: fg8b4ea5-0b24-47dc-971e-2f6635ea1f14 implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector name: CieloV3 - Test configuration: - name: HowTo value: https://developercielo.github.io/payment-method-enablement/ valueKey: null - name: MerchantId value: sampleData_2 valueKey: null - name: MerchantKey value: '**********' valueKey: null - name: softDescriptor value: teste_update valueKey: null - name: bankInvoiceProvider value: Disabled valueKey: null - name: bankIDebitProvider value: Disabled valueKey: null - name: useEarlySecurityCapture value: '0' valueKey: null - name: isProduction value: 'false' valueKey: null - name: bankDebitProvider value: Disabled valueKey: null - name: Registered value: 'false' valueKey: null isdelivered: true isConfigured: true deprecated: false get: tags: - Configuration summary: VTex Get affiliation by ID description: "Returns data for a specific affiliation (payment or anti-fraud provider).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: AffiliationById parameters: - $ref: '#/components/parameters/affiliationId' - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AffiliationResponse' example: id: fg8b4ea5-0b24-47dc-971e-2f6635ea1f14 implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector name: CieloV3 - Test configuration: - name: HowTo value: https://developercielo.github.io/payment-method-enablement/ valueKey: null - name: MerchantId value: sampleData_2 valueKey: null - name: MerchantKey value: '**********' valueKey: null - name: softDescriptor value: teste_update valueKey: null - name: bankInvoiceProvider value: Disabled valueKey: null - name: bankIDebitProvider value: Disabled valueKey: null - name: useEarlySecurityCapture value: '0' valueKey: null - name: isProduction value: 'false' valueKey: null - name: bankDebitProvider value: Disabled valueKey: null - name: Registered value: 'false' valueKey: null isdelivered: true isConfigured: true deprecated: false /api/pvt/rules: get: tags: - Configuration summary: VTex List all payment rules description: "Returns all payment rules applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: Rules parameters: - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetRulesResponse' example: - id: 9e11ed95-4b7f-4445-a53e-2512f260ff1c name: 'American Express - ' salesChannels: - id: ':ALL:' paymentSystem: id: 1 name: American Express implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector affiliationId: 08a0844b-4aab-4f1b-beed-b3889649534b issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: dueDateType: 0 interestRateMethod: 0 minimumInstallmentValue: 1 installments: - ruleId: null quantity: 12 value: 0 interestRate: 1.86 isExternalInstallmentService: null interestTax: 0 - ruleId: null quantity: 18 value: 0 interestRate: 1.9 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: '2023-12-10T17:00:00Z' endDate: '2023-12-22T01:00:00Z' condition: id: '1' pullRate: 0 name: null multiMerchantList: - test_store_1 - test_store_2 country: name: null isoCode: us dateIntervals: - start: '* * 11 * * 1,3,4 * -0300' end: '* * 18 * * 1,3,4 * -0300' - start: '* * 05 * * * * -0300' end: '* * 23 * * * * -0300' externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: Premium excludedBinsRanges: null - id: 01a8d68b-9116-4655-83f8-3380f658ec04 name: QR Code salesChannels: - id: ':ALL:' paymentSystem: id: 72 name: PicPay implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_PicPay affiliationId: 9c4e7bb1-0356-4449-b59f-2e1bbac606f8 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: dueDateType: 1 interestRateMethod: 0 minimumInstallmentValue: 10 installments: - ruleId: null quantity: 1 value: 0 interestRate: 0 isExternalInstallmentService: null interestTax: 0 - ruleId: null quantity: 2 value: 0 interestRate: 0 isExternalInstallmentService: null interestTax: 0 - ruleId: null quantity: 3 value: 0 interestRate: 0 isExternalInstallmentService: null interestTax: 0 - ruleId: null quantity: 4 value: 0 interestRate: 0 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: 38426c64-fb35-412c-9900-c3fc0e812109 name: 'Customer Credit - ' salesChannels: - id: ':ALL:' paymentSystem: id: 64 name: Customer Credit implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_CreditControlV2 affiliationId: 7f95a993-4a8c-4d08-a1ae-94625ff1bfb4 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: dueDateType: 0 interestRateMethod: 0 minimumInstallmentValue: 0 installments: - ruleId: null quantity: 1 value: 0 interestRate: 0 isExternalInstallmentService: null interestTax: null - ruleId: null quantity: 2 value: 0 interestRate: 0 isExternalInstallmentService: null interestTax: null isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: - start: '* * 11 * * 1,3,4 * -0300' end: '* * 18 * * 1,3,4 * -0300' - start: '* * 05 * * * * -0300' end: '* * 23 * * * * -0300' externalInterest: false minimumValue: null deadlines: - paymentOptions: - days: 30 interestRate: 0 - paymentOptions: - days: 30 interestRate: 0 - days: 60 interestRate: 0 - paymentOptions: - days: 15 interestRate: 0 - days: 30 interestRate: 0 cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: b7137b64-5b45-4c03-8d75-5ebc320fe537 name: Cash on Delivery salesChannels: - id: ':ALL:' paymentSystem: id: 17 name: Promissory implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.PromissoryConnector affiliationId: 914a05f6-f48f-4dc1-a41d-ffe3f682b405 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: null endDate: null condition: id: '1' pullRate: 1 name: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: 46a75262-6666-43d8-bff5-b6b439a5e074 name: 'Maestro - ' salesChannels: - id: ':ALL:' paymentSystem: id: 39 name: Maestro implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.AdyenConnector affiliationId: 1bd6e98e-6986-4ff3-ab58-78a37bd2a2ef issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: 453cb507-294c-40c4-84d3-49ecb02acbbb name: 'Visa - ' salesChannels: - id: ':ALL:' paymentSystem: id: 2 name: Visa implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.MercadoPagoV1.MercadoPagoV1Connector affiliationId: 37806301-73da-4c3f-96e8-7b00fde5fbf2 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: c6a4675f-a3eb-441a-9de0-75e3b784af7b name: 'Mastercard - ' salesChannels: - id: ':ALL:' paymentSystem: id: 4 name: Mastercard implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector affiliationId: 08a0844b-4aab-4f1b-beed-b3889649534b issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: df391a06-e6de-4fbf-ae8f-fd40fecba88f name: 'Bank Invoice - ' salesChannels: - id: ':ALL:' paymentSystem: id: 6 name: Bank Invoice implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.TestConnector affiliationId: 1d884ffd-13d7-419e-a487-da55a2205792 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: 220c353e-a298-4f87-ace8-fb4909d34248 name: 'Google Pay - ' salesChannels: - id: ':ALL:' paymentSystem: id: 169 name: Google Pay implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_stripe-payment-provider-connector-v3 affiliationId: d983efd2-93ee-46ad-857f-39f933ffdf03 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: f1442584-f627-4766-a878-dd9427c2cd4b name: Invoice Payment App salesChannels: - id: ':ALL:' paymentSystem: id: 6 name: Boleto Bancário implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.BankIssuedInvoiceItauConnector affiliationId: 400b66d3-bc9a-4eb8-afc0-f32fe63c7121 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null - id: 16641c21-d94a-4c0c-9bfa-fb7d646b495f name: 'Pix - ' salesChannels: - id: ':ALL:' paymentSystem: id: 125 name: Pix implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_SpinPay affiliationId: 268d2e68-169a-4a85-a670-39409a2a24b6 issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: null isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: null endDate: null condition: null multiMerchantList: null country: null dateIntervals: null externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: null excludedBinsRanges: null deprecated: false post: tags: - Configuration summary: VTex Insert a new payment rule description: "Creates a new payment rule to be applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: InsertRule parameters: - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/InsertRuleRequest' example: name: Test_API_2 salesChannels: - id: '1' paymentSystem: id: 8 name: Hipercard implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector affiliationId: 0a8488e6-0c30-4150-be96-b0dcaaa6a0cd issuer: name: barclays antifraud: implementation: null affiliationId: null installmentOptions: dueDateType: 1 interestRateMethod: 2 minimumInstallmentValue: 50 installments: - ruleId: null quantity: 6 value: 0 interestRate: 15 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: '2023-12-10T17:00:00Z' endDate: '2023-12-22T01:00:00Z' condition: id: '1' pullRate: 0 name: null multiMerchantList: - cosmetics2 country: name: null isoCode: us dateIntervals: - start: '* * 11 * * 1,3,4 * -0300' end: '* * 18 * * 1,3,4 * -0300' - start: '* * 05 * * * * -0300' end: '* * 23 * * * * -0300' externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: business excludedBinsRanges: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RulesRequest' example: id: c997267e-39bf-4217-a890-a503f6a7dc47 name: Test_API_2 salesChannels: - id: '1' paymentSystem: id: 8 name: Hipercard implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector affiliationId: 0a8488e6-0c30-4150-be96-b0dcaaa6a0cd issuer: name: barclays antifraud: null installmentOptions: dueDateType: 1 interestRateMethod: 2 minimumInstallmentValue: 50 installments: - ruleId: null quantity: 6 value: 0 interestRate: 15 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: '2023-12-10T17:00:00Z' endDate: '2023-12-22T01:00:00Z' condition: id: '1' pullRate: 0 name: null multiMerchantList: - cosmetics2 country: name: null isoCode: us dateIntervals: - start: '* * 11 * * 1,3,4 * -0300' end: '* * 18 * * 1,3,4 * -0300' - start: '* * 05 * * * * -0300' end: '* * 23 * * * * -0300' externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: business excludedBinsRanges: null deprecated: false /api/pvt/rules/{ruleId}: get: tags: - Configuration summary: VTex Get payment rule by ID description: "Returns data for a specific payment rule applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: RuleById parameters: - $ref: '#/components/parameters/ruleId' - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RulesRequest' example: id: 9e11ed95-4b7f-4445-a53e-2512f260ff1c name: 'American Express - ' salesChannels: - id: ':ALL:' paymentSystem: id: 1 name: American Express implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector affiliationId: 08a0844b-4aab-4f1b-beed-b3889649534b issuer: name: null antifraud: implementation: null affiliationId: null installmentOptions: dueDateType: 0 interestRateMethod: 0 minimumInstallmentValue: 1 installments: - ruleId: null quantity: 12 value: 0 interestRate: 1.86 isExternalInstallmentService: null interestTax: 0 - ruleId: null quantity: 18 value: 0 interestRate: 1.9 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: true installmentsService: false isDefault: null beginDate: '2023-12-10T17:00:00Z' endDate: '2023-12-22T01:00:00Z' condition: id: '1' pullRate: 0 name: null multiMerchantList: - test_store_1 - test_store_2 country: name: null isoCode: us dateIntervals: - start: '* * 11 * * 1,3,4 * -0300' end: '* * 18 * * 1,3,4 * -0300' - start: '* * 05 * * * * -0300' end: '* * 23 * * * * -0300' externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: Premium excludedBinsRanges: null deprecated: false put: tags: - Configuration summary: VTex Update payment rule by ID description: "Updates information about a specific payment rule applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: PutRuleById parameters: - $ref: '#/components/parameters/ruleId' - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/RulesRequest' example: id: c997267e-39bf-4217-a890-a503f6a7dc47 name: Test_API_2_Updated salesChannels: - id: '1' paymentSystem: id: 8 name: Hipercard implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector affiliationId: 0a8488e6-0c30-4150-be96-b0dcaaa6a0cd issuer: name: barclays antifraud: null installmentOptions: dueDateType: 0 interestRateMethod: 1 minimumInstallmentValue: 400 installments: - ruleId: null quantity: 12 value: 0 interestRate: 25 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: '2023-12-15T17:00:00Z' endDate: '2023-12-30T01:00:00Z' condition: id: '1' pullRate: 15 name: null multiMerchantList: [] country: name: null isoCode: br dateIntervals: - start: '* * 12 * * 1,3,4 * -0300' end: '* * 19 * * 1,3,4 * -0300' - start: '* * 09 * * * * -0300' end: '* * 21 * * * * -0300' externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: gold excludedBinsRanges: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RulesRequest' example: id: c997267e-39bf-4217-a890-a503f6a7dc47 name: Test_API_2_Updated salesChannels: - id: '1' paymentSystem: id: 8 name: Hipercard implementation: null connector: implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector affiliationId: 0a8488e6-0c30-4150-be96-b0dcaaa6a0cd issuer: name: barclays antifraud: null installmentOptions: dueDateType: 0 interestRateMethod: 1 minimumInstallmentValue: 400 installments: - ruleId: null quantity: 12 value: 0 interestRate: 25 isExternalInstallmentService: null interestTax: 0 isSelfAuthorized: null requiresAuthentication: null enabled: false installmentsService: false isDefault: null beginDate: '2023-12-15T17:00:00Z' endDate: '2023-12-30T01:00:00Z' condition: id: '1' pullRate: 15 name: null multiMerchantList: [] country: name: null isoCode: br dateIntervals: - start: '* * 12 * * 1,3,4 * -0300' end: '* * 19 * * 1,3,4 * -0300' - start: '* * 09 * * * * -0300' end: '* * 21 * * * * -0300' externalInterest: false minimumValue: null deadlines: [] cobrand: name: null cardLevel: name: gold excludedBinsRanges: null deprecated: false delete: tags: - Configuration summary: VTex Delete payment rule by ID description: "Deletes a specific payment rule applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\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. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: Rule parameters: - $ref: '#/components/parameters/ruleId' - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' responses: '200': description: OK. This endpoint does not return any data in the response body. deprecated: false /api/pvt/merchants/payment-systems: get: tags: - Configuration summary: VTex List all available payment methods description: "Returns all payment methods (such as Visa, Master, among others) that can be used in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\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." operationId: AvailablePaymentMethods parameters: - $ref: '#/components/parameters/Content-Type_2' - $ref: '#/components/parameters/Accept_2' responses: '200': description: OK content: application/json: schema: type: array description: Payment methods information. items: $ref: '#/components/schemas/PaymentSystemsResponse' example: - id: 1 name: American Express requiresDocument: false implementation: Vtex.PaymentGateway.CreditCard.Amex connectorImplementation: Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector antifraudConnectorImplementation: null groupName: creditCard redirect: false isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: true allowBinExclusion: false allowMultiple: true allowIssuer: true allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: true validator: regex: ^3[47][0-9]{13}$ mask: 9999 999999 99999 cardCodeMask: '9999' cardCodeRegex: ^[0-9]{4}$ weights: - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 72 name: PicPay requiresDocument: false implementation: Vtex.PaymentGateway.RedirectPayments.PicPayPayment connectorImplementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_PicPay antifraudConnectorImplementation: null groupName: picPay redirect: true isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: true allowBinExclusion: false allowMultiple: true allowIssuer: false allowCountry: true allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: false validator: regex: null mask: null cardCodeMask: null cardCodeRegex: null weights: null useCvv: false useExpirationDate: false useCardHolderName: false useBillingAddress: false validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 64 name: Customer Credit requiresDocument: false implementation: Vtex.PaymentGateway.Promissory.CreditControlPayment connectorImplementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_CreditControlV2 antifraudConnectorImplementation: null groupName: creditControl redirect: false isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: true allowBinExclusion: false allowMultiple: true allowIssuer: false allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: false validator: regex: null mask: null cardCodeMask: null cardCodeRegex: null weights: null useCvv: false useExpirationDate: false useCardHolderName: false useBillingAddress: false validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 16 name: Vale requiresDocument: true implementation: Vtex.PaymentGateway.GiftCard.VtexGiftCard connectorImplementation: Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector antifraudConnectorImplementation: null groupName: giftCard redirect: false isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: false allowBinExclusion: false allowMultiple: true allowIssuer: false allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: false validator: regex: null mask: null cardCodeMask: null cardCodeRegex: null weights: null useCvv: false useExpirationDate: false useCardHolderName: false useBillingAddress: false validCardLengths: null appDependencies: null displayDocument: true dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 39 name: Maestro requiresDocument: false implementation: Vtex.PaymentGateway.Card.Maestro connectorImplementation: Vtex.PaymentGateway.Connectors.AdyenConnector antifraudConnectorImplementation: null groupName: debitCard redirect: false isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: false allowBinExclusion: false allowMultiple: false allowIssuer: true allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: false validator: 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}) mask: 9999 9999 9999 9999 cardCodeMask: '999' cardCodeRegex: ^[0-9]{3}$ weights: - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 169 name: Google Pay requiresDocument: false implementation: Vtex.PaymentGateway.RedirectPayments.GooglePayPayment connectorImplementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_stripe-payment-provider-connector-v3 antifraudConnectorImplementation: null groupName: Google Pay redirect: true isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: false allowBinExclusion: false allowMultiple: true allowIssuer: false allowCountry: true allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: false validator: regex: null mask: null cardCodeMask: null cardCodeRegex: null weights: null useCvv: false useExpirationDate: false useCardHolderName: false useBillingAddress: false validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 4 name: Mastercard requiresDocument: true implementation: Vtex.PaymentGateway.CreditCard.Mastercard connectorImplementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0 antifraudConnectorImplementation: null groupName: creditCard redirect: false isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: true allowBinExclusion: false allowMultiple: true allowIssuer: true allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: true validator: 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}) mask: 9999 9999 9999 9999 cardCodeMask: '999' cardCodeRegex: ^[0-9]{3}$ weights: - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true validCardLengths: null appDependencies: null displayDocument: true dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 - id: 401 name: PaymentApp requiresDocument: false implementation: Vtex.PaymentGateway.CreditCard.PrivateLabelPayment connectorImplementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0 antifraudConnectorImplementation: null groupName: customPrivate_401 redirect: false isCustom: true isSelfAuthorized: false requiresAuthentication: false allowInstallments: true allowBinExclusion: false allowMultiple: true allowIssuer: true allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: '' supportRecurrence: true validator: regex: 1(0(0(0(0([0-9])|[1-9][0-9]{11})|[1-9][0-9]{12})|[1-9][0-9]{13})|[1-9][0-9]{14})|9(9(9(9(9([0-9])|[0-8][0-9]{11})|[0-8][0-9]{12})|[0-8][0-9]{13})|[0-8][0-9]{14})|[2-8][0-9]{15} mask: 9999 9999 9999 9999 cardCodeMask: '999' cardCodeRegex: ^[0-9]{3}$ weights: [] useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: false validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-23T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 14399 - id: 2 name: Visa requiresDocument: false implementation: Vtex.PaymentGateway.CreditCard.Visa connectorImplementation: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0 antifraudConnectorImplementation: null groupName: creditCard redirect: false isCustom: false isSelfAuthorized: false requiresAuthentication: false allowInstallments: true allowBinExclusion: false allowMultiple: true allowIssuer: true allowCountry: false allowCommercialPolicy: true allowCommercialCondition: true allowPeriod: true isAvailable: true description: null supportRecurrence: true validator: regex: ^4[0-9]{15}$ mask: 9999 9999 9999 9999 cardCodeMask: '999' cardCodeRegex: ^[0-9]{3}$ weights: - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true validCardLengths: null appDependencies: null displayDocument: false dueDate: '2023-12-20T11:46:27.2993428Z' allowNotification: false affiliationId: null availablePayments: null dueDateMinutes: 10079 deprecated: false components: schemas: Antifraud: required: - implementation - affiliationId type: object description: Anti-fraud information. nullable: true properties: implementation: type: string description: Connector (anti-fraud provider) implementation class name. example: Vtex.PaymentGateway.Connectors.ClearSaleConnector nullable: true affiliationId: type: string description: Affiliation connector (anti-fraud provider) identification. example: 0a8488e6-0c30-4150-be96-b0dcaaa6a0cd nullable: true PaymentConfiguration: title: PaymentConfiguration description: Payment Configuration object. required: - requiresAuthenticationForPreAuthorizedPaymentOption type: object properties: requiresAuthenticationForPreAuthorizedPaymentOption: type: boolean description: Determines whether pre-authorized payments require authentication. allowInstallmentsMerge: type: boolean description: By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case. blockPaymentSession: type: boolean description: Indicates whether shoppers can add credit cards in your store's `My Account` section. example: requiresAuthenticationForPreAuthorizedPaymentOption: false allowInstallmentsMerge: false blockPaymentSession: false RulesRequest: required: - id - name - salesChannels - paymentSystem - connector - issuer - antifraud - installmentOptions - isSelfAuthorized - requiresAuthentication - enabled - installmentsService - isDefault - beginDate - endDate - condition - multiMerchantList - country - dateIntervals type: object description: Payment rules information. properties: id: type: string description: Rule identification. example: 9e11ed95-4b7f-4445-a53e-2512f260ff1c name: type: string description: Rule name. example: American Express salesChannels: $ref: '#/components/schemas/SalesChannel' paymentSystem: $ref: '#/components/schemas/PaymentSystem' connector: $ref: '#/components/schemas/Connector' issuer: $ref: '#/components/schemas/Issuer' antifraud: $ref: '#/components/schemas/Antifraud' installmentOptions: required: - dueDateType - interestRateMethod - minimumInstallmentValue - installments type: object description: Installment options information. nullable: true properties: dueDateType: type: number description: Indicates whether the billing date will be at the end (0) or beginning of the period (1). enum: - 0 - 1 interestRateMethod: type: number description: Indicates the type of interest to calculate the value of the installments (Compound Interest = `null` or `0`, Simple Interest Rate with Tax = `1` and Single Interest = `2`). enum: - null - 0 - 1 - 2 nullable: true minimumInstallmentValue: type: number description: Minimum value of each installment. installments: type: array description: Array containing installments information. items: required: - ruleId - quantity - value - interestRate - isExternalInstallmentService - interestTax type: object description: Installments information. properties: ruleId: type: string description: Rule identification. example: fe6c470b-f80b-4bb1-a75c-378617f8767a nullable: true quantity: type: integer description: Number of installments. example: 1 value: type: number description: Value of each installment. interestRate: type: number description: Interest rate (percent 0.1 = 10%). isExternalInstallmentService: type: number description: Indicates the external installment system (if applicable). nullable: true interestTax: type: number description: Interest tax (percent 0.1 = 10%). nullable: true isSelfAuthorized: type: boolean description: Indicates whether the payment is automatically authorized. example: true nullable: true requiresAuthentication: type: boolean description: Indicates whether it is necessary to log in to make the payment. example: true nullable: true enabled: type: boolean description: Indicates whether the rule is enabled in the store. example: true installmentsService: type: boolean description: Indicates whether any specific type of installment service is used. example: false isDefault: type: boolean description: Indicates whether this rule should be considered the default for a given payment condition. example: false nullable: true beginDate: type: string description: Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable. example: '2023-12-10T17:00:00Z' nullable: true endDate: type: string description: Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable. example: '2023-12-12T17:00:00Z' nullable: true condition: required: - id - pullRate - name type: object description: Commercial condition information. nullable: true properties: id: type: string description: Commercial condition identification. example: '1' pullRate: type: number description: Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated. example: 0 name: type: string description: Commercial condition information. example: Commercial_condition_1 nullable: true multiMerchantList: type: array description: Indicates the names of the accounts to which the rule is being applied exclusively. items: type: string description: Account names. example: test_store_1 nullable: true country: required: - name - isoCode type: object description: Information about rule application in a country. nullable: true properties: name: type: string description: Country name. example: Brazil nullable: true isoCode: type: string description: Country code (ISO 3166 alpha-2). example: BRA dateIntervals: type: array description: Array containing information about the periods (days and hours) in which the rule is enabled. nullable: true items: required: - start - end type: object description: Rule enablement period information. properties: start: type: string description: Time, days of the week, and GMT time zone in which the rule is activated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron). example: '* * 11 * * 1,3,4 * -0300' end: type: string description: Time, days of the week and GMT time zone in which the rule is deactivated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron). example: '* * 18 * * 1,3,4 * -0300' externalInterest: type: boolean description: Indicates whether interest can be calculated externally. example: false minimumValue: type: number description: Minimum payment transaction amount for the rule to be applied. nullable: true deadlines: type: array description: Array containing information about the payment deadlines (applicable for credit payment method). items: type: object description: Payment deadlines information. required: - paymentOptions properties: paymentOptions: type: array description: Array containing payment options information. items: required: - days - interestRate type: object description: Payment options information. properties: days: type: number description: Deadline in days to make payment. example: 30 interestRate: type: number description: Interest rate applied (in percentage, e.g. `3.0` means 3%). example: 0 cobrand: required: - name type: object description: Information about the cobranded card. properties: name: type: string description: Card name. example: Cobrand_Test nullable: true cardLevel: required: - name type: object description: Information about the card category. properties: name: type: string description: Card category name (e.g. standard, gold, premium). example: premium nullable: true excludedBinsRanges: type: number description: Range of card bins excluded from application of this rule. nullable: true AffiliationResponse: type: object description: Affiliation by ID response body information. required: - id - implementation - name - configuration - isdelivered - isConfigured properties: id: type: string description: Provider identification. implementation: type: string description: Provider implementation class name. name: type: string description: Provider name. configuration: type: array description: Array containing provider configuration information. items: type: object description: Provider configuration information. required: - name - value - valueKey properties: name: type: string description: Configuration parameter name. value: type: string description: Configuration parameter value. valueKey: type: string description: Value key information. nullable: true isdelivered: type: boolean description: Indicates whether the provider is published and available for use. example: true isConfigured: type: boolean description: Indicates whether the provider is configured. example: true Issuer: required: - name type: object description: Card issuer information. properties: name: type: string description: Card issuer name. example: barclays nullable: true WaitingTime: type: object description: Object containing the days after order cancelation by a seller. required: - waitingTime properties: waitingTime: type: integer description: Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order. Connector: required: - implementation - affiliationId type: object description: Connector (payment provider) information. nullable: true properties: implementation: type: string description: Connector (payment provider) implementation class name. example: Vtex.PaymentGateway.Connectors.CieloV3Connector affiliationId: type: string description: Affiliation connector (payment provider) identification. example: 0a8488e6-0c30-4150-be96-b0dcaaa6a0cd Validator: required: - regex - mask - cardCodeMask - cardCodeRegex - weights - useCvv - useExpirationDate - useCardHolderName - useBillingAddress - validCardLengths type: object description: Validator information. properties: regex: type: string description: '[Regex](https://regexr.com/) information.' nullable: true mask: type: string description: Validator mask. nullable: true cardCodeMask: type: string description: Card code regular mask. nullable: true cardCodeRegex: type: string description: Card code regular expression. nullable: true weights: type: array description: Array containing weigths information. items: type: integer description: Weigths information. nullable: true useCvv: type: boolean description: Indicates whether it is necessary to use the CVV code to complete a transaction with payment made by card. useExpirationDate: type: boolean description: Indicates whether it is necessary to use the expiration date to complete a card payment transaction. useCardHolderName: type: boolean description: Indicates whether it is necessary to use the card holder name to complete a payment transaction made by card. useBillingAddress: type: boolean description: Indicates whether it is necessary to use the billing address to complete a card payment transaction. validCardLengths: type: string description: Information about valid card lengths. nullable: true UpdateAffiliationRequest: type: object description: Update affiliation by ID request body information. required: - id - implementation - name - configuration - isdelivered - isConfigured properties: id: type: string description: Provider identification. example: fg8b4ea5-0b24-47dc-971e-2f6635ea1f14 implementation: type: string description: Provider implementation class name. example: Vtex.PaymentGateway.Connectors.CieloV3Connector name: type: string description: Provider name. example: CieloV3 - Test configuration: type: array description: Array containing provider configuration information. items: type: object description: Provider configuration information. required: - name - value - valueKey properties: name: type: string description: Configuration parameter name. example: MerchantId value: type: string description: Configuration parameter value. example: sampleData valueKey: type: string description: Value key information. example: valuekey_1 nullable: true isdelivered: type: boolean description: Indicates whether the provider is published and available for use. example: true isConfigured: type: boolean description: Indicates whether the provider is configured. example: true example: id: fg8b4ea5-0b24-47dc-971e-2f6635ea1f14 implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector name: CieloV3 - Test configuration: - name: HowTo value: https://developercielo.github.io/payment-method-enablement/ valueKey: null - name: MerchantId value: sampleData valueKey: null - name: MerchantKey value: '**********' valueKey: null - name: softDescriptor value: teste valueKey: null - name: bankInvoiceProvider value: Disabled valueKey: null - name: bankIDebitProvider value: Disabled valueKey: null - name: useEarlySecurityCapture value: '0' valueKey: null - name: isProduction value: 'false' valueKey: null - name: bankDebitProvider value: Disabled valueKey: null - name: Registered value: 'false' valueKey: null isdelivered: true isConfigured: true GetRulesResponse: required: - id - name - salesChannels - paymentSystem - connector - issuer - antifraud - installmentOptions - isSelfAuthorized - requiresAuthentication - enabled - installmentsService - isDefault - beginDate - endDate - condition - multiMerchantList - country - dateIntervals type: array description: Array containing payment rules information. items: type: object description: Payment rules information. properties: id: type: string description: Rule identification. example: 9e11ed95-4b7f-4445-a53e-2512f260ff1c name: type: string description: Rule name. example: American Express salesChannels: $ref: '#/components/schemas/SalesChannel' paymentSystem: $ref: '#/components/schemas/PaymentSystem' connector: $ref: '#/components/schemas/Connector' issuer: $ref: '#/components/schemas/Issuer' antifraud: $ref: '#/components/schemas/Antifraud' installmentOptions: required: - dueDateType - interestRateMethod - minimumInstallmentValue - installments type: object description: Installment options information. nullable: true properties: dueDateType: type: number description: Indicates whether the billing date will be at the end (0) or beginning of the period (1). enum: - 0 - 1 interestRateMethod: type: number description: Indicates the type of interest to calculate the value of the installments (Compound Interest = `null` or `0`, Simple Interest Rate with Tax = `1` and Single Interest = `2`). enum: - null - 0 - 1 - 2 nullable: true minimumInstallmentValue: type: number description: Minimum value of each installment. installments: type: array description: Array containing installments information. items: required: - ruleId - quantity - value - interestRate - isExternalInstallmentService - interestTax type: object description: Installments information. properties: ruleId: type: string description: Rule identification. example: fe6c470b-f80b-4bb1-a75c-378617f8767a nullable: true quantity: type: integer description: Number of installments. example: 1 value: type: number description: Value of each installment. interestRate: type: number description: Interest rate (percent 0.1 = 10%). isExternalInstallmentService: type: number description: Indicates the external installment system (if applicable). nullable: true interestTax: type: number description: Interest tax (percent 0.1 = 10%). nullable: true isSelfAuthorized: type: boolean description: Indicates whether the payment is automatically authorized. example: true nullable: true requiresAuthentication: type: boolean description: Indicates whether it is necessary to log in to make the payment. example: true nullable: true enabled: type: boolean description: Indicates whether the rule is enabled in the store. example: true installmentsService: type: boolean description: Indicates whether any specific type of installment service is used. example: false isDefault: type: boolean description: Indicates whether this rule should be considered the default for a given payment condition. example: false nullable: true beginDate: type: string description: Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable. example: '2023-12-10T17:00:00Z' nullable: true endDate: type: string description: Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable. example: '2023-12-12T17:00:00Z' nullable: true condition: required: - id - pullRate - name type: object description: Commercial condition information. nullable: true properties: id: type: string description: Commercial condition identification. example: '1' pullRate: type: number description: Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated. example: 0 name: type: string description: Commercial condition information. example: Commercial_condition_1 nullable: true multiMerchantList: type: array description: Indicates the names of the accounts to which the rule is being applied exclusively. items: type: string description: Account names. example: test_store_1 nullable: true country: required: - name - isoCode type: object description: Information about rule application in a country. nullable: true properties: name: type: string description: Country name. example: Brazil nullable: true isoCode: type: string description: Country code (ISO 3166 alpha-2). example: BRA dateIntervals: type: array description: Array containing information about the periods (days and hours) in which the rule is enabled. nullable: true items: required: - start - end type: object description: Rule enablement period information. properties: start: type: string description: Time, days of the week, and GMT time zone in which the rule is activated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron). example: '* * 11 * * 1,3,4 * -0300' end: type: string description: Time, days of the week and GMT time zone in which the rule is deactivated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron). example: '* * 18 * * 1,3,4 * -0300' externalInterest: type: boolean description: Indicates whether interest can be calculated externally. example: false minimumValue: type: number description: Minimum payment transaction amount for the rule to be applied. nullable: true deadlines: type: array description: Array containing information about the payment deadlines (applicable for credit payment method). items: type: object description: Payment deadlines information. required: - paymentOptions properties: paymentOptions: type: array description: Array containing payment options information. items: required: - days - interestRate type: object description: Payment options information. properties: days: type: number description: Deadline in days to make payment. example: 30 interestRate: type: number description: Interest rate applied (in percentage, e.g. `3.0` means 3%). example: 0 cobrand: required: - name type: object description: Information about the cobranded card. properties: name: type: string description: Card name. example: Cobrand_Test nullable: true cardLevel: required: - name type: object description: Information about the card category. properties: name: type: string description: Card category name (e.g. standard, gold, premium). example: premium nullable: true excludedBinsRanges: type: number description: Range of card bins excluded from application of this rule. nullable: true UpdateorderFormconfigurationRequest: required: - paymentConfiguration - taxConfiguration - minimumQuantityAccumulatedForItems - decimalDigitsPrecision - minimumValueAccumulated - apps - allowMultipleDeliveries - allowManualPrice type: object properties: paymentConfiguration: $ref: '#/components/schemas/PaymentConfiguration' taxConfiguration: type: object description: External tax service configuration. nullable: true properties: url: type: string nullable: true description: Endpoint URL. authorizationHeader: type: string description: Authorization header. nullable: true appId: type: string description: Custom data ID sent to the tax system. example: '12345' isMarketplaceResponsibleForTaxes: description: Indicates whether the marketplace is responsible for the products taxes. minimumQuantityAccumulatedForItems: type: integer format: int32 description: Minimum SKU quantity by cart. decimalDigitsPrecision: type: integer format: int32 description: Number of price digits. minimumValueAccumulated: type: integer nullable: true description: Minimum cart value. apps: type: array nullable: true description: Array of objects containing Apps configuration information. items: type: object description: App configuration information. properties: id: type: string description: App ID. example: birthdayApp fields: type: array description: Array of fields available to the app. items: type: string example: birthdayField description: Available field. major: type: integer description: App major version. example: 1 allowMultipleDeliveries: type: boolean nullable: true description: On the same purchase, allows the selection of items from multiple delivery channels. allowManualPrice: type: boolean nullable: true description: Allows the editing of SKU prices right in the cart. maxNumberOfWhiteLabelSellers: type: integer description: Allows the input of a limit of white label sellers involved on the cart. maskFirstPurchaseData: type: boolean description: Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data. maskStateOnAddress: type: boolean description: If the response body is masked, on a first purchase, this flag causes the state (UF) to be masked. The default behavior is to be masked. default: true recaptchaValidation: type: string nullable: true description: "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP)\r\n\r\nPossible values are:\r\n\r\n- `\"never\"`: no purchases are validated with reCAPTCHA.\r\n- `null`: no purchases are validated with reCAPTCHA. The same as `never`.\r\n- `\"always\"`: every purchase is validated with reCAPTCHA.\r\n- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX’s algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option." example: vtexCriteria requiresLoginToPlaceOrder: type: boolean description: Indicates whether authentication is required for completing purchases. minimumPurchaseDowntimeSeconds: type: integer description: Minimum interval (in seconds) between successive purchases. cartAgeToUseNewCardSeconds: type: integer description: Minimum cart existence period (in seconds) before allowing the use of a new credit card. paymentSystemToCheckFirstInstallment: type: string description: 'If you want to apply a first installment discount to a particular payment system, set this field to that payment system''s ID. Learn more: [Configuring a discount for orders prepaid in full](https://help.vtex.com/en/tutorial/configurar-desconto-de-preco-a-vista--7Lfcj9Wb5dpYfA2gKkACIt).' example: '6' example: paymentConfiguration: requiresAuthenticationForPreAuthorizedPaymentOption: false taxConfiguration: null minimumQuantityAccumulatedForItems: 1 decimalDigitsPrecision: 2 minimumValueAccumulated: null apps: null allowMultipleDeliveries: null allowManualPrice: null InsertRuleRequest: required: - name - salesChannels - paymentSystem - connector - issuer - antifraud - installmentOptions - isSelfAuthorized - requiresAuthentication - enabled - installmentsService - isDefault - beginDate - endDate - condition - multiMerchantList - country - dateIntervals type: object description: New payment rule request body information. properties: name: type: string description: Rule name. example: Test_API_2 salesChannels: $ref: '#/components/schemas/SalesChannel' paymentSystem: $ref: '#/components/schemas/PaymentSystem' connector: $ref: '#/components/schemas/Connector' issuer: $ref: '#/components/schemas/Issuer' antifraud: $ref: '#/components/schemas/Antifraud' installmentOptions: required: - dueDateType - interestRateMethod - minimumInstallmentValue - installments type: object description: Installment options information. nullable: true properties: dueDateType: type: number description: Indicates whether the billing date will be at the end (0) or beginning of the period (1). enum: - 0 - 1 interestRateMethod: type: number description: Indicates the type of interest to calculate the value of the installments (Compound Interest = `null` or `0`, Simple Interest Rate with Tax = `1` and Single Interest = `2`). enum: - null - 0 - 1 - 2 nullable: true minimumInstallmentValue: type: number description: Minimum value of each installment. installments: type: array description: Array containing installments information. items: required: - ruleId - quantity - value - interestRate - isExternalInstallmentService - interestTax type: object description: Installments information. properties: ruleId: type: string description: Rule identification. example: fe6c470b-f80b-4bb1-a75c-378617f8767a nullable: true quantity: type: integer description: Number of installments. example: 1 value: type: number description: Value of each installment. interestRate: type: number description: Interest rate (percent 0.1 = 10%). isExternalInstallmentService: type: number description: Indicates the external installment system (if applicable). nullable: true interestTax: type: number description: Interest tax (percent 0.1 = 10%). nullable: true isSelfAuthorized: type: boolean description: Indicates whether the payment is automatically authorized. example: true nullable: true requiresAuthentication: type: boolean description: Indicates whether it is necessary to log in to make the payment. example: true nullable: true enabled: type: boolean description: Indicates whether the rule is enabled in the store. example: false installmentsService: type: boolean description: Indicates whether any specific type of installment service is used. example: false isDefault: type: boolean description: Indicates whether this rule should be considered the default for a given payment condition. example: false nullable: true beginDate: type: string description: Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable. example: '2023-12-10T17:00:00Z' nullable: true endDate: type: string description: Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable. example: '2023-12-12T17:00:00Z' nullable: true condition: required: - id - pullRate - name type: object description: Commercial condition information. nullable: true properties: id: type: string description: Commercial condition identification. example: '1' pullRate: type: number description: Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated. example: 0 name: type: string description: Commercial condition information. example: Commercial_condition_1 nullable: true multiMerchantList: type: array description: Indicates the names of the accounts to which the rule is being applied exclusively. items: type: string description: Account names. example: test_store_1 nullable: true country: required: - name - isoCode type: object description: Information about rule application in a country. nullable: true properties: name: type: string description: Country name. example: Brazil nullable: true isoCode: type: string description: Country code (ISO 3166 alpha-2). example: BRA dateIntervals: type: array description: Array containing information about the periods (days and hours) in which the rule is enabled. nullable: true items: required: - start - end type: object description: Rule enablement period information. properties: start: type: string description: Time, days of the week, and GMT time zone in which the rule is activated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron). example: '* * 11 * * 1,3,4 * -0300' end: type: string description: Time, days of the week and GMT time zone in which the rule is deactivated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron). example: '* * 18 * * 1,3,4 * -0300' externalInterest: type: boolean description: Indicates whether interest can be calculated externally. example: false minimumValue: type: number description: Minimum payment transaction amount for the rule to be applied. nullable: true deadlines: type: array description: Array containing information about the payment deadlines (applicable for credit payment method). items: type: object description: Payment deadlines information. required: - paymentOptions properties: paymentOptions: type: array description: Array containing payment options information. items: required: - days - interestRate type: object description: Payment options information. properties: days: type: number description: Deadline in days to make payment. example: 30 interestRate: type: number description: Interest rate applied (in percentage, e.g. `3.0` means 3%). example: 0 cobrand: required: - name type: object description: Information about the cobranded card. properties: name: type: string description: Card name. example: Cobrand_Test nullable: true cardLevel: required: - name type: object description: Information about the card category. properties: name: type: string description: Card category name (e.g. standard, gold, premium). example: premium nullable: true excludedBinsRanges: type: number description: Range of card bins excluded from application of this rule. nullable: true PaymentSystemsResponse: required: - id - name - requiresDocument - implementation - connectorImplementation - antifraudConnectorImplementation - groupName - redirect - isCustom - isSelfAuthorized - requiresAuthentication - allowInstallments - allowBinExclusion - allowMultiple - allowIssuer - allowCountry - allowCommercialPolicy - allowCommercialCondition - allowPeriod - isAvailable - description - supportRecurrence - validator - appDependencies - displayDocument - dueDate - allowNotification - affiliationId - availablePayments - dueDateMinutes type: object description: Available payment methods response body information. properties: id: type: number description: Payment method identification. name: type: string description: Payment method name. requiresDocument: type: boolean description: Indicates whether a document is required. implementation: type: string description: Payment method implementation class name. connectorImplementation: type: string description: Connector (payment provider) implementation class name. antifraudConnectorImplementation: type: string description: Connector (anti-fraud provider) implementation class name. nullable: true groupName: type: string description: Payment group name. redirect: type: boolean description: Indicates whether the payment method allows redirection. isCustom: type: boolean description: Indicates whether it is custom. isSelfAuthorized: type: boolean description: Indicates whether the payment is automatically authorized. requiresAuthentication: type: boolean description: Indicates whether it is necessary to log in to make the payment. allowInstallments: type: boolean description: Indicates whether the payment method allows installments. allowBinExclusion: type: boolean description: Indicates whether it is possible to restrict the use of specific BIN codes (only applicable for cards). allowMultiple: type: boolean description: 'Indicates whether the method allows multiple payments. Example of `false`: debit card.' allowIssuer: type: boolean description: Indicates whether it is possible to identify the name of the bank responsible for issuing the card. allowCountry: type: boolean description: Indicates whether it is possible to restrict a payment rule by the country where the purchase is made. allowCommercialPolicy: type: boolean description: Indicates whether to restrict a payment rule by commercial policy type. allowCommercialCondition: type: boolean description: Indicates whether to restrict a payment rule by commercial condition type. allowPeriod: type: boolean description: Indicates whether it is possible to restrict a period for making the payment. isAvailable: type: boolean description: Indicates whether the payment method is available for use. description: type: string description: Description of the payment method. nullable: true supportRecurrence: type: boolean description: Indicates whether the payment method supports recurrence. validator: $ref: '#/components/schemas/Validator' appDependencies: type: string description: App dependencies information. nullable: true displayDocument: type: boolean description: Indicates whether a document is shown. dueDate: type: string description: Payment due date. allowNotification: type: boolean description: Indicates the possibility of payment notification (used by bank invoices and notes payable). affiliationId: type: string description: Affiliation connector (payment provider) identification. nullable: true availablePayments: type: string description: Information about payment availability. nullable: true dueDateMinutes: type: number description: Amount of time (in minutes) until the payment date (`dueDate`). PaymentSystem: required: - id - name - implementation type: object description: Payment system information. properties: id: type: number description: Payment system identification. example: 1 name: type: string description: Payment system name. example: CieloV3 - Test implementation: type: string description: Payment system implementation class name. example: Vtex.PaymentGateway.Connectors.CieloV3Connector nullable: true InsertAffiliationRequest: type: object description: Insert new affiliation request body information. required: - implementation - name - configuration - isdelivered - isConfigured properties: implementation: type: string description: Provider implementation class name. example: Vtex.PaymentGateway.Connectors.CieloV3Connector name: type: string description: Provider name. example: CieloV3 - Test configuration: type: array description: Array containing provider configuration information. items: type: object description: Provider configuration information. required: - name - value properties: name: type: string description: Configuration parameter name. example: MerchantId value: type: string description: Configuration parameter value. example: sampleData isdelivered: type: boolean description: Indicates whether the provider is published and available for use. example: true isConfigured: type: boolean description: Indicates whether the provider is configured. example: true example: implementation: Vtex.PaymentGateway.Connectors.CieloV3Connector name: CieloV3 - Test configuration: - name: HowTo value: https://developercielo.github.io/payment-method-enablement/ - name: MerchantId value: sampleData - name: MerchantKey value: '**********' - name: softDescriptor value: teste - name: bankInvoiceProvider value: Disabled - name: bankIDebitProvider value: Disabled - name: useEarlySecurityCapture value: '0' - name: isProduction value: 'false' - name: bankDebitProvider value: Disabled - name: Registered value: 'false' isdelivered: true isConfigured: true SalesChannel: type: array description: Array containing information about the Sales channel. items: type: object description: Sales channel information. required: - id properties: id: type: string description: Sales channel identification. example: '1' parameters: 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 default: application/json ruleId: name: ruleId in: path description: Rule identification. required: true style: simple schema: type: string example: fe6c470b-f80b-4bb1-a75c-378617f8767a Content-Type: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json affiliationId: name: affiliationId in: path description: Affiliation (payment or anti-fraud provider) identification. required: true style: simple schema: type: string example: e046d326-5421-45ab-95ae-f13d37f260b5 Accept_2: 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 Content-Type_2: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string example: application/json 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.'