FIfinmo
Payout Beneficiary

Payout Beneficiary Validation

Changed on

Validate beneficiary details using either the Payout_beneficiary_id or the provided Payout_beneficiary_param object details.

post/payout-beneficiary/validate

Request

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

Request body

is_beneficiary_name_match_enabledboolean

If true, beneficiary name will be validated against the payout beneficiary name

beneficiary_idstring required

Conditionally required: Payout beneficiary reference (po_ben_*). (Either beneficiary_id or payout_beneficiary can be passed both cannot be passed)

payout_method_namestring required

Name of Payout Method

Example request

{
  "is_beneficiary_name_match_enabled": false,
  "beneficiary_id": "po_ben_19u134u13q8r022hj280r2hf0q1",
  "payout_method_name": "au_bank_acct",
  "payout_beneficiary": {
    "aba": 26009593,
    "account_number": "12719723525300",
    "bank_code": "",
    "bank_country": "AU",
    "bank_name": "ANZ",
    "beneficiary_name": "Beneficiary Name",
    "bic_swift": "",
    "branch_code": "",
    "bsb": "484799",
    "currency": "AUD",
    "description": "description",
    "iban": "",
    "ifsc": "",
    "individual": {
      "address_city": "",
      "address_country": "",
      "address_line1": "",
      "address_line2": "",
      "address_state": "",
      "address_zip_code": "",
      "country_of_residence": "",
      "dob": "",
      "email": "",
      "first_name": "",
      "identification_custom_type": "",
      "identification_type": "",
      "identification_value": "",
      "last_name": "",
      "nationality": "",
      "phone_country_code": "",
      "phone_number": ""
    },
    "metadata": {},
    "organization_reference_id": "org123",
    "pay_id": "",
    "pay_id_type": "EMAIL",
    "sort_code": "",
    "type": "individual"
  }
}

Response

Created

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Changes