Set a payee default payment method

patch

https://api.wingspan.app/v3/payments/payees/{payeeId}/default-payment-method

Replace the entire payer-seat default; this is not a merge-patch operation. A bank method requires an active relationship-scoped Maximum ACH authorization. This operation never enables automatic collection. Requires a session with recent MFA step-up for HighRiskWriteAction. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "HighRiskWriteAction", then retry.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payeeId

string

required

^[A-Za-z0-9_.]{22,80}$

Body Params

paymentMethod

object

required

A typed reference to a payment method instrument. Used wherever a stored instrument is named (a default payment method, or the instrument settling a payment). The id is the instrument resource named by type.

mandateId

string

required

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{32})$

Headers

Idempotency-Key

string

required

length between 1 and 255

^[\x21-\x7e]{1,255}$

REQUIRED idempotency token for money-moving requests (e.g. transfers). The token is used by the API so a retry after a 5xx/timeout replays the original result instead of moving funds twice. Reuse the same key to retry safely; use a NEW key to issue a genuinely new transfer. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Saved default payment method

401Unauthenticated

403Forbidden or step-up MFA required

404Resource not found

409Conflict

422Validation error