Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-31"

Path Parameters

payout_method_id
string
required

Payout method ID, prefixed potk_.

Body

application/json
nickname
string
required

New label for the payout method.

Response

payout method renamed

account_reference
string | null
required

Masked identifier for the destination.

created_at
string<date-time>
required
destination_currency
string
required
estimated_arrival
object | null
required

null after an update. List payout methods to retrieve arrival estimates.

fee_structure
object | null
required

null after an update. List payout methods to retrieve the configured fee terms.

id
string
required

Payout method ID, prefixed potk_.

institution_name
string | null
required
is_default
boolean
required
nickname
string | null
required

User-defined label for the payout method.

object
enum<string>
required
Available options:
payout_method
payer_name
string | null
required
quote
object | null
required

Always null after an update.

status
enum<string>
required
Available options:
created,
active,
broken
supported_payout_method
object | null
required