Payee requests an instant payout of a paid invoice

Mark a Paid Invoice for instant payout to the payee's instant payout destination; Wingspan then queues the payout. Only the payee can call this; anyone else gets 404. To send this payout somewhere else, pass payoutDestination; the payee's payout settings are not changed. payoutDestination can be the payee's Wingspan Wallet (InternalAccount); the instant payout fee still applies. A later request without payoutDestination goes back to the saved instant destination. The amount and fee are set by Wingspan. Calling it again after a failed attempt queues the payout again; the fee is never charged twice. If a fee was already charged, Wingspan's recovery payout is already sending it and nothing is queued; a request with payoutDestination then returns 409 with payments.InvoiceInstantPayoutInProgress, as it does while a payout is processing. After the instant payout ran, it returns the Invoice unchanged. Returns 409 when the Invoice is not Paid on-platform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
payoutDestination
object

A payout destination picked for one payout. It applies only to that payout; the payee's payout settings are not changed. Same { type, id } shape as a payout settings destination, without percentage: the whole payout goes to this destination. Must be the payee's own active ExternalBankAccount, a payment card that can receive payouts, or the payee's Wingspan Wallet (InternalAccount). Instant eligibility is not checked: an Instant payout to a destination that cannot receive one is sent on a slower rail. Returns 422 with payments.PayoutDestinationSelectionInvalid when the destination cannot be used.

Headers
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.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json