Create a credit

post

https://api.wingspan.app/v3/payments/credits

Create a credit without applying it. invoiceId defaults strategy to Manual; otherwise strategy defaults to Automatic. The target must be an eligible payee invoice and the entire credit must fit its remaining room after other targeted credits.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a payee credit without applying it. With invoiceId the strategy defaults to Manual; otherwise it defaults to Automatic. Automatic with invoiceId returns 422. A target must be a payee invoice in Created, Pending, Opened or Overdue, with no active or completed payment, of the same relationship and currency. The whole available credit must fit after other targeted credits; otherwise 422 Credit exceeds the amount left on this invoice.

payerId

string

required

length ≥ 1

invoiceId

string

amount

double

required

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.

currency

string

enum

required

ISO 4217 currency code

reason

string

required

length ≥ 1

Commercial credit reason, such as Goodwill, ServiceFailure or Other.

name

string

Display name; defaults to reason.

memo

string

applicationStrategy

string

enum

Automatic applies at payment on or after startDate. Manual applies only to its target invoice.

Allowed:

startDate

Automatic eligibility instant. A date-only value means midnight UTC. Ignored for Manual credits.

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.

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

201Credit created

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error