Skip to main content

Class: PaymentsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:43

Extends​

  • BaseService

Constructors​

Constructor​

new PaymentsService(client): PaymentsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters​

client​

TanqoryClient

Returns​

PaymentsService

Inherited from​

BaseService.constructor

Properties​

client​

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from​

BaseService.client

Methods​

buildQuery()​

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters​

options?​

ListOptions

Returns​

Record<string, any>

Inherited from​

BaseService.buildQuery

cancelSession()​

cancelSession(storeId, sessionId): Promise<PaymentSession>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:92

Cancel a payment session

Parameters​

storeId​

string

sessionId​

string

Returns​

Promise<PaymentSession>

captureSession()​

captureSession(storeId, sessionId, data?): Promise<PaymentSession>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:81

Capture a payment session

Parameters​

storeId​

string

sessionId​

string

data?​
amount?​

number

Returns​

Promise<PaymentSession>

confirmSession()​

confirmSession(storeId, sessionId, data?): Promise<PaymentSession>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:70

Confirm a payment session

Parameters​

storeId​

string

sessionId​

string

data?​
paymentMethodId?​

string

Returns​

Promise<PaymentSession>

createSession()​

createSession(storeId, data): Promise<PaymentSession>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:47

Create a payment session

Parameters​

storeId​

string

data​

CreatePaymentSessionParams

Returns​

Promise<PaymentSession>

generateIdempotencyKey()​

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters​

prefix​

string

Returns​

string

Inherited from​

BaseService.generateIdempotencyKey

getExportMimeType()​

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters​

format​

string

Returns​

string

Inherited from​

BaseService.getExportMimeType

getOrderTransactions()​

getOrderTransactions(storeId, orderId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:127

Get transactions for a specific order

Parameters​

storeId​

string

orderId​

string

Returns​

Promise<any>

getTransactionSummary()​

getTransactionSummary(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:117

Get transaction summary (totals, counts)

Parameters​

storeId​

string

Returns​

Promise<any>

listSessions()​

listSessions(storeId, options?): Promise<PaginatedResponse<PaymentSession>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:55

List payment sessions

Parameters​

storeId​

string

options?​

ListOptions

Returns​

Promise<PaginatedResponse<PaymentSession>>

listTransactions()​

listTransactions(storeId, options?): Promise<PaginatedResponse<any>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:110

List payment transactions for a store

Parameters​

storeId​

string

options?​

ListOptions

Returns​

Promise<PaginatedResponse<any>>

refundSession()​

refundSession(storeId, sessionId, data?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:97

Refund a payment session

Parameters​

storeId​

string

sessionId​

string

data?​
amount?​

number

reason?​

string

Returns​

Promise<any>

retrieveSession()​

retrieveSession(storeId, sessionId): Promise<PaymentSession>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:65

Retrieve a payment session

Parameters​

storeId​

string

sessionId​

string

Returns​

Promise<PaymentSession>

retrieveTransaction()​

retrieveTransaction(storeId, transactionId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/payments.ts:122

Retrieve a specific transaction

Parameters​

storeId​

string

transactionId​

string

Returns​

Promise<any>