Skip to navigation
TIANKII API - API KeyCheckout Invoice

Get invoice status

View as Markdown

Get invoice status

Lightweight status poll for the invoice :id. It re-evaluates the invoice against the connector and returns only { status } — use it as the polling endpoint on a checkout screen. For the full checkout payload use GET /invoice/:id/checkout.

Auth

x-api-key header with Merchant.invoice.read. Also accepts JWT user, POS JWT and limited JWT tokens.

Path params

  • id (required): the invoice id.

There is no request body.

Notas: Handler: statusService.getStatus({ invoiceId, complete: false }) — the complete: false short-circuit is what makes this cheaper than /checkout. Replaces the deprecated GET /v1/invoice/status?invoiceId=.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the invoice to poll.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.