---
title: "Get required fields by Payin Method"
method: GET
path: "/payin-method/param/{payin_method_name}"
tags: ["Payin-Method"]
---

# Get required fields by Payin Method

`GET /payin-method/param/{payin_method_name}`

## Request

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

Retrieve the required parameters for a specific Payin-Method.

The parameters are returned as a list of objects. The name of each field appears in the ```name``` variable of the ```payin_method_param``` array.

The parameters returned could be optional or mandatory, for example, if you pass the Payin-Method for accepting payments via NPP in Australia (Payin-Method name: ```au_bank_npp```), the parameter returned is a ```payid_reference```. This is an optional field so in case this field is not provided, Finmo may generate a random value.

## Path parameters

- `payin_method_name` string, required

## Response `200`

OK

- object
  - `data` object
    - `country` string
    - `currency` string
    - `default_expiry_time_seconds` string
    - `is_cancellable` boolean
    - `is_multiple_refund_allowed` boolean
    - `is_over_refundable` boolean
    - `is_partially_refundable` boolean
    - `is_payin_allowed` boolean
    - `is_refundable` boolean
    - `is_va_allowed` boolean
    - `max_amount` integer
    - `max_expiration_time_in_seconds` string
    - `min_amount` integer
    - `payin_method_category` string
    - `payin_method_class` string
    - `payin_method_description` string
    - `payin_method_group` string
    - `payin_method_id` string
    - `payin_method_instruction` string[]
    - `payin_method_logo` string
    - `payin_method_name` string
    - `payin_method_param` object[]
      - `field_description` string
      - `label` string
      - `mandatory` boolean
      - `name` string
      - `regex` string
      - `regex_description` string
      - `type` 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/payin-method/param/:payin_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)