Skip to main content
PATCH
Update a payment method
Updates a payout method’s default status. Only default can be changed.

Returns

Returns the updated PaymentMethod object.

Authorizations

X-API-KEY
string
header
required

Path Parameters

paymentMethodId
string<uuid>
required

UUID of the payment method.

Query Parameters

userLocator
string

Identifies the target user. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123). Required with server API key auth; ignored with JWT.

Body

application/json

Only default can be changed. Payout method type and account numbers cannot be changed after creation.

default
boolean
required

Set to true to make this the user's default payment method. Automatically unsets the previous default.

Response

Updated PaymentMethod object.

A saved bank account payout method. Sensitive fields (full account numbers and IBANs) are never included in responses.

paymentMethodId
string<uuid>
required

Unique identifier (UUID v4), assigned by the server on creation.

type
enum<string>
required

Payout method type. Determines the country-specific bankAccount fields that are present.

Available options:
bank-account-us,
bank-account-mx-clabe,
bank-account-co
status
enum<string>
required

Whether this destination can receive a payout right now. 'active' when a provider has confirmed a rail, 'pending' while rail resolution is still running, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. 'deleted' is terminal and carries no reason. Branch on this field, never on reason.

Available options:
active,
deleted,
pending,
rejected
reason
string | null
required

Why the status is not 'active'. Null when it is, and on a 'pending' status other than a provider outage. Known values today: provider-unavailable, destination-not-found, destination-closed, destination-cannot-receive, no-rail-available, deleted, disabled. New codes can appear at any time, so branch on status and treat an unrecognised reason as the status alone.

bankAccount
object
required

Bank account details. Present when type is a bank type. Full account numbers and IBANs are never included.

label
string

The client's own name for this payment method, when one was sent on creation.

lastPayoutAt
string<date-time>

Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none.