Refund an invoice (full or partial)

post

https://api.wingspan.app/v3/payments/invoices/{invoiceId}/refund

Initiates a full or partial refund on a paid and deposited invoice. Omit amount to refund the remaining refundable balance. Targeting a specific paymentId and refunding off-platform payments are not supported. Target (MS2): a refund is allowed only when amountDue is 0 (including a cancelled invoice). The refundable amount is the applied amount of completed entries Wingspan collected or received, minus earlier invoice refunds; money received above the invoice is refunded through its overpayment Credit instead. paymentId targets one entry.

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

invoiceId

string

required

Body Params

amount

double

Partial refund amount. Omit for full refund.

reason

string

Optional issuer-authored reason retained for the issuer's records.

paymentId

string

Target one InvoicePayment, capped at that entry's refundable amount. Without it, the refund is taken from refundable entries, newest first. Rejected until the partial-payments service work ships (MS2).

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

200Refund initiated

400Malformed request syntax

401Unauthenticated

403Forbidden or step-up MFA required

404Resource not found

422Validation error