Adyen transactionRules API

The transactionRules API from Adyen — 2 operation(s) for transactionrules.

Documentation

📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
📖
Documentation
https://docs.adyen.com/api-explorer/Account/6/overview
📖
Documentation
https://docs.adyen.com/development-resources/webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/BalanceControl/1/overview
📖
Documentation
https://docs.adyen.com/api-explorer/BinLookup/52/overview
📖
Documentation
https://docs.adyen.com/api-explorer/Checkout/71/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform/2/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/development-resources/data-protection-api/
📖
Documentation
https://docs.adyen.com/risk-management/disputes-api
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/fund-transfer/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/legal-entity-management-api/
📖
Documentation
https://docs.adyen.com/api-explorer/Management/3/overview
📖
Documentation
https://docs.adyen.com/api-explorer/management-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/notifications
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/notifications/
📖
Documentation
https://docs.adyen.com/online-payments/
📖
Documentation
https://docs.adyen.com/online-payments/online-payouts
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/
📖
Documentation
https://docs.adyen.com/online-payments/tokenization
📖
Documentation
https://docs.adyen.com/api-explorer/report-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/payment-methods/gift-cards/stored-value-api/
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/
📖
Documentation
https://docs.adyen.com/development-resources/testing/create-test-cards
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions/transaction-webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts
📖
Documentation
https://docs.adyen.com/development-resources/webhooks

Specifications

Other Resources

OpenAPI Specification

adyen-transactionrules-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute transactionRules API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: transactionRules
paths:
  /transactionRules:
    post:
      tags:
      - transactionRules
      summary: Adyen Create a Transaction Rule
      description: Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples).
      x-addedInVersion: '1'
      operationId: post-transactionRules
      x-sortIndex: 1
      x-methodName: createTransactionRule
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              createTransactionRuleAllowPos:
                $ref: '#/components/examples/post-transactionRules-createTransactionRuleAllowPos'
              createTransactionRuleIncreaseScore:
                $ref: '#/components/examples/post-transactionRules-createTransactionRuleIncreaseScore'
              createTransactionRuleLimitSliding:
                $ref: '#/components/examples/post-transactionRules-createTransactionRuleLimitSliding'
              createTransactionRuleLimitTransaction:
                $ref: '#/components/examples/post-transactionRules-createTransactionRuleLimitTransaction'
            schema:
              $ref: '#/components/schemas/TransactionRuleInfo'
      responses:
        '200':
          content:
            application/json:
              examples:
                createTransactionRuleAllowPos:
                  $ref: '#/components/examples/post-transactionRules-createTransactionRuleAllowPos-200'
                createTransactionRuleIncreaseScore:
                  $ref: '#/components/examples/post-transactionRules-createTransactionRuleIncreaseScore-200'
                createTransactionRuleLimitSliding:
                  $ref: '#/components/examples/post-transactionRules-createTransactionRuleLimitSliding-200'
                createTransactionRuleLimitTransaction:
                  $ref: '#/components/examples/post-transactionRules-createTransactionRuleLimitTransaction-200'
              schema:
                $ref: '#/components/schemas/TransactionRule'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /transactionRules/{transactionRuleId}:
    delete:
      tags:
      - transactionRules
      summary: Adyen Delete a Transaction Rule
      description: Deletes a transaction rule.
      x-addedInVersion: '1'
      operationId: delete-transactionRules-transactionRuleId
      x-sortIndex: 5
      x-methodName: deleteTransactionRule
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the transaction rule.
        name: transactionRuleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/delete-transactionRules-transactionRuleId-success-200'
              schema:
                $ref: '#/components/schemas/TransactionRule'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      tags:
      - transactionRules
      summary: Adyen Get a Transaction Rule
      description: Returns the details of a transaction rule.
      x-addedInVersion: '1'
      operationId: get-transactionRules-transactionRuleId
      x-sortIndex: 2
      x-methodName: getTransactionRule
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the transaction rule.
        name: transactionRuleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-transactionRules-transactionRuleId-success-200'
              schema:
                $ref: '#/components/schemas/TransactionRuleResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - transactionRules
      summary: Adyen Update a Transaction Rule
      description: "Updates a transaction rule. \n\n* To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged.\n\n* When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource."
      x-addedInVersion: '1'
      operationId: patch-transactionRules-transactionRuleId
      x-sortIndex: 3
      x-methodName: updateTransactionRule
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              updateTransactionRuleStatus:
                $ref: '#/components/examples/patch-transactionRules-transactionRuleId-updateTransactionRuleStatus'
            schema:
              $ref: '#/components/schemas/TransactionRuleInfo'
      parameters:
      - description: The unique identifier of the transaction rule.
        name: transactionRuleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                updateTransactionRuleStatus:
                  $ref: '#/components/examples/patch-transactionRules-transactionRuleId-updateTransactionRuleStatus-200'
              schema:
                $ref: '#/components/schemas/TransactionRule'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    post-transactionRules-createTransactionRuleIncreaseScore:
      summary: Increase the score of a card
      description: Example request to increase the score of a card
      value:
        description: Assign score if more than 500 EUR in 2 hours
        entityKey:
          entityType: paymentInstrument
          entityReference: PI3227C223222B5FG88SB8BHR
        interval:
          type: sliding
          duration:
            value: 2
            unit: hours
        outcomeType: scoreBased
        reference: myRule11789
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 50000
        score: 20
        type: velocity
    generic-401:
      summary: Response code - 401 Unauthorized
      value:
        type: https://docs.adyen.com/errors/security/unauthorized
        title: Unauthorized
        status: 401
        detail: Not authorized to access this service.
        errorCode: '00_401'
    post-transactionRules-createTransactionRuleLimitTransaction-200:
      summary: Transaction rule for limiting international payments
      description: Example response to limit total amount of international transations
      value:
        description: Up to 50 EUR international transactions
        entityKey:
          entityReference: BA3227C223222B5FN65355NR3
          entityType: balanceAccount
        interval:
          timeOfDay: 00:00:00
          timeZone: UTC
          type: daily
        outcomeType: hardBlock
        reference: YOUR_REFERENCE_B2634
        requestType: authorization
        ruleRestrictions:
          internationalTransaction:
            operation: equals
            value: true
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 5000
        startDate: '2023-06-29T22:39:54.068487152+02:00'
        status: active
        type: velocity
        id: TR3227C223222H5J4DB2X9V65
    post-transactionRules-createTransactionRuleAllowPos:
      summary: Allow only point-of-sale transactions
      description: Example request to allow only point-of-sale transactions
      value:
        description: Allow only point-of-sale transactions
        reference: YOUR_REFERENCE_4F7346
        entityKey:
          entityType: paymentInstrument
          entityReference: PI3227C223222B5FG88SB8BHR
        status: active
        interval:
          type: perTransaction
        ruleRestrictions:
          processingTypes:
            operation: noneMatch
            value:
            - pos
        type: blockList
    patch-transactionRules-transactionRuleId-updateTransactionRuleStatus-200:
      summary: Transaction rule status updated
      description: Example response for successfully updating the status of a transaction rule
      value:
        aggregationLevel: paymentInstrument
        description: Up to 1000 EUR per card for the last 12 hours
        entityKey:
          entityReference: PG3227C223222C5GXR3M5592Q
          entityType: paymentInstrumentGroup
        interval:
          duration:
            unit: hours
            value: 12
          timeZone: UTC
          type: sliding
        outcomeType: hardBlock
        reference: YOUR_REFERENCE_2918A
        requestType: authorization
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 100000
        startDate: '2022-11-17T00:07:09.10057663+01:00'
        status: inactive
        type: velocity
        id: TR3227C223222C5GXR3XP596N
    post-transactionRules-createTransactionRuleIncreaseScore-200:
      summary: Transaction rule for increasing the score of a card
      description: Example response to increase the score of a card
      value:
        description: Assign score if more than 500 EUR in 2 hours
        entityKey:
          entityReference: PI3227C223222B5FG88SB8BHR
          entityType: paymentInstrument
        interval:
          duration:
            unit: hours
            value: 2
          timeZone: UTC
          type: sliding
        outcomeType: scoreBased
        reference: myRule11789
        requestType: authorization
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 50000
        score: 20
        status: inactive
        type: velocity
        id: TR3227C223222H5J4D9S39V59
    generic-400:
      summary: Response code - 400 Bad request
      value:
        type: https://docs.adyen.com/errors/general/bad-request
        title: Bad request
        status: 400
        detail: Empty input which would have resulted in a null result.
        errorCode: '00_400'
    post-transactionRules-createTransactionRuleLimitSliding:
      summary: Limit total amount in the last 12 hours
      description: Example request to limit the total amount in a sliding interval
      value:
        description: Up to 1000 EUR per card for the last 12 hours
        reference: YOUR_REFERENCE_2918A
        status: active
        entityKey:
          entityReference: BA3227C223222B5FN65355NR3
          entityType: balanceAccount
        aggregationLevel: paymentInstrument
        interval:
          type: sliding
          duration:
            value: 12
            unit: hours
        outcomeType: hardBlock
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              value: 100000
              currency: EUR
        type: velocity
    generic-422:
      summary: Response code - 422 Unprocessable Entity.
      value:
        type: https://docs.adyen.com/errors/general/invalid-field-value
        title: Invalid Payment Instrument information provided
        status: 422
        detail: The balanceAccountId can only be changed when the status is Inactive or Requested
        requestId: 1W1UI15PLVGC9V8O
        errorCode: '30_031'
    patch-transactionRules-transactionRuleId-updateTransactionRuleStatus:
      summary: Update the interval of transaction rule
      description: Example request for updating the interval of a transaction rule
      value:
        description: Allow only point-of-sale transactions
        reference: YOUR_REFERENCE_4F7346
        entityKey:
          entityType: paymentInstrument
          entityReference: PI3227C223222B5FG88SB8BHR
        status: inactive
        interval:
          type: weekly
        ruleRestrictions:
          processingTypes:
            operation: noneMatch
            value:
            - pos
        type: blockList
    generic-500:
      summary: Response code - 500 Internal Server Error
      value:
        type: https://docs.adyen.com/errors/general/internal
        title: An internal error happened
        status: 500
        detail: Unrecoverable error while trying to create payment instrument
        requestId: 1WAF555PLWNTLYOQ
        errorCode: '00_500'
    post-transactionRules-createTransactionRuleAllowPos-200:
      summary: Transaction rule to allow only point-of-sale transactions
      description: Example response for allowing only point-of-sale transactions
      value:
        description: Allow only point-of-sale transactions
        entityKey:
          entityReference: PI3227C223222B5FG88SB8BHR
          entityType: paymentInstrument
        interval:
          timeZone: UTC
          type: perTransaction
        outcomeType: hardBlock
        reference: YOUR_REFERENCE_4F7346
        requestType: authorization
        ruleRestrictions:
          processingTypes:
            operation: noneMatch
            value:
            - pos
        startDate: '2023-06-29T22:34:36.173226192+02:00'
        status: active
        type: blockList
        id: TR3227C223222H5J4D9ML9V4D
    get-transactionRules-transactionRuleId-success-200:
      summary: Transaction rules retrieved
      description: Example response when retrieving a transaction rule
      value:
        transactionRule:
          description: Only allow point-of-sale transactions
          entityKey:
            entityReference: PI3227C223222B5FN65FN5NS9
            entityType: paymentInstrument
          interval:
            timeZone: UTC
            type: perTransaction
          outcomeType: hardBlock
          reference: YOUR_REFERENCE_4F7346
          requestType: authorization
          ruleRestrictions:
            processingTypes:
              operation: noneMatch
              value:
              - pos
          startDate: '2022-08-02T16:07:00.851374+02:00'
          status: active
          type: blockList
          id: TR32272223222B5GFSGFLFCHM
    post-transactionRules-createTransactionRuleLimitSliding-200:
      summary: Transaction rule for limiting total amount in the last 12 hours
      description: Example response to limit the total amount in a sliding interval
      value:
        aggregationLevel: paymentInstrument
        description: Up to 1000 EUR per card for the last 12 hours
        entityKey:
          entityReference: BA3227C223222B5FN65355NR3
          entityType: balanceAccount
        interval:
          duration:
            unit: hours
            value: 12
          timeZone: UTC
          type: sliding
        outcomeType: hardBlock
        reference: YOUR_REFERENCE_2918A
        requestType: authorization
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 100000
        startDate: '2023-06-29T22:39:06.887628679+02:00'
        status: active
        type: velocity
        id: TR32272223222H5J4D9Z8C97H
    post-transactionRules-createTransactionRuleLimitTransaction:
      summary: Limit international payments
      description: Example request to limit total amount of international transations
      value:
        description: Up to 50 EUR international transactions
        reference: YOUR_REFERENCE_B2634
        status: active
        entityKey:
          entityType: balanceAccount
          entityReference: BA3227C223222B5FN65355NR3
        interval:
          type: daily
        outcomeType: hardBlock
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 5000
          internationalTransaction:
            operation: equals
            value: true
        type: velocity
    delete-transactionRules-transactionRuleId-success-200:
      summary: Transaction rule deleted
      description: Example response for successfully deleting a transaction rule
      value:
        aggregationLevel: paymentInstrument
        description: Up to 1000 EUR per card for the last 12 hours
        entityKey:
          entityReference: PG3227C223222C5GXR3M5592Q
          entityType: paymentInstrumentGroup
        interval:
          duration:
            unit: hours
            value: 12
          timeZone: UTC
          type: sliding
        outcomeType: hardBlock
        reference: myRule12345
        requestType: authorization
        ruleRestrictions:
          totalAmount:
            operation: greaterThan
            value:
              currency: EUR
              value: 100000
        type: velocity
        id: TR3227C223222C5GXT3DD5VCF
    generic-403:
      summary: Response code - 403 Forbidden.
      value:
        type: https://docs.adyen.com/errors/security/unauthorized
        title: Forbidden
        status: 403
        detail: Not the right permission to access this service.
        errorCode: '00_403'
  schemas:
    CountriesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
          items:
            type: string
          type: array
      required:
      - operation
      type: object
    JSONObject:
      type: object
    Duration:
      properties:
        unit:
          description: 'The unit of time. You can only use **minutes** and **hours** if the `interval.type` is **sliding**.


            Possible values: **minutes**, **hours**, **days**, **weeks**, or **months**'
          enum:
          - days
          - hours
          - minutes
          - months
          - weeks
          type: string
        value:
          description: 'The length of time by the unit. For example, 5 days.


            The maximum duration is 90 days or an equivalent in other units. For example, 3 months.'
          format: int32
          type: integer
      type: object
    MerchantNamesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          items:
            $ref: '#/components/schemas/StringMatch'
          type: array
      required:
      - operation
      type: object
    SameCounterpartyRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          type: boolean
      required:
      - operation
      type: object
    SameAmountRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          type: boolean
      required:
      - operation
      type: object
    TimeOfDay:
      properties:
        endTime:
          description: 'The end time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**.


            '
          type: string
        startTime:
          description: 'The start time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**.


            '
          type: string
      type: object
    RestServiceError:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        errorCode:
          description: A code that identifies the problem type.
          type: string
        instance:
          description: A unique URI that identifies the specific occurrence of the problem.
          type: string
        invalidFields:
          description: Detailed explanation of each validation error, when applicable.
          items:
            $ref: '#/components/schemas/InvalidField'
          type: array
        requestId:
          description: A unique reference for the request, essentially the same as `pspReference`.
          type: string
        response:
          description: JSON response payload.
          $ref: '#/components/schemas/JSONObject'
        status:
          description: The HTTP status code.
          format: int32
          type: integer
        title:
          description: A short, human-readable summary of the problem type.
          type: string
        type:
          description: A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
          type: string
      required:
      - type
      - errorCode
      - title
      - detail
      - status
      type: object
    MerchantsRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of merchant ID and acquirer ID pairs.
          items:
            $ref: '#/components/schemas/MerchantAcquirerPair'
          type: array
      required:
      - operation
      type: object
    BankIdentification:
      properties:
        country:
          type: string
        identification:
          type: string
        identificationType:
          enum:
          - iban
          - routingNumber
          type: string
      type: object
    CounterpartyBankRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of counterparty Bank Institutions and the operation.
          items:
            $ref: '#/components/schemas/BankIdentification'
          type: array
      required:
      - operation
      type: object
    StringMatch:
      properties:
        operation:
          description: 'The type of string matching operation. Possible values:  **startsWith**, **endsWith**, **isEqualTo**, **contains**,'
          enum:
          - contains
          - endsWith
          - isEqualTo
          - startsWith
          type: string
        value:
          description: The string to be matched.
          type: string
      type: object
    DifferentCurrenciesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: 'Checks the currency of the payment against the currency of the payment instrument.


            Possible values:


            - **true**: The currency of the payment is different from the currency of the payment instrument.


            - **false**: The currencies are the same.


            '
          type: boolean
      required:
      - operation
      type: object
    BrandVariantsRestriction:
      properties:
        operation:
          description: Defines how the con

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-transactionrules-api-openapi.yml