Adyen · JSON Structure

Configuration Payment Instrument Requirement Structure

PaymentInstrumentRequirement schema from Adyen API

Type: object Properties: 5 Required: 1
PaymentsFinancial ServicesFintech

PaymentInstrumentRequirement is a JSON Structure definition published by Adyen, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

description issuingCountryCode onlyForCrossBalancePlatform paymentInstrumentType type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/configuration-payment-instrument-requirement-structure.json",
  "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,
  "name": "PaymentInstrumentRequirement"
}