v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Model

Create org rule model

Create a rule model at the organizational level for a processing code. A rule model swaps one processing code for another if certain conditions are met. For example, you may want to use a custom processing code if the merchant is Apple.

Rule models cannot be shared between organizations.

Refer to Processing codes for more information on processing codes and rule models.

Call the following to attach a rule model to an organization, program, or account.

post/v1/models

Request body

namestring

Model name

Example request

{
  "rules": [
    {
      "cardId": 6743052,
      "rulePriority": 1,
      "scope": {
        "controlType": "TCT_AUTO_PAY",
        "cardHolderBillAmount": {
          "maxAmount": 20.5,
          "minAmount": 10.5
        },
        "timeRange": {
          "startTime": "2025-05-13T23:30:52.123Z",
          "endTime": "2025-05-13T23:30:52.123Z"
        }
      },
      "definedBy": "CARDHOLDER",
      "ruleId": "v-301-b0c3dfae-0dd7-40b6-9272-5fa466804a8a"
    }
  ],
  "name": "Model name"
}

Response

Created

idstring

Model ID

namestring

Rules group name

Example response

{
  "id": "b3f53d8f-6812-4869-b17a-874d78750cc6",
  "name": "Model name"
}