v1

latestOpenAPI 3.0.02026-07-26280204.9 KB

Payout Sender

Update Payout Sender

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

patch/payout-sender/{payout_sender_id}

payout_sender_idstring required

Example:po_sender_abc123def456

Payout sender ID (po_sender_*)

sender_namestring

Name of the payout sender

type'individual' | 'company'

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

descriptionstring

Description of the payout sender

metadataobject nullable

Custom metadata object

emailstring email

Email address

organization_reference_idstring

A reference you can later use to identify this payout sender

address_line1string

Address line 1

address_line2string

Address line 2

address_citystring

City

address_statestring

State or province

address_countrystring

Country code (ISO 3166-1 alpha-2)

address_zip_codestring

ZIP or postal code

phone_numberstring

Phone number

phone_country_codestring

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

phone_number_e164string

Phone number in E.164 format

{
  "sender_name": "Updated Sender Name",
  "email": "updated@example.com",
  "address_city": "New York"
}