Configuration Update Payment Instrument Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/configuration-update-payment-instrument-structure.json",
  "description": "UpdatePaymentInstrument schema from Adyen API",
  "type": "object",
  "properties": {
    "balanceAccountId": {
      "description": "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.",
      "type": "string"
    },
    "bankAccount": {
      "description": "Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/IbanAccountIdentification"
        },
        {
          "$ref": "#/components/schemas/USLocalAccountIdentification"
        }
      ]
    },
    "card": {
      "description": "Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**.",
      "$ref": "#/components/schemas/Card"
    },
    "description": {
      "description": "Your description for the payment instrument, maximum 300 characters.",
      "maxLength": 300,
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the payment instrument.",
      "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"
    },
    "paymentInstrumentGroupId": {
      "description": "The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.",
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the payment instrument, maximum 150 characters.",
      "maxLength": 150,
      "type": "string"
    },
    "status": {
      "description": "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**:  The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n",
      "enum": [
        "active",
        "closed",
        "inactive",
        "suspended"
      ],
      "type": "string"
    },
    "statusComment": {
      "description": "Comment for the status of the payment instrument.\n\nRequired if `statusReason` is **other**.",
      "type": "string"
    },
    "statusReason": {
      "x-addedInVersion": "2",
      "description": "The reason for the status of the payment instrument.\n\nPossible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**.\nIf the reason is **other**, you must also send the `statusComment` parameter describing the status change.",
      "enum": [
        "accountClosure",
        "damaged",
        "endOfLife",
        "expired",
        "lost",
        "other",
        "stolen",
        "suspectedFraud",
        "transactionRule"
      ],
      "type": "string"
    },
    "type": {
      "description": "Type of payment instrument.\n\nPossible value: **card**, **bankAccount**. ",
      "enum": [
        "bankAccount",
        "card"
      ],
      "type": "string"
    }
  },
  "required": [
    "balanceAccountId",
    "issuingCountryCode",
    "type",
    "id"
  ],
  "name": "UpdatePaymentInstrument"
}