FIfinmo
Payout Beneficiary

Get Payout Beneficiary by ID

Changed on

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

get/payout-beneficiary/{payout_beneficiary_id}

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Path parameters

payout_beneficiary_idstring required
Example:po_ben_5f13f3f5cfc444148c71a097da9beea5

Payout beneficiary Id (po_ben_*)

Query parameters

include_deletedboolean
Example:true

Include deleted beneficiary

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": [
    {
      "aba": null,
      "account_number": "12345678",
      "bank_code": "1234",
      "bank_country": "AU",
      "bank_name": "ANZ",
      "bic_swift": null,
      "intermediary_bic_swift": null,
      "branch_code": "2345",
      "bsb": "484799",
      "created_at": "2022-03-21T11:31:35.636Z",
      "created_by": "finmo",
      "currency": "AUD",
      "description": null,
      "iban": null,
      "ifsc": "234CBIX",
      "individual": {
        "address_city": null,
        "address_country": null,
        "address_line1": null,
        "address_line2": null,
        "address_state": null,
        "address_zip_code": null,
        "country_of_residence": null,
        "dob": null,
        "email": null,
        "first_name": "John",
        "identification_custom_type": null,
        "identification_type": null,
        "identification_value": null,
        "last_name": "Doe",
        "nationality": null,
        "phone_country_code": null,
        "phone_number": null,
        "phone_number_e164": null
      },
      "additional_data": {
        "change_log": [
          {
            "timestamp": "2025-01-20T11:31:35.636Z",
            "updated_by": "org_user_349ej392992hch33939c292jx",
            "fields": {
              "first_name": {
                "prev_value": "Finmo",
                "new_value": "New Finmo"
              }
            }
          }
        ]
      },
      "is_active": true,
      "is_deleted": false,
      "metadata": null,
      "org_id": "org_804fbb926e9d4175aa46ec67b16c820e",
      "organization_reference_id": "1234567",
      "pay_id": null,
      "pay_id_type": null,
      "payout_beneficiary_id": "po_ben_1967536dfcf34412b9e417d27cae4e93",
      "proxy_type": null,
      "proxy_value": null,
      "sort_code": null,
      "type": "individual",
      "updated_at": "2022-03-21T11:31:35.636Z"
    }
  ]
}

Changes