---
title: "Get Required Fields by Payout method"
method: GET
path: "/payout-method/param/{payout_method_name}"
tags: ["Payout-Method"]
---

# Get Required Fields by Payout method

`GET /payout-method/param/{payout_method_name}`

## Request

- Base URL: `https://api.finmo.net/v1`
- URL: `https://api.finmo.net/v1/payout-method/param/{payout_method_name}`
- Auth: HTTP basic

Retrieve the required parameters for a specific Payout-Method.

The parameters returned could be both ```SENDER``` and ```BENEFICIARY``` objects.

These parameters returned within these objects can be used to create a ```SENDER``` and ```BENEFICIARY``` token so you don't need to provide all these details while making multiple Payouts via Finmo.

For example, if you pass Payout-Method for local bank transfers in Australia (Payin-Method name: ```au_bank_acct```), the beneficiary object parameters returned will be ```bsb``` and ```account number```. This implies that to send payments within Australia via bank transfer, you'll need the beneficiary's **BSB** and **ACCOUNT NUMBER** to process a Payout.

## Path parameters

- `payout_method_name` string, required

## Response `200`

OK

- object
  - `data` object
    - `beneficiary_country` string
    - `beneficiary_currency` string
    - `currency` string
    - `is_contract_required` boolean
    - `is_returnable` boolean
    - `max_amount` integer
    - `min_amount` integer
    - `payout_beneficiary_param` object
      - `base_param` object[]
        - `field_description` string
        - `mandatory` boolean
        - `name` string
        - `regex` string
        - `regex_description` string
        - `type` string
      - `company` object[]
        - `field_description` string
        - `mandatory` boolean
        - `name` string
        - `regex` string
        - `regex_description` string
        - `type` string
      - `individual` object[]
        - `field_description` string
        - `mandatory` boolean
        - `name` string
        - `regex` string
        - `regex_description` string
        - `type` string
    - `payout_method_category` string
    - `payout_method_class` 'DOMESTIC' | 'GCA'
    - `payout_method_description` string
    - `payout_method_group` string
    - `payout_method_id` string
    - `payout_method_logo` string
    - `payout_method_name` string
    - `payout_method_param` object
    - `payout_sender_param` object
      - `type` 'company' | 'individual'
      - `company` object, nullable
        - `name` string
        - `incorporation_country` string
        - `registration_number` string
        - `address_line1` string
        - `address_city` string
    - `sender_country` string
    - `sender_currency` string
  - `request_id` string
  - `request_time` string, date-time
  - `status_code` integer
  - `status_text` string
  - `success` boolean

## Other responses

- `404`: Not Found

## Changes

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

[Operation history](https://skmtc.dev/finmo/apis/finmo-api/changes/payout-method/param/:payout_method_name/get.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)