Skip to main content
DELETE
Delete Payment Method
This endpoint requires a JWT from an external auth provider (Auth0, Firebase, Stytch, etc.) or a custom JWT backed by a JWKS endpoint. Crossmint Auth is not supported.

Headers

X-API-KEY
string
required

API key required for authentication

Path Parameters

paymentMethodId
string
required

Query Parameters

userLocator
string

Identifies the target user when authenticating with a server API key. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123, phoneNumber:+12125551234, twitter:alice). Required for API-key authentication; ignored when authenticating with a JWT (the JWT subject is used).

Response

Returns the deleted payment method

bankAccount
object
required
createdAt
string<date-time>
required

ISO 8601 timestamp when this payment method was created.

Example:

"2024-01-15T10:30:00.000Z"

paymentMethodId
string
required
Minimum string length: 1
reason
string | null
required

Deprecated. Use statusReason, which carries the same value.

status
enum<string>
required

Whether this destination can receive a payout right now. 'pending' while the readiness checks run, 'active' when a provider has confirmed a rail, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' and 'rejected' move only to 'deleted'. Branch on this field, never on statusReason.

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

Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on status and treat an unrecognised code as the status alone.

type
enum<string>
required
Available options:
bank-account-mx-clabe
updatedAt
string<date-time>
required

ISO 8601 timestamp when this payment method was last modified.

Example:

"2024-01-15T10:30:00.000Z"

label
string

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

Minimum string length: 1
lastPayoutAt
string<date-time>

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

Example:

"2024-01-15T10:30:00.000Z"