Complete an adjustment remainder

post

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

Complete all or part of a credit remainder using Refund, OffPlatform or Close. Requires elevated authentication and Idempotency-Key. Refund requires payments.invoice-refund:write and a paid source invoice, and cannot exceed the refundable balance. After 412, re-read the credit and retry with its current ETag and a new Idempotency-Key.

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

creditId

string

required

Body Params

Dispose of all or part of an unused adjustment remainder. Requires elevated authentication and Idempotency-Key. Refund requires a paid source and cannot exceed the available refundable balance. After 412, re-read the resource and retry with a fresh Idempotency-Key and current If-Match.

remainderDisposition

string

enum

required

Allowed:

amount

double

A monetary amount as a JSON number in major units, with decimal places carrying the minor units defined for its currency (USD/EUR: 2, JPY: 0, BHD: 3, ...) — e.g. 100.00. Never a string and never minor-unit (cent) integers. The currency comes from the enclosing resource's currency field; amounts with more decimal places than the currency supports are rejected with 422 ValidationError. Wingspan converts to exact minor units at the service boundary, so callers never need sub-minor-unit precision.

Headers

Idempotency-Key

string

required

length between 1 and 255

^[\x21-\x7e]{1,255}$

Required idempotency key for this completion action.

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

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

200Current adjustment, including any pending refund reservation or remaining open amount.

400Malformed request syntax

401Unauthenticated

403Forbidden or step-up MFA required

404Resource not found

409Conflict

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

422Validation error

501This operation is not yet available