---
title: "Update Payout Beneficiary"
method: PATCH
path: "/payout-beneficiary/{payout_beneficiary_id}"
tags: ["Payout Beneficiary"]
---

# Update Payout Beneficiary

`PATCH /payout-beneficiary/{payout_beneficiary_id}`

## Request

- Base URL: `https://api.finmo.net/v1`
- URL: `https://api.finmo.net/v1/payout-beneficiary/{payout_beneficiary_id}`
- Auth: HTTP basic

Update details of an individual Payout beneficiary using the beneficiary ID (```po_ben_*```).

## Path parameters

- `payout_beneficiary_id` string, required

## Request body

- object
  - `type` 'company' | 'individual': type can be either 'individual' or 'company' based on the beneficiary
  - `beneficiary_name` string: Display Name of the payout beneficiary
  - `currency` string: Beneficiary Currency
  - `company` object, required: **Conditionally required:** Either an Individual object or a Company object must be specified, but not both.
    - `address_city` string: City
    - `address_country` string: Country
    - `address_line1` string: Address Line 1
    - `address_line2` string: Address Line 2
    - `address_state` string: State
    - `address_zip_code` string: Valid Zip/postal code
    - `company_email` string: Email Id of company
    - `incorporation_country` string: Incorporation Country
    - `name` string, required: Name
    - `phone_country_code` string: Phone country Code
    - `phone_number` string: Mobile Number
    - `registration_number` string: Company Registration Number
    - `identification_type` string: Identification Type (ID Specific)
    - `identification_value` string: Identification Value (ID Specific)
  - `individual` object, required: **Conditionally required:** Either an Individual object or a Company object must be specified, but not both.
    - `address_city` string: City
    - `address_country` string: Country
    - `address_line1` string: Address Line 1
    - `address_line2` string: Address Line 2
    - `address_state` string: State
    - `address_zip_code` string: Valid Zip/postal code
    - `country_of_residence` string
    - `dob` string: Date of Birth
    - `email` string: Email Id
    - `first_name` string, required: First Name
    - `identification_custom_type` string: Identity custom type
    - `identification_type` string: Type of identity document: WORK_PERMIT, PASSPORT, NATIONAL_ID, DRIVERS_LICENCE, OTHERS
    - `identification_value` string: Indentity Document Number
    - `last_name` string, required: Last Name
    - `nationality` string: Nationality
    - `phone_country_code` string: Phone Country Code
    - `phone_number` string: Phone Number
  - `description` string: Description of Transaction
  - `bank_country` string: Bank Country
  - `bank_name` string: Name of the Bank
  - `account_number` string: Account Number
  - `bsb` string: BSB (AU specific)
  - `bic_swift` string: Swift Code
  - `intermediary_bic_swift` string: We strongly recommend to provide an intermediary bank for all wire transfers using SWIFT to banks and non-banking financial institutions in Europe, Africa and USA. This will reduce delays in crediting funds with beneficiary especially if its to a non-banking FI.
  - `iban` string: IBAN (EU & UK specific)
  - `aba` string: ABA Routing Number (US Specific)
  - `sort_code` string: Sort Code (UK & IE specific)
  - `pay_id` string: NPP PayID (AU Specific)
  - `pay_id_type` string: Mention the type of PayID,It takes values ["EMAIL, PHONE, ORG, ABN"]
  - `ifsc` string: IFSC code
  - `branch_code` string: Branch Code
  - `bank_code` string: Bank Code
  - `organization_reference_id` string: A reference you can later use to identify this payment, such as an order number. Can only be alphanumeric and must be unique for Benefit.
  - `metadata` object: Custom Data
  - `proxy_type` unknown
  - `proxy_value` unknown
  - `payout_beneficiary_controls` object: Controls specific checks during beneficiary updation.
    - `is_payout_beneficiary_on_name_mismatch_allowed` boolean

## Response `201`

Created

- object
  - `data` object
    - `aba` string, nullable
    - `account_number` string
    - `bank_code` string
    - `bank_country` string
    - `bank_name` string
    - `beneficiary_name` string
    - `bic_swift` string, nullable
    - `intermediary_bic_swift` string, nullable
    - `branch_code` string
    - `bsb` string
    - `company` object
      - `address_city` string, nullable
      - `address_country` string, nullable
      - `address_line1` string, nullable
      - `address_line2` string, nullable
      - `address_state` string, nullable
      - `address_zip_code` string, nullable
      - `company_email` string, nullable
      - `company_incorporation_country` string, nullable
      - `name` string
      - `phone_country_code` string, nullable
      - `phone_number` string, nullable
      - `phone_number_e164` string, nullable
      - `registration_number` string, nullable
      - `identification_type` string, nullable
      - `identification_value` string, nullable
    - `additional_data` object
      - `change_log` object[]
        - `timestamp` string, date-time
        - `updated_by` string
        - `fields` object
          - `key_name` object
            - `prev_value` string
            - `new_value` string
    - `created_at` string, date-time
    - `created_by` string
    - `currency` string
    - `description` string, nullable
    - `iban` string, nullable
    - `ifsc` string
    - `is_active` boolean
    - `metadata` string, nullable
    - `org_id` string
    - `organization_reference_id` string
    - `pay_id` string, nullable
    - `pay_id_type` string
    - `payout_beneficiary_id` string
    - `proxy_type` string
    - `proxy_value` string
    - `sort_code` string, nullable
    - `type` string
    - `updated_at` string, date-time
  - `request_id` string
  - `request_time` string, date-time
  - `status_code` integer
  - `status_text` string
  - `success` boolean

## Other responses

- `400`: Bad Request

## Changes

- **2026-11-03** `39e5e5ab5c3a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/finmo/apis/finmo-api/changes/payout-beneficiary/:payout_beneficiary_id/patch.md)

---

[API](https://skmtc.dev/finmo/apis/finmo-api.md) - [All operations](https://skmtc.dev/finmo/apis/finmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/finmo/apis/finmo-api/revisions/39e5e5ab5c3a?raw)