{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-update-payee-request-schema.json",
  "title": "UpdatePayeeRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-payee-vault-api-openapi.yml#/components/schemas/UpdatePayeeRequest",
  "type": "object",
  "properties": {
    "merchant_id": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.<br><strong>Conditional Requirement: </strong>Required if this request is on behalf of another merchant."
    },
    "payee_address": {
      "$ref": "#/$defs/addPayeeAddressRequest"
    },
    "payee_email": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "<strong>Description:</strong> An array of payee email addresses."
    },
    "payee_name": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 64 AN <br><strong>Description:</strong> Payee name."
    },
    "payee_phone": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 32 N<br><strong>Description: </strong>Payee phone number. Prefix with `+` and the country code.",
      "readOnly": true
    }
  },
  "$defs": {
    "addPayeeAddressRequest": {
      "type": "object",
      "x-display-fields": [
        "address1",
        "address2",
        "city",
        "state",
        "zip",
        "country_code",
        "country"
      ],
      "properties": {
        "address1": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Payee mailing address line 1."
        },
        "address2": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Payee mailing address line 2."
        },
        "city": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Mailing city."
        },
        "state": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Mailing state."
        },
        "zip": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Mailing zip code."
        },
        "country_code": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length 3 N<br><strong>Description: </strong>ISO numeric country code. Refer to <a href=\"/docs/references\" target=\"_blank\">Country Codes</a> for a list of country codes.",
          "default": "840"
        },
        "country": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Country name."
        }
      }
    }
  }
}