Skip to navigation
TIANKII API - API KeyCheckout Invoice

Get checkout payload

View as Markdown

Get invoice checkout payload

Returns the full checkout representation (InvoicePosDto) of the invoice :id: current status, resolved payment method, crypto amount and payment destination, exchange rates and the hosted invoice URL. This is what a checkout page needs to render the payment.

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: true }). Same handler as GET /invoice/:id/status but returns the complete formatted payload. The DTO keeps deprecated aliases (rate, satsDue, cryptoCode, btcAddress, nationalRate, invoiceWallet, btcDue) — prefer exchangeRate, cryptoAmount, paymentType, paymentDestination, usdExchangeRate.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the invoice to render at checkout.

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.