Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.

Path Parameters

businessTransactionId
string<uuid>
required

The businessTransactionId the transaction was declared with.

Query Parameters

history
enum<string>

Set to true to include the full status history.

Available options:
true,
false

Response

The current status, and the history when requested.

businessTransactionId
string
required
current
object
required

One append-only status event of a Business Transaction (decision D23).

history
object[]