v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

Payment Methods

Retrieve a payment method

Retrieves a single bank account payout method by its ID. Returns 404 if it does not exist, has been deleted, or belongs to a different user.

API scope required: payment-methods.read

get/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.

Response

PaymentMethod object. The bankAccount sub-object is populated, matching type.

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.