Insert a new payment rule

Creates a new payment rule to be 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-ManageStore	Manage Store

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.

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.

Request body

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 request

{
  "name": "Test_API_2",
  "paymentSystem": {
    "id": 1
  },
  "installmentOptions": {
    "installments": [
      {
        "ruleId": "fe6c470b-f80b-4bb1-a75c-378617f8767a",
        "quantity": 1
      }
    ]
  },
  "isSelfAuthorized": true,
  "requiresAuthentication": true,
  "beginDate": "2023-12-10T17:00:00Z",
  "endDate": "2023-12-12T17:00:00Z",
  "condition": {
    "id": "1",
    "name": "Commercial_condition_1"
  },
  "multiMerchantList": [
    "test_store_1"
  ],
  "country": {
    "name": "Brazil",
    "isoCode": "BRA"
  },
  "dateIntervals": [
    {
      "start": "* * 11 * * 1,3,4 * -0300",
      "end": "* * 18 * * 1,3,4 * -0300"
    }
  ],
  "deadlines": [
    {
      "paymentOptions": [
        {
          "days": 30
        }
      ]
    }
  ],
  "cobrand": {
    "name": "Cobrand_Test"
  },
  "cardLevel": {
    "name": "premium"
  }
}

Response

OK

idstring required

Rule identification.