Skip to main content
POST
Settle Invoice Payment

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The invoice ID

Body

application/json
method
enum<string>
required

How the invoice is settled. hosted_link creates a new payment link and emails it to the customer. out_of_band records a payment collected outside Paygentic and marks the invoice as PAID.

Available options:
out_of_band,
hosted_link
reason
string

Optional note for out_of_band that describes how you received the payment (for example, 'Wire transfer received 2026-03-25'). Ignored for hosted_link.

Maximum string length: 500

Response

The invoice is settled, or a new payment link exists. The method field identifies the shape: out_of_band returns the PAID invoice; hosted_link returns the provider and the new payment link.

method
enum<string>
required

Discriminator: an out-of-band payment was recorded.

Available options:
out_of_band
invoice
object
required

The invoice, now PAID.