Verify an invoice payment
Confirm/settle the payment state of the token tenant’s invoice, idempotently transitioning it to paid or pending. Requires the invoices:read scope.
Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Path Parameters
The id.
Body
Optional body for confirming an invoice payment. A missing or empty body is valid (legacy parity). Only stripePaymentIntentId is read.
Optional Stripe PaymentIntent id to settle a card/3DS payment. If omitted, settlement is resolved from the invoice's stored Stripe or payment-provider state.
Response
Settlement result: the resulting status (paid/pending/processing), a message, and whether it was already processed.
Envelope wrapping the invoice verification result.
Result of confirming/settling an invoice payment. The success flag from the use-case is stripped; the remaining fields are returned as data. Permissive: extra fields may appear depending on the settlement rail.