Update Payout Sender

patch

https://api.finmo.net/v1/payout-sender/{payout_sender_id}

Update the details of an existing payout sender. All fields are optional - only include fields you want to update.

Path Params

payout_sender_id

string

required

Payout sender ID (posender*)

Body Params

sender_name

string

Name of the payout sender

type

string

enum

Type of sender. Must be either 'individual' or 'company'

Allowed:

description

string

Description of the payout sender

metadata

object | null

Custom metadata object

string

Email address

organization_reference_id

string

A reference you can later use to identify this payout sender

address_line1

string

Address line 1

address_line2

string

Address line 2

address_city

string

City

address_state

string

State or province

address_country

string

Country code (ISO 3166-1 alpha-2)

address_zip_code

string

ZIP or postal code

phone_number

string

Phone number

phone_country_code

string

Phone country code (e.g., +1, +61)

phone_number_e164

string

Phone number in E.164 format

individual

object | null

Individual details (required if type is 'individual')

company

object | null

Company details (required if type is 'company')

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json; charset=utf-8

200OK

400Bad Request

404Not Found