API Reference
WebsiteLog In

Update Payout Beneficiary

patch
https://api.finmo.net/v1/payout-beneficiary/

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

Path Params
string
required

Payout beneficiary Id (poben*)

Body Params
string
enum

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

Allowed:
string

Display Name of the payout beneficiary

string

Beneficiary Currency

company
object
required

Conditionally required: Either an Individual object or a Company object must be specified, but not both.

individual
object
required

Conditionally required: Either an Individual object or a Company object must be specified, but not both.

string

Description of Transaction

string

Bank Country

string

Name of the Bank

string

Account Number

string

BSB (AU specific)

string

Swift Code

string

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.

string

IBAN (EU & UK specific)

string

ABA Routing Number (US Specific)

string

Sort Code (UK & IE specific)

string

NPP PayID (AU Specific)

string

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

string

IFSC code

string

Branch Code

string

Bank Code

string

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.

metadata
object

Custom Data

string

Proxy Type (SG Specific)

string

Proxy Value (SG Specific)

payout_beneficiary_controls
object

Controls specific checks during beneficiary updation.

Responses

Updated 7 days ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8

Updated 7 days ago

Did this page help you?