Create or replace payout routing for a Payee relationship

post

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

Replace payer-managed payout routing for a Payee subject. Bank destinations and the instant debit card must be payer-owned with the same immutable Payee subject. Standard requires bank destinations totaling 100%. Instant requires an active debit card and a payer approved for instant payouts; bank destinations are optional. Omitting the speed selects Standard, and omitting the instant destination removes the card. Instant fees are deducted from the payee payout: default 2%, minimum $0.50 per paid payable; payables of $0.50 or less have no fee.

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…

Body Params

Replaces a payer-managed payee's payout routing. Omitting preferredPayoutSpeed selects Standard; omitting instantDestination removes the card. Standard requires bank destinations totaling 100%. Instant requires an active, supported debit card and a payer approved for instant payouts; bank destinations are optional and used only for Standard payouts. Instant fees are deducted from each paid payable: the default rate is 2%, minimum $0.50. Payables of $0.50 or less have no instant fee.

subject

object

required

Immutable Payee relationship whose payouts are being routed.

preferredPayoutSpeed

string

enum

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

Allowed:

instantDestination

object | null

Payer-owned active debit card with this Payee as its subject. Null removes the card.

destinations

array of objects

length ≤ 10

destinations

shouldSendRemainderToWallet

boolean

enum

Defaults to false

Allowed:

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

200Payee payout routing created or replaced

401Unauthenticated

403Forbidden or step-up MFA required

404Resource not found

409Conflict

422Validation error