Skip to main content
PATCH
Update Beneficiary

Authorizations

Authorization
string
header
required

Secret API key from Settings → Developers → API keys. Example: Authorization: Bearer sk_test_…

Path Parameters

id
string<uuid>
required

Beneficiary id.

Body

application/json
nickname
string

Display label for lists and the dashboard.

email
string<email>

Contact email.

relationship
string

Relationship code (see corridors catalog).

address
object

Postal address for the recipient when the corridor requires it.

Response

Updated beneficiary

object
enum<string>

Object type discriminator.

Available options:
beneficiary
id
string<uuid>

Beneficiary id — pass as beneficiary_id on payouts.

kind
enum<string>

Recipient type.

Available options:
person,
business
name
string

Display name derived from person or business fields.

first_name
string

Given name when kind is person.

last_name
string

Family name when kind is person.

business_name
string

Legal name when kind is business.

nickname
string

Optional display label.

email
string

Contact email.

relationship
string

Relationship to your workspace.

address
object

Postal address for the recipient when the corridor requires it.

currency
string

Currency the recipient is paid in.

country
string

Corridor country.

method
string

High-level rail family (bank, mobile_money, …).

scheme
string

Corridor scheme id.

scheme_label
string

Human-readable scheme name.

settlement
string

Typical settlement timing (e.g. Instant, Same day).

holder_name
string

Account holder name on the rail.

routing
object

Scheme-specific account identifiers (may be partially masked).

route_label
string

Short label for the destination account.

status
string

Lifecycle status (active, archived, …).

missing_fields
string[]

Fields still required before the beneficiary can be paid.

created_at
string<date-time>

When the beneficiary was created (UTC).

updated_at
string<date-time>

When the beneficiary was last updated (UTC).

archived_at
string<date-time>

When archived, if applicable.

livemode
boolean

true when created with a live key.

environment
enum<string>

Environment of the creating API key.

Available options:
live,
sandbox