Skip to main content
DELETE
Delete a payment method
Deletes a payment method. The record is retained internally but can no longer be used for payments.

Returns

Returns the PaymentMethod object as it existed before deletion.

Authorizations

X-API-KEY
string
header
required

Server-side API key from the Crossmint dashboard.

Path Parameters

paymentMethodId
string<uuid>
required

PaymentMethod identifier.

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.

Response

PaymentMethod object (pre-deletion state). The record is no longer returned by list or retrieve endpoints.

A saved payment method. Sensitive fields (full PAN, CVC, full account numbers) are never included in responses.

paymentMethodId
string<uuid>
required

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

default
boolean
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.

displayName
string
required

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

type
enum<string>
required

Payment method type. Determines which sub-object (card or bankAccount) is present.

Available options:
bank-account-us,
bank-account-mx-clabe,
bank-account-co,
bank-account-sepa-iban
bankAccount
object
required

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

lastPayoutAt
string<date-time>

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