FIfinmo
Payout-Method

Get Required Fields by Payout method

Changed on

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.

get/payout-method/param/{payout_method_name}

Request

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

Path parameters

payout_method_namestring required
Example:au_bank_acct

Payout Method Name (For e.g. au_bank_acct)

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": {
    "payout_beneficiary_param": {
      "base_param": [
        {
          "field_description": "",
          "mandatory": true,
          "name": "bsb",
          "regex": "^[0-9]{3}-?[0-9]{3}$",
          "regex_description": "Enter valid BSB",
          "type": "text"
        }
      ],
      "company": [
        {
          "field_description": "",
          "mandatory": true,
          "name": "name",
          "regex": "^[a-zA-Z0-9 ]{1,50}$",
          "regex_description": "Accepts lowercase and uppercase characters [length: 1 to 50]",
          "type": "text"
        }
      ],
      "individual": [
        {
          "field_description": "",
          "mandatory": true,
          "name": "first_name",
          "regex": "^[a-zA-Z0-9 ]{1,50}$",
          "regex_description": "Accepts lowercase and uppercase characters [length: 5 to 50]",
          "type": "text"
        }
      ]
    }
  }
}

Changes