Skip to main content
Parmana Transaction API. Retrieve Business Transactions.

TransactionApi Objects

Transaction API.

Responsibilities

  • Declare a Business Transaction (POST /transactions), then execute it (POST /transactions/{id}/execute), as two calls (decision D23)
  • Read its status, and reconcile one whose outcome is pending
  • Retrieve Business Transactions
  • List Business Transactions
This API does NOT:
  • verify trust records
  • replay executions
  • generate receipts

declare

Declare a Business Transaction (POST /transactions). The transaction is accepted and recorded as RECEIVED. Nothing is decided, signed or released; call execute() to release it.

Parameters

transaction: Business Transaction to declare.

Returns

The declared transaction, with status RECEIVED.

execute

Execute a declared Business Transaction (POST /transactions/{id}/execute).

Parameters

business_transaction_id: Identifier of a transaction declared with declare().

Returns

Execution Trust Record.

create

Declare and then execute a Business Transaction, in two calls. Before decision D23 the API offered this as one call. It is kept so existing callers keep working.

Parameters

transaction: Business Transaction submitted to the Parmana Runtime.

Returns

Execution Trust Record.

status

Read the status of a Business Transaction (GET /transactions/{id}/status).

Parameters

business_transaction_id: Business Transaction identifier. history: Include every status event, oldest first.

Returns

The current status, and the history when requested.

reconcile

Reconcile a Business Transaction whose outcome is pending (POST /transactions/{id}/reconcile). Operator credentials only.

Parameters

business_transaction_id: Business Transaction identifier.

Returns

Whether the status changed, and the status now.

get

Retrieve a Business Transaction.

Parameters

business_transaction_id: Business Transaction identifier.

Returns

Business Transaction.

list

List Business Transactions.

Parameters

page: Page number. page_size: Number of transactions per page.

Returns

List of Business Transactions.

__call__

Makes client.transactions(page=..., page_size=...) work directly, alongside the existing client.transactions.list(...) (and .get(...), .create(...)), without renaming the ParmanaClient.transactions attribute out from under existing callers (examples/08_list_transactions.py, examples/11_end_to_end.py).