Rename Saved Payout Method

Changes the label used to identify a saved payout method.

PATCH /payouts/methods/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const method = await client.payouts.methods.update('id', { nickname: 'Primary checking' });

console.log(method.id);

200

{
  "account_reference": "••••0472",
  "bank_verification_state": "no_data",
  "created_at": "2026-01-01T12:00:00.000Z",
  "destination_currency": "usd",
  "estimated_arrival": {},
  "fee_structure": {},
  "id": "potk_xxxxxxxxxxxxxx",
  "institution_name": "Frost Bank",
  "is_clone": false,
  "is_default": false,
  "last_paid_out_at": "2023-11-07T05:31:56Z",
  "linked_via_plaid": false,
  "needs_plaid_reconnect": false,
  "nickname": "Primary checking",
  "object": "payout_method",
  "payer_name": "ACH Bank Deposit",
  "quote": {},
  "status": "created",
  "status_reason": "<string>",
  "supported_payout_method": {
    "country_code": "USA",
    "delivery_type": "bank_deposit",
    "icon_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/ach-bank-deposit-icon",
    "name": "ACH Bank Deposit",
    "supports_instant_delivery": false,
    "supports_plaid": true,
    "supports_standard_delivery": true
  },
  "unavailable_reason": "destination_retired"
}

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-08-21"

Path Parameters

id · string · required

Payout method ID, prefixed potk_.

Body

application/json

nickname · string · required

New label for the payout method, with at least one non-whitespace character and a maximum of 100 characters.

Required string length: 1 - 100

Example:

"Primary checking"

Response

200

application/json

payout method renamed

account_reference · string | null · required

Masked identifier for the destination.

Example:

"••••0472"

bank_verification_state · enum<string> | null · required

Lifecycle trust state: checking (verification still running), verified (bank confirmed ownership or a payout already completed to it), no_data (verification unavailable or bank returned no ownership data), warning (bank could not confirm the destination's owner), broken (payouts failed with a permanent account error), null (never checked).

Available options: checking, verified, no_data, warning, broken, null

Example:

"no_data"

created_at · string<date-time> · required

Example:

"2026-01-01T12:00:00.000Z"

destination_currency · string · required

Example:

"usd"

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_.

Example:

"potk_xxxxxxxxxxxxxx"

institution_name · string | null · required

Example:

"Frost Bank"

is_clone · boolean · required

Whether this method is a copy of one saved on another of the payer's accounts.

Example:

false

is_default · boolean · required

Example:

false

last_paid_out_at · string<date-time> | null · required

When the most recent completed payout was delivered to this method, as an ISO 8601 timestamp. null when nothing has been paid out to it yet.

linked_via_plaid · boolean · required

Whether the payer added this method by signing in to their bank rather than typing account details.

Example:

false

needs_plaid_reconnect · boolean · required

Whether the bank sign-in behind this method has expired and must be redone before it counts as linked.

Example:

false

nickname · string | null · required

User-defined label for the payout method.

Example:

"Primary checking"

object · enum<string> · required

Available options: payout_method

Example:

"payout_method"

payer_name · string | null · required

Example:

"ACH Bank Deposit"

quote · object | null · required

Always null after an update.

status · enum<string> · required

created — saved, no payout has completed through it yet. active — a payout through it completed. broken — a payout through it failed with an error attributable to the method, and it no longer accepts payouts; a later successful payout returns it to active.

Available options: created, active, broken

Example:

"created"

status_reason · string | null · required

Machine-readable code for why the method is broken — the newest failure recorded through it, whether a payout error or a pre-payout rejection. null unless the method is broken, or when it was disabled without a recorded failure.

supported_payout_method · object | null · required

Show child attributes

unavailable_reason · enum<string> | null · required

Why this method is unavailable: destination_retired means the payout provider stopped offering the destination. Whop may automatically remap an eligible method that was not linked through Plaid to a compatible replacement; otherwise, the account owner must re-add it. null means no unavailability reason is known.

Available options: destination_retired, null

Example:

"destination_retired"