Adyen · Schema

PaymentInstrumentRequirement

PaymentInstrumentRequirement schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
description string Specifies the requirements for the payment instrument that need to be included in the request for a particular route.
issuingCountryCode string The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.
onlyForCrossBalancePlatform boolean Specifies if the requirement only applies to transfers to another balance platform.
paymentInstrumentType string The type of the payment instrument. For example, "BankAccount" or "Card".
type string **paymentInstrumentRequirement**
View JSON Schema on GitHub

JSON Schema

configuration-payment-instrument-requirement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-payment-instrument-requirement-schema.json",
  "title": "PaymentInstrumentRequirement",
  "description": "PaymentInstrumentRequirement schema from Adyen API",
  "type": "object",
  "properties": {
    "description": {
      "description": "Specifies the requirements for the payment instrument that need to be included in the request for a particular route.",
      "type": "string"
    },
    "issuingCountryCode": {
      "description": "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.",
      "type": "string"
    },
    "onlyForCrossBalancePlatform": {
      "description": "Specifies if the requirement only applies to transfers to another balance platform.",
      "type": "boolean"
    },
    "paymentInstrumentType": {
      "description": "The type of the payment instrument. For example, \"BankAccount\" or \"Card\".",
      "enum": [
        "BankAccount",
        "Card"
      ],
      "type": "string"
    },
    "type": {
      "default": "paymentInstrumentRequirement",
      "description": "**paymentInstrumentRequirement**",
      "enum": [
        "paymentInstrumentRequirement"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false
}