Skip to main content
POST
Tenant credential
Required scopes: invoices.settle.

Authorizations

X-API-Key
string
header
required

Tenant credential. This is sufficient by itself.

Headers

X-PrintTools-Organization-Id
string<uuid>

Tenant credential: optional and, when sent, must equal the shop bound to the key. Partner credential: required; it selects an organisation the user previously authorised.

Idempotency-Key
string

Optional client-generated key for write retries. Reusing it with a different request returns 409; a replay includes Idempotency-Replayed: true.

Required string length: 1 - 200

Path Parameters

invoiceId
string<uuid>
required

UUID.

Example:

"11111111-2222-3333-4444-555555555555"

Body

application/json
method
string
required

bank_transfer | cash | card | other (pinch payments record themselves).

reference
string

Bank/receipt reference for the audit trail.

paidAt
string<date-time>

When the payment landed; defaults to now.

Response

Successful response.

Every 2xx response uses this envelope.

status
boolean
required

The actual resolver result. It can be false when an operation returns false or null without throwing.

message
string
required
Example:

"OK"

data
object
required