Delete a credit

delete

https://api.wingspan.app/v3/payments/credits/{creditId}

Delete a credit created by your Account only while Pending with no entries or refund reservations; otherwise returns 409. Use complete to close a credit with ledger history. If-Match accepts the current credit ETag or *; stale versions return 412.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

creditId

string

required

Headers

If-Match

string

Optimistic-concurrency precondition. On PATCH and lifecycle action POSTs against resources with mutable lifecycle (Invoice, Payable, PayrollRun, Credit, Deduction), supply the ETag returned on the most recent read. Mismatch yields 412 Precondition Failed. If-Match: * accepts any current ETag.

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

Responses

204

Credit deleted

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/problem+json

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

412Optimistic-concurrency precondition failed (If-Match mismatch)