FIfinmo
Payout Beneficiary

Update Payout Beneficiary

Changed on

Update details of an individual Payout beneficiary using the beneficiary ID (po_ben_*).

patch/payout-beneficiary/{payout_beneficiary_id}

Request

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

Path parameters

payout_beneficiary_idstring required
Example:po_ben_5f13f3f5cfc444148c71a097da9beea5

Payout beneficiary Id (po_ben_*)

Request body

type'company' | 'individual'

type can be either 'individual' or 'company' based on the beneficiary

beneficiary_namestring

Display Name of the payout beneficiary

currencystring

Beneficiary Currency

descriptionstring

Description of Transaction

bank_countrystring

Bank Country

bank_namestring

Name of the Bank

account_numberstring

Account Number

bsbstring

BSB (AU specific)

bic_swiftstring

Swift Code

intermediary_bic_swiftstring

We strongly recommend to provide an intermediary bank for all wire transfers using SWIFT to banks and non-banking financial institutions in Europe, Africa and USA. This will reduce delays in crediting funds with beneficiary especially if its to a non-banking FI.

ibanstring

IBAN (EU & UK specific)

abastring

ABA Routing Number (US Specific)

sort_codestring

Sort Code (UK & IE specific)

pay_idstring

NPP PayID (AU Specific)

pay_id_typestring

Mention the type of PayID,It takes values ["EMAIL, PHONE, ORG, ABN"]

ifscstring

IFSC code

branch_codestring

Branch Code

bank_codestring

Bank Code

organization_reference_idstring

A reference you can later use to identify this payment, such as an order number. Can only be alphanumeric and must be unique for Benefit.

metadataobject

Custom Data

proxy_typeunknown
proxy_valueunknown

Example request

{
  "aba": 26009593,
  "account_number": "13719713158835300",
  "bank_code": "",
  "bank_country": "",
  "bank_name": "",
  "beneficiary_name": "Beneficiary Name",
  "bic_swift": "",
  "intermediary_bic_swift": "",
  "branch_code": "",
  "bsb": "484799",
  "company": {
    "address_city": "Chatham",
    "address_country": "US",
    "address_line1": "97 Main Street Second Floor  NJ 07928",
    "address_line2": "",
    "address_state": "New Jersey",
    "address_zip_code": 7928,
    "company_email": "",
    "incorporation_country": "",
    "name": "Finmo",
    "phone_country_code": "",
    "phone_number": "",
    "registration_number": "",
    "identification_type": "",
    "identification_value": ""
  },
  "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": ""
  },
  "currency": "",
  "description": "description",
  "iban": "",
  "ifsc": "",
  "metadata": {},
  "organization_reference_id": "org_123",
  "pay_id": "",
  "pay_id_type": "EMAIL",
  "sort_code": "",
  "type": "",
  "proxy_type": "",
  "proxy_value": "",
  "payout_beneficiary_controls": {
    "is_payout_beneficiary_on_name_mismatch_allowed": false
  }
}

Response

Created

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Changes