Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / TransactionService

Class: TransactionService

Platform-Agnostic Transaction Service

Contains transaction business logic and operations that work across platforms. No framework dependencies - pure TypeScript business logic.

Focuses only on actual backend capabilities.

Table of contents

Constructors

Methods

Constructors

constructor

• new TransactionService(transactionApi): TransactionService

Parameters

NameType
transactionApiTransactionApi

Returns

TransactionService

Defined in

transaction/services/transaction-service.ts:15

Methods

getTransactionById

▸ getTransactionById(transactionId, include?): Promise<TransactionDTO>

Get transaction by ID

Parameters

NameTypeDescription
transactionIdstringTransaction ID
include?TransactionIncludeRelation[]Optional relations to include (sender, recipient, business)

Returns

Promise<TransactionDTO>

Defined in

transaction/services/transaction-service.ts:23


createTransaction

▸ createTransaction(request): Promise<TransactionRequestResponseDTO>

AUTH: Create authenticated transaction

Parameters

NameType
requestTransactionRequestDTO

Returns

Promise<TransactionRequestResponseDTO>

Defined in

transaction/services/transaction-service.ts:41


submitSignedTransaction

▸ submitSignedTransaction(signedTxData): Promise<TransactionRequestResponseDTO>

Parameters

NameType
signedTxDataTransactionSubmissionRequestDTO

Returns

Promise<TransactionRequestResponseDTO>

Defined in

transaction/services/transaction-service.ts:45


getUserTransactionHistory

▸ getUserTransactionHistory(options?): Promise<PaginatedResponseDTO<TransactionDTO>>

AUTH: Get user transaction history with comprehensive filtering

Parameters

NameTypeDescription
options?TransactionQueryParamsQuery options including filters, pagination, and include relations

Returns

Promise<PaginatedResponseDTO<TransactionDTO>>

Paginated transaction history

Defined in

transaction/services/transaction-service.ts:55


prepareExistingTransaction

▸ prepareExistingTransaction(transactionId): Promise<TransactionRequestResponseDTO>

AUTH: Prepare existing transaction for client-side signing

Parameters

NameType
transactionIdstring

Returns

Promise<TransactionRequestResponseDTO>

Defined in

transaction/services/transaction-service.ts:64


prepareClientSignedTransaction

▸ prepareClientSignedTransaction(request): Promise<TransactionRequestResponseDTO>

AUTH: Prepare client signed transaction

Parameters

NameType
requestTransactionRequestDTO

Returns

Promise<TransactionRequestResponseDTO>

Defined in

transaction/services/transaction-service.ts:71


getPaginatedTransactions

▸ getPaginatedTransactions(options): Promise<PaginatedResponseDTO<TransactionDTO>>

ADMIN: Get paginated transactions with filtering and sorting

Parameters

NameType
optionsTransactionPaginationRequestDTO & { include?: TransactionIncludeRelation[] }

Returns

Promise<PaginatedResponseDTO<TransactionDTO>>

Defined in

transaction/services/transaction-service.ts:100


exportTransactionsCSV

▸ exportTransactionsCSV(options?): Promise<Blob>

ADMIN: Export transactions to CSV

Parameters

NameType
options?Object
options.dateFrom?string
options.dateTo?string

Returns

Promise<Blob>

Defined in

transaction/services/transaction-service.ts:111


queryTransactionsBySender

▸ queryTransactionsBySender(accountSelector): Promise<PaginatedResponseDTO<TransactionDTO>>

Query transactions by sender

Parameters

NameType
accountSelectorAccountSelectorDTO

Returns

Promise<PaginatedResponseDTO<TransactionDTO>>

Defined in

transaction/services/transaction-service.ts:122


queryTransactionsByRecipient

▸ queryTransactionsByRecipient(accountSelector): Promise<PaginatedResponseDTO<TransactionDTO>>

Query transactions by recipient

Parameters

NameType
accountSelectorAccountSelectorDTO

Returns

Promise<PaginatedResponseDTO<TransactionDTO>>

Defined in

transaction/services/transaction-service.ts:129


getTransactionAnalytics

▸ getTransactionAnalytics(analyticsRequest): Promise<TransactionAnalyticsResponseDTO>

ADMIN: Get transaction analytics

Parameters

NameType
analyticsRequestTransactionAnalyticsRequestDTO

Returns

Promise<TransactionAnalyticsResponseDTO>

Defined in

transaction/services/transaction-service.ts:136