Update payout settings

patch

https://api.wingspan.app/v3/payments/payout-settings/{payoutSettingsId}

Update the standard or instant destination on a PayoutSettings record. Omitted fields are left unchanged.

Requires a session with recent MFA step-up for PayoutMethodChange. 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: "PayoutMethodChange", then retry.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payoutSettingsId

string

required

Body Params

Account-subject PATCH semantics: omitted fields are left unchanged; explicit null clears nullable fields. Payee allocations are replaced through POST /payments/payout-settings.

preferredPayoutSpeed

string

enum

Account's selected payout speed. This preference is independent of the configured destinations: both Standard and Instant destinations may exist while Standard remains preferred.

Allowed:

standardDestination

object | null

Standard payout destination. Explicit null clears the slot.

instantDestination

object | null

Instant payout destination. Explicit null clears the slot.

shouldSendRemainderToWallet

boolean

Validation assertion rather than stored state. The supplied value must equal the remainder derived from configured Account payout methods; Payee allocations always derive false. Omission leaves routing unchanged.

Headers

Idempotency-Key

string

length between 1 and 255

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

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. 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

200Updated payout settings

400Malformed request syntax

401Unauthenticated

403Forbidden or step-up MFA required

404Resource not found

409Conflict

422Validation error