Edit an off-platform payment entry

patch

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

Edits the caller's own off-platform payment entry. Only the party that recorded the entry may edit it; the counterparty receives 403 and an unrelated caller 404. Entries collected or received by Wingspan return 409. An edited amount may not exceed the entry's current amount plus amountDue minus pending document-targeted credits (422). The document status re-derives and InvoicePayment.Updated fires.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

string

required

paymentId

string

required

Body Params

Edit of the caller's own off-platform payment entry. Only the listed fields are editable. An edited amount may not exceed the entry's current amount plus amountDue minus pending document-targeted credits (422).

updateMask

array of strings

required

length ≥ 1

The public field names this request changes (R-UPD-02).

updateMask*

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.

receivedAmount

double

Gross amount received. When it is not stored (it equalled amount), an edit to amount alone moves it too.

paidDate

date

paymentMethodDescription

string

referenceNumber

string | null

Null clears.

notes

string | null

Null clears.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

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.

If-Match

string

required

Strong ETag from the latest resource GET or write response.

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

200Entry updated

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

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

422Validation error

501This operation is not yet available