{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-patch-beneficiary-account-response-schema.json",
  "title": "PatchBeneficiaryAccountResponse",
  "description": "Response for PATCH external-id and PATCH account-data: beneficiary name, bank details and external_id.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-beneficiary-accounts-api-openapi.yml#/components/schemas/PatchBeneficiaryAccountResponse",
  "properties": {
    "beneficiary_name": {
      "description": "Nombre del Beneficiary dueño de la cuenta.",
      "title": "Beneficiary Name",
      "type": "string"
    },
    "details": {
      "allOf": [
        {
          "$ref": "#/$defs/BeneficiaryAccountBankDetailsResponse"
        }
      ],
      "description": "Datos bancarios vigentes de la cuenta."
    },
    "external_id": {
      "description": "Identificador de la cuenta en el sistema de origen.",
      "title": "External Id",
      "type": "string"
    }
  },
  "required": [
    "beneficiary_name",
    "details",
    "external_id"
  ],
  "type": "object",
  "$defs": {
    "BeneficiaryAccountBankDetailsResponse": {
      "description": "Bank/account details for PATCH responses.",
      "properties": {
        "account_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Número de la cuenta bancaria. Viene `null` en una cuenta de efectivo, que paga al beneficiario en efectivo y no tiene cuenta bancaria de destino.",
          "title": "Account Number"
        },
        "bank_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Código del banco donde está la cuenta. En México son los tres primeros dígitos de la CLABE, así que lo determina el número de cuenta. Viene `null` en una cuenta de efectivo, que no tiene cuenta bancaria de destino.",
          "title": "Bank Code"
        },
        "tokenized_account_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Token que reemplaza al número de cuenta cuando la cuenta ya fue tokenizada. Viene `null` mientras no lo esté y en una cuenta de efectivo, que no tiene número que tokenizar.",
          "title": "Tokenized Account Number"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/BeneficiaryAccountType"
            }
          ],
          "description": "Tipo de la cuenta de destino. Qué valores se aceptan depende del país de la cuenta: en Chile, `CHECKING_ACCOUNT` (cuenta corriente), `VISTA_ACCOUNT` (cuenta vista) y `SAVINGS_ACCOUNT` (cuenta de ahorro); en México, `BANK_ACCOUNT`, cuyo número de cuenta es una CLABE, y `CASH_ACCOUNT` (cuenta de efectivo), que paga al beneficiario en efectivo y por eso no tiene cuenta bancaria de destino. `DEBIT_CARD` quedó como valor heredado y hoy se rechaza en los dos países."
        }
      },
      "required": [
        "type"
      ],
      "title": "BeneficiaryAccountBankDetailsResponse",
      "type": "object"
    },
    "BeneficiaryAccountType": {
      "description": "Tipo de la cuenta de destino de un Beneficiary Account. Qué valores se aceptan depende del país de la cuenta: en Chile, `CHECKING_ACCOUNT` (cuenta corriente), `VISTA_ACCOUNT` (cuenta vista) y `SAVINGS_ACCOUNT` (cuenta de ahorro); en México, `BANK_ACCOUNT`, cuyo número de cuenta es una CLABE de 18 dígitos; `CIE_AGREEMENT`, un convenio CIE de BBVA de 7 dígitos; `INTERNATIONAL_ACCOUNT`, una cuenta internacional de 20 a 30 dígitos cuyo `bank_code` es el código ABA del banco, de 9 a 11 dígitos; `BBVA_ACCOUNT`, una cuenta BBVA de 10 u 11 dígitos; y `CASH_ACCOUNT` (cuenta de efectivo), que paga al beneficiario en efectivo y por eso no tiene cuenta bancaria de destino. `DEBIT_CARD` quedó como valor heredado y hoy se rechaza en los dos países.",
      "enum": [
        "BANK_ACCOUNT",
        "CASH_ACCOUNT",
        "DEBIT_CARD",
        "CIE_AGREEMENT",
        "INTERNATIONAL_ACCOUNT",
        "BBVA_ACCOUNT",
        "CHECKING_ACCOUNT",
        "VISTA_ACCOUNT",
        "SAVINGS_ACCOUNT"
      ],
      "title": "BeneficiaryAccountType",
      "type": "string"
    }
  }
}