Configuration

Get payment rule by ID

Returns data for a specific payment rule applied to the payment providers configured in your store.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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 for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/pvt/rules/{ruleId}

Path parameters

ruleIdstring required

Example:fe6c470b-f80b-4bb1-a75c-378617f8767a

Rule identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

idstring required

Rule identification.

namestring required

Rule name.

isSelfAuthorizedboolean nullable required

Indicates whether the payment is automatically authorized.

requiresAuthenticationboolean nullable required

Indicates whether it is necessary to log in to make the payment.

enabledboolean required

Indicates whether the rule is enabled in the store.

installmentsServiceboolean required

Indicates whether any specific type of installment service is used.

isDefaultboolean nullable required

Indicates whether this rule should be considered the default for a given payment condition.

beginDatestring nullable required

Rule start date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.fff), if applicable.

endDatestring nullable required

Rule end date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.fff), if applicable.

multiMerchantListstring[] nullable required

Indicates the names of the accounts to which the rule is being applied exclusively.

externalInterestboolean

Indicates whether interest can be calculated externally.

minimumValuenumber nullable

Minimum payment transaction amount for the rule to be applied.

excludedBinsRangesnumber nullable

Range of card bins excluded from application of this rule.

Example response

{
  "paymentSystem": {
    "id": 1
  },
  "deadlines": [
    {
      "paymentOptions": [
        {
          "days": 30
        }
      ]
    }
  ]
}

Changes

Changed in 9 of the 52 revisions of this API.142

Jun 10, 2024aca4931fa22b2See the full diff
- ○
  the endpoint scheme security VtexIdclientAutCookie was added to the API
  api-security-added
- ○
  the endpoint scheme security appKey AND appToken was added to the API
  api-security-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 1, 2024e0f0940dcde82See the full diff
- ▲
  the deadlines/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the salesChannels/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
Jan 16, 2024660227ebd7e81See the full diff
- ▲
  the response property installmentOptions/installments/items/interestTax became nullable for the status 200
  response-property-became-nullable
Jan 16, 20246ca16ae78f1b1See the full diff
- ▲
  the response property dateIntervals became nullable for the status 200
  response-property-became-nullable
Jan 16, 20247d66c05ad76f1See the full diff
- ▲
  the response property country became nullable for the status 200
  response-property-became-nullable
Jan 16, 2024f750e06823162See the full diff
- ▲
  the response property condition became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property connector became nullable for the status 200
  response-property-became-nullable
Jan 16, 202453d1d43f6fa81See the full diff
- ▲
  the paymentSystem/id response's property type/format changed from string/ to number/ for status 200
  response-property-type-changed
Jan 16, 2024a38afb87a11b3See the full diff
- ▲
  the response property antifraud became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property installmentOptions/installments/items/ruleId became nullable for the status 200
  response-property-became-nullable
- ▲
  the paymentSystem/id response's property type/format changed from number/ to string/ for status 200
  response-property-type-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 16, 2024e6bea95b9c183See the full diff
- ▲
  the response's body type/format changed from array/ to object/ for status 200
  response-body-type-changed
- ▲
  the country/isoCode response's property type/format changed from number/ to string/ for status 200
  response-property-type-changed
- ▲
  the dateIntervals/items/end response's property type/format changed from number/ to string/ for status 200
  response-property-type-changed

Full history