Adyen · Schema

TransactionRuleRestrictions

PaymentsFinancial ServicesFintech

Properties

Name Type Description
activeNetworkTokens object The total number of tokens that a card can have across different kinds of digital wallets on the user's phones, watches, or other wearables. Supported operations: **equals**, **notEquals**, **greaterT
brandVariants object List of card brand variants and the operation. Supported operations: **anyMatch**, **noneMatch**.
counterpartyBank object List of counterparty Institutions and the operation. Supported operations: **anyMatch**, **noneMatch**.
countries object List of countries and the operation. Supported operations: **anyMatch**, **noneMatch**.
dayOfWeek object List of week days and the operation. Supported operations: **anyMatch**, **noneMatch**.
differentCurrencies object Compares the currency of the payment against the currency of the payment instrument, and specifies the operation. Supported operations: **equals**, **notEquals**.
entryModes object List of point-of-sale entry modes and the operation.. Supported operations: **anyMatch**, **noneMatch**.
internationalTransaction object Indicates whether transaction is an international transaction and specifies the operation. Supported operations: **equals**, **notEquals**.
matchingTransactions object The number of transactions and the operation. Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.
mccs object List of merchant category codes (MCCs) and the operation. Supported operations: **anyMatch**, **noneMatch**.
merchantNames object List of names that will be compared to the merchant name according to the matching type. Supported operations: **anyMatch**, **noneMatch**.
merchants object List of merchant ID and acquirer ID pairs, and the operation. Supported operations: **anyMatch**, **noneMatch**.
processingTypes object List of processing types and the operation. Supported operations: **anyMatch**, **noneMatch**.
sameAmountRestriction object Checks if a user has recently sent the same amount of funds in multiple transfers. To use this restriction, you must: - Set the rule `type` to **velocity**. - Specify a time `interval`. - Specify a nu
sameCounterpartyRestriction object Checks if a user has recently made multiple transfers to the same counterparty. To use this restriction, you must: - Set the rule `type` to **velocity**. - Specify a time `interval`. - Specify a numbe
timeOfDay object A start and end time in a time-only ISO-8601 extended offset format. Supported operations: **equals**, **notEquals**.
totalAmount object The total amount and the operation. Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.
View JSON Schema on GitHub

JSON Schema

adyen-transactionrulerestrictions-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransactionRuleRestrictions",
  "title": "TransactionRuleRestrictions",
  "properties": {
    "activeNetworkTokens": {
      "description": "The total number of tokens that a card can have across different kinds of digital wallets on the user's phones, watches, or other wearables.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.",
      "$ref": "#/components/schemas/ActiveNetworkTokensRestriction"
    },
    "brandVariants": {
      "description": "List of card brand variants and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/BrandVariantsRestriction"
    },
    "counterpartyBank": {
      "description": "List of counterparty Institutions and the operation. Supported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/CounterpartyBankRestriction"
    },
    "countries": {
      "description": "List of countries and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/CountriesRestriction"
    },
    "dayOfWeek": {
      "description": "List of week days and the operation. Supported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/DayOfWeekRestriction"
    },
    "differentCurrencies": {
      "description": "Compares the currency of the payment against the currency of the payment instrument, and specifies the operation.\n\nSupported operations: **equals**, **notEquals**.",
      "$ref": "#/components/schemas/DifferentCurrenciesRestriction"
    },
    "entryModes": {
      "description": "List of point-of-sale entry modes and the operation..\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/EntryModesRestriction"
    },
    "internationalTransaction": {
      "description": "Indicates whether transaction is an international transaction and specifies the operation.\n\nSupported operations: **equals**, **notEquals**.",
      "$ref": "#/components/schemas/InternationalTransactionRestriction"
    },
    "matchingTransactions": {
      "description": "The number of transactions and the operation.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.",
      "$ref": "#/components/schemas/MatchingTransactionsRestriction"
    },
    "mccs": {
      "description": "List of merchant category codes (MCCs) and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/MccsRestriction"
    },
    "merchantNames": {
      "description": "List of names that will be compared to the merchant name according to the matching type.\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/MerchantNamesRestriction"
    },
    "merchants": {
      "description": "List of merchant ID and acquirer ID pairs, and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/MerchantsRestriction"
    },
    "processingTypes": {
      "description": "List of processing types and the operation.\n\nSupported operations: **anyMatch**, **noneMatch**.",
      "$ref": "#/components/schemas/ProcessingTypesRestriction"
    },
    "sameAmountRestriction": {
      "description": "Checks if a user has recently sent the same amount of funds in multiple transfers.\n\nTo use this restriction, you must:\n\n- Set the rule `type` to **velocity**.\n\n- Specify a time `interval`.\n\n- Specify a number of `matchingTransactions`.\n\nSupported operation: **equals**.",
      "$ref": "#/components/schemas/SameAmountRestriction"
    },
    "sameCounterpartyRestriction": {
      "description": "Checks if a user has recently made multiple transfers to the same counterparty.\n\nTo use this restriction, you must:\n\n- Set the rule `type` to **velocity**.\n\n- Specify a time `interval`.\n\n- Specify a number of `matchingTransactions`.\n\nSupported operations: **equals**.",
      "$ref": "#/components/schemas/SameCounterpartyRestriction"
    },
    "timeOfDay": {
      "description": "A start and end time in a time-only ISO-8601 extended offset format. Supported operations: **equals**, **notEquals**.",
      "$ref": "#/components/schemas/TimeOfDayRestriction"
    },
    "totalAmount": {
      "description": "The total amount and the operation.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.",
      "$ref": "#/components/schemas/TotalAmountRestriction"
    }
  },
  "type": "object"
}