FIfinmo
Payin-Method

Get required fields by Payin Method

Changed on

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.

get/payin-method/param/{payin_method_name}

Request

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

Path parameters

payin_method_namestring required
Example:au_bank_npp

Payin Method Name (For e.g. au_bank_npp)

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": {
    "payin_method_param": [
      {
        "field_description": "",
        "label": "PayID Ref",
        "mandatory": false,
        "name": "payid_reference",
        "regex": "^[a-z0-9_.+~-]{6,35}$",
        "type": "text"
      }
    ]
  }
}

Changes