# PaymentAccountBeneficiary

Schema: #/components/schemas/PaymentAccountBeneficiary

Method: SCHEMA
Version: 1.0.0

## Schema fields:

  - `id` (string)
    Example: bene_6ab5a1c9gflRf

  - `payment_account_id` (string)
    The payment account that owns the beneficiary.
    Example: pacct_6ab59a10Hk3Zq

  - `name` (string)
    Example: Aarav Nair

  - `category` (string)
    Enum: "payout"

  - `type` (string)
    Enum: "individual", "business"

  - `email` (string | null)
    Example: aarav.nair@example.com

  - `phone` (string | null)
    Example: null

  - `nickname` (string | null)
    Example: My NRE account

  - `status` (string)
    `active` beneficiaries can receive payouts. A payout to a `pending` or `rejected` beneficiary returns `400`.
    Enum: "active", "pending", "rejected"

  - `notes` (object | null)
    Example: null

  - `address` (object | null)

  - `address.address_line1` (string)
    Example: 12 Marina Walk

  - `address.address_line2` (string | null)
    Example: null

  - `address.city` (string)
    Example: Kochi

  - `address.state` (string)
    Example: Kerala

  - `address.country_code` (string)
    ISO 3166-1 alpha-3 country code.
    Example: IND

  - `address.postal_code` (string | null)
    Example: 682001

  - `bank_account` (object | null)
    The bank account details. `null` on a UPI beneficiary.

  - `bank_account.account_number` (string)
    Example: 000111222333

  - `bank_account.name` (string | null)
    The name of the bank.
    Example: HDFC Bank

  - `bank_account.swift_code` (string | null)
    Example: null

  - `bank_account.local_routing_number` (string | null)
    The local routing code, for example the IFSC for an INR account.
    Example: HDFC0000123

  - `bank_account.currency` (string)
    Example: INR

  - `bank_account.category` (string | null)
    Example: null

  - `bank_account.intermediate_bank` (object | null)
    Example: null

  - `bank_account.intermediate_bank.name` (string)

  - `bank_account.intermediate_bank.country` (string)

  - `bank_account.intermediate_bank.swift_code` (string)

  - `bank_account.intermediate_bank.account_number` (string)

  - `upi_account` (object | null)
    The UPI details. `null` on a bank account beneficiary.
    Example: null

  - `upi_account.upi_id` (string)
    Example: aarav@okhdfcbank

  - `created_at` (string)
    Example: 2026-10-15T10:40:12Z

  - `updated_at` (string)
    Example: 2026-10-15T10:40:12Z

