Class: TransactionApi

Defined in: typescript/src/client/TransactionApi.ts:28 Transaction API.

​

Responsibilities

• Create (execute) a Business Transaction via POST /transactions
• Retrieve Business Transactions
• List Business Transactions

This API does NOT:

• verify trust records
• replay executions
• generate receipts

​

Constructors

​

Constructor

new TransactionApi(transport): TransactionApi

Defined in: typescript/src/client/TransactionApi.ts:29

​

Parameters

transport

Transport

​

Returns

TransactionApi

​

Methods

​

create()

create(transaction): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/TransactionApi.ts:39 Create (execute) a Business Transaction. Maps to POST /transactions: a second, independent entry point into the identical application.execute() pipeline as ExecutionApi.execute() (POST /execute). The only behavioral difference is the success status code, 201 instead of 200; the response body shape is otherwise identical.

​

Parameters

transaction

BusinessTransaction

​

Returns

Promise<ExecutionTrustRecord>

---

​

get()

get(businessTransactionId): Promise<BusinessTransaction>

Defined in: typescript/src/client/TransactionApi.ts:54 Retrieve a Business Transaction.

​

Parameters

businessTransactionId

string

​

Returns

Promise<BusinessTransaction>

---

​

list()

list(page?, pageSize?): Promise<BusinessTransaction[]>

Defined in: typescript/src/client/TransactionApi.ts:68 List Business Transactions.

​

Parameters

page?

number = 1

pageSize?

number = 25

​

Returns

Promise<BusinessTransaction[]>