--- title: "Get payment rule by ID" method: GET path: "/api/pvt/rules/{ruleId}" tags: ["Configuration"] --- # Get payment rule by ID `GET /api/pvt/rules/{ruleId}` Returns data for a specific payment rule applied to the payment providers configured in your store. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | PCI Gateway | Payment-Make Payments | **View Payment Data** | There 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). >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations. ## Path parameters - `ruleId` string, required ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - RulesRequest — Payment rules information. - `id` string, required — Rule identification. - `name` string, required — Rule name. - `salesChannels` object[], required — Array containing information about the Sales channel. - `id` string, required — Sales channel identification. - `paymentSystem` PaymentSystem, required — Payment system information. - `id` number, required — Payment system identification. - `name` string, required — Payment system name. - `implementation` string, nullable, required — Payment system implementation class name. - `connector` Connector, nullable, required — Connector (payment provider) information. - `implementation` string, required — Connector (payment provider) implementation class name. - `affiliationId` string, required — Affiliation connector (payment provider) identification. - `issuer` Issuer, required — Card issuer information. - `name` string, nullable, required — Card issuer name. - `antifraud` Antifraud, nullable, required — Anti-fraud information. - `implementation` string, nullable, required — Connector (anti-fraud provider) implementation class name. - `affiliationId` string, nullable, required — Affiliation connector (anti-fraud provider) identification. - `installmentOptions` object, nullable, required — Installment options information. - `dueDateType` 0 | 1, required — Indicates whether the billing date will be at the end (0) or beginning of the period (1). - `interestRateMethod` null | 0 | 1 | 2, nullable, required — 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`). - `minimumInstallmentValue` number, required — Minimum value of each installment. - `installments` object[], required — Array containing installments information. - `ruleId` string, nullable, required — Rule identification. - `quantity` integer, required — Number of installments. - `value` number, required — Value of each installment. - `interestRate` number, required — Interest rate (percent 0.1 = 10%). - `isExternalInstallmentService` number, nullable, required — Indicates the external installment system (if applicable). - `interestTax` number, nullable, required — Interest tax (percent 0.1 = 10%). - `isSelfAuthorized` boolean, nullable, required — Indicates whether the payment is automatically authorized. - `requiresAuthentication` boolean, nullable, required — Indicates whether it is necessary to log in to make the payment. - `enabled` boolean, required — Indicates whether the rule is enabled in the store. - `installmentsService` boolean, required — Indicates whether any specific type of installment service is used. - `isDefault` boolean, nullable, required — Indicates whether this rule should be considered the default for a given payment condition. - `beginDate` string, nullable, required — 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. - `endDate` string, nullable, required — 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. - `condition` object, nullable, required — Commercial condition information. - `id` string, required — Commercial condition identification. - `pullRate` number, required — Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated. - `name` string, nullable, required — Commercial condition information. - `multiMerchantList` string[], nullable, required — Indicates the names of the accounts to which the rule is being applied exclusively. - `country` object, nullable, required — Information about rule application in a country. - `name` string, nullable, required — Country name. - `isoCode` string, required — Country code (ISO 3166 alpha-2). - `dateIntervals` object[], nullable, required — Array containing information about the periods (days and hours) in which the rule is enabled. - `start` string, required — 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). - `end` string, required — 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). - `externalInterest` boolean — Indicates whether interest can be calculated externally. - `minimumValue` number, nullable — Minimum payment transaction amount for the rule to be applied. - `deadlines` object[] — Array containing information about the payment deadlines (applicable for credit payment method). - `paymentOptions` object[], required — Array containing payment options information. - `days` number, required — Deadline in days to make payment. - `interestRate` number, required — Interest rate applied (in percentage, e.g. `3.0` means 3%). - `cobrand` object — Information about the cobranded card. - `name` string, nullable, required — Card name. - `cardLevel` object — Information about the card category. - `name` string, nullable, required — Card category name (e.g. standard, gold, premium). - `excludedBinsRanges` number, nullable — Range of card bins excluded from application of this rule. ## Changes - **2024-06-10** `aca4931fa22b` — 2 info - the endpoint scheme security `VtexIdclientAutCookie` was added to the API - the endpoint scheme security `appKey AND appToken` was added to the API - **2024-02-01** `e0f0940dcde8` — 2 breaking - the `deadlines/items/` response's property type/format changed from ``/`` to `object`/`` for status `200` - the `salesChannels/items/` response's property type/format changed from ``/`` to `object`/`` for status `200` - **2024-01-16** `660227ebd7e8` — 1 breaking - the response property `installmentOptions/installments/items/interestTax` became nullable for the status `200` - **2024-01-16** `6ca16ae78f1b` — 1 breaking - the response property `dateIntervals` became nullable for the status `200` - **2024-01-16** `7d66c05ad76f` — 1 breaking - the response property `country` became nullable for the status `200` [Full history](https://skmtc.dev/vtex/apis/payments-gateway-api/changes/api/pvt/rules/:ruleId/get.md) --- [API](https://skmtc.dev/vtex/apis/payments-gateway-api.md) · [All operations](https://skmtc.dev/vtex/apis/payments-gateway-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/payments-gateway-api/revisions/c1c6fd255d0e/schema)