Payee requests an instant payout of a paid invoice

post

https://api.wingspan.app/v3/payments/invoices/{invoiceId}/request-instant-payout

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. The destination, amount and fee are set by Wingspan, so the request has no body. 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. After the instant payout ran, it returns the Invoice unchanged. Returns 409 when the Invoice is not Paid on-platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

string

required

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

200Instant payout requested

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error