{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-update-payment-recipient-schema.json",
  "title": "UpdatePaymentRecipient",
  "description": "Request with information to update a payment recipient",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pluggy-payment-recipient-api-openapi.yml#/components/schemas/UpdatePaymentRecipient",
  "properties": {
    "taxNumber": {
      "type": "string",
      "description": "Account owner tax number. Can be CPF or CNPJ (only numbers)"
    },
    "name": {
      "type": "string",
      "description": "Account owner name."
    },
    "paymentInstitutionId": {
      "type": "string",
      "format": "uuid",
      "description": "Primary identifier of the institution associated to the payment recipient."
    },
    "account": {
      "allOf": [
        {
          "$ref": "#/$defs/PaymentRecipientAccount"
        }
      ],
      "description": "Recipient's bank account destination."
    }
  },
  "type": "object",
  "$defs": {
    "PaymentRecipientAccount": {
      "description": "Payment receiver bank account information",
      "properties": {
        "branch": {
          "type": "string",
          "description": "Receiver bank account branch (agency)"
        },
        "number": {
          "type": "string",
          "description": "Receiver bank account number"
        },
        "type": {
          "type": "string",
          "description": "Receiver bank account type, could be: 'CHECKING_ACCOUNT', 'SAVINGS_ACCOUNT' or 'GUARANTEED_ACCOUNT'"
        }
      },
      "type": "object",
      "required": [
        "branch",
        "number",
        "type"
      ]
    }
  }
}