Skip to main content
POST
Confirm a Transaction's Reservations

Authorizations

X-API-Key
string
header
required

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

Headers

Content-Type
string
required

The type of media of the resource. Must be application/json.

X-API-Key
string
required

The API Key for authentication. This header is required for all endpoints except health checks.

X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Path Parameters

transaction_id
string<uuid>
required

The ledger transaction correlation ID whose reservations you want to confirm or release.

Response

Indicates that the transaction's reservations were confirmed.

Body returned by the by-transaction confirm and release endpoints.

transactionId
string<uuid>
required

The ledger transaction whose reservations were transitioned.

status
enum<string>
required

The terminal state the reservations resolved to.

Available options:
CONFIRMED,
RELEASED
flipped
integer
required

How many reservations were transitioned. A value of 0 is a valid, idempotent no-op — the transaction held no open reservations.