Skip to main content
POST
Report a payment
Draft documentation — API not yet rolled out. This endpoint describes the preview contract and may change before release. Sandbox access is provided separately. See access and limitations.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string<uuid>
required

UUID of the invoice in this request.

Body

application/json

A payment reported against an invoice. A partial payment reduces the balance while dunning continues over the full amount; once the reported total covers the amount, the invoice is marked paid and dunning stops.

amount
required

Decimal string (preferred) or JSON number.

Pattern: ^[0-9]{1,10}(?:\.[0-9]{1,2})?$
value_date
string<date>
required

Date the payment was received; must not be in the future. Together with amount and reference, it identifies an identical repeated payment report.

reference
string | null

Optional payment reference. Omitted, blank and null references are treated alike. A repeat with the same invoice, amount, value_date and nonempty reference (compared case-insensitively) returns the existing payment (200). An identical unreferenced payment returns 409 duplicate_payment; use a distinct reference for a genuine second payment.

Maximum string length: 255

Response

A payment reported against an invoice. A partial payment reduces the balance while dunning continues over the full amount; once the reported total covers the amount, the invoice is marked paid and dunning stops.

id
string<uuid>
required
read-only
amount
string<decimal>
required

Amount received toward the invoice in its currency, expressed in major units and greater than zero. Partial payments reduce balance; covering the full invoice stops dunning unless it has already been handed to debt collection.

Pattern: ^[0-9]{1,10}(?:\.[0-9]{1,2})?$
value_date
string<date>
required

Date the payment was received; must not be in the future. Together with amount and reference, it identifies an identical repeated payment report.

created
string<date-time>
required
read-only
reference
string | null

Optional payment reference. Omitted, blank and null references are treated alike. A repeat with the same invoice, amount, value_date and nonempty reference (compared case-insensitively) returns the existing payment (200). An identical unreferenced payment returns 409 duplicate_payment; use a distinct reference for a genuine second payment.

Maximum string length: 255