v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

Payment Methods

Update a payment method

Updates a payout method's billing details or default status. Only default and billingDetails can be modified; the account type and account numbers are immutable after creation. The request body must contain at least one of these fields.

API scope required: payment-methods.update

patch/unstable/payment-methods/{paymentMethodId}

Path parameters

paymentMethodIdstring uuid required

UUID of the payment method.

Query parameters

userLocatorstring

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

Request body

defaultboolean

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

Response

Updated PaymentMethod object.

paymentMethodIdstring uuid required

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

defaultboolean required

Whether this is the user's default payment method. Only one per user can be the default; setting a new default automatically unsets the previous one.

displayNamestring required

Human-readable label derived by the server (e.g., "Chime ••6259", "SEPA Account ••6789"). Not settable by the client.

type'bank-account-us' | 'bank-account-mx-clabe' | 'bank-account-co' | 'bank-account-sepa-iban' required

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

lastPayoutAtstring date-time

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