Class TPayTransactionsModule

TPayTransactionsModule provides methods for creating and managing simple merchant transactions.

See

https://openapi.sandbox.tpay.com/#tag/Transactions

Hierarchy (View Summary)

SDKModule
- TPayTransactionsModule

Index

Constructors

constructor

new TPayTransactionsModule(apiClient: AxiosInstance): TPayTransactionsModule
Parameters
- apiClient: AxiosInstance
Returns TPayTransactionsModule
Inherited from SDKModule.constructor
- Defined in src/types/module.ts:6

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

cancelTransaction

cancelTransaction(
transactionId: string | TransactionId,
): Promise<TPayResponse<void, never>>
Request cancellation of transaction
Parameters
- transactionId: string | TransactionId
  Transaction identifier
Returns Promise<TPayResponse<void, never>>
Promise resolving to success response

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/post_transactions_cancel
- Defined in src/transactions/index.ts:100

createRefund

createRefund(
    transactionId: string | TransactionId,
    refundData?: TPay.Transactions.CreateRefundRequest,
): Promise<
    TPayFlatResponse<
        TransactionDetails & {
            refundsCardsList: Refund[];
            refundsList: Refund[];
            refundsNoAccountList: Refund[];
        },
    >,
>
Request refund for given transaction in full or partial amount
Parameters
- transactionId: string | TransactionId
  Transaction identifier
- OptionalrefundData: TPay.Transactions.CreateRefundRequest
  Refund details (empty object for full refund)
Returns Promise<
    TPayFlatResponse<
        TransactionDetails & {
            refundsCardsList: Refund[];
            refundsList: Refund[];
            refundsNoAccountList: Refund[];
        },
    >,
>
Promise resolving to transaction with refunds list

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/post_transactions_create_refunds
- Defined in src/transactions/index.ts:86

createTransaction

createTransaction(
transaction: CreateTransactionRequest,
): Promise<CreateTransactionResponse>
Create new transaction
Parameters
- transaction: CreateTransactionRequest
  Transaction data
Returns Promise<CreateTransactionResponse>
Promise resolving to created transaction with payment URL

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/post_transactions_create
- Defined in src/transactions/index.ts:39

generateQRCode

generateQRCode(
transactionId: string | TransactionId,
qrData: QRCodeRequest,
): Promise<Blob>
Generate QR code containing redirection to paywall for given transaction
Parameters
- transactionId: string | TransactionId
  Transaction ULID
- qrData: QRCodeRequest
  QR code configuration
Returns Promise<Blob>
Promise resolving to QR code image

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/post_transactions_qr
- Defined in src/transactions/index.ts:135

getBankGroups

getBankGroups(
onlyOnline?: boolean,
): Promise<TPayResponse<BankGroup[], "groups">>
Fetch list of available bank groups
Parameters
- OptionalonlyOnline: boolean
  If true, returns only online payment groups
Returns Promise<TPayResponse<BankGroup[], "groups">>
Promise resolving to list of bank groups

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/get_transactions_get_bank_groups
- Defined in src/transactions/index.ts:110

getChannels

getChannels(): Promise<
    { requestId: string; result: "error"
    | "success" } & { channels: PaymentChannel[] } & {
        currency: string;
        language: string;
    },
>
Fetch list of available payment channels

Returns Promise<
    { requestId: string; result: "error"
    | "success" } & { channels: PaymentChannel[] } & {
        currency: string;
        language: string;
    },
>
Promise resolving to list of payment channels

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/get_transactions_get_channels
- Defined in src/transactions/index.ts:121

getRefunds

getRefunds(
    transactionId: string | TransactionId,
    params?: TransactionListParams,
): Promise<
    TPayFlatResponse<
        TransactionDetails & {
            refundsCardsList: Refund[];
            refundsList: Refund[];
            refundsNoAccountList: Refund[];
        },
    >,
>
Fetch list of refunds for given transaction
Parameters
- transactionId: string | TransactionId
  Transaction identifier
- Optionalparams: TransactionListParams
  Query parameters for filtering refunds
Returns Promise<
    TPayFlatResponse<
        TransactionDetails & {
            refundsCardsList: Refund[];
            refundsList: Refund[];
            refundsNoAccountList: Refund[];
        },
    >,
>
Promise resolving to transaction with refunds list

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/get_transactions_get_refunds
- Defined in src/transactions/index.ts:71

getTransaction

getTransaction(
transactionId: string | TransactionId,
): Promise<TPayFlatResponse<TransactionDetails>>
Fetch given transaction details and status
Parameters
- transactionId: string | TransactionId
  Transaction identifier
Returns Promise<TPayFlatResponse<TransactionDetails>>
Promise resolving to transaction details

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/get_transaction_get
- Defined in src/transactions/index.ts:49

getTransactions

getTransactions(
params?: TransactionListParams,
): Promise<TPayPaginatedResponse<Transaction[], "transactions">>
Fetch list of transactions
Parameters
- Optionalparams: TransactionListParams
  Query parameters for filtering transactions
Returns Promise<TPayPaginatedResponse<Transaction[], "transactions">>
Promise resolving to paginated list of transactions

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/get_transactions_get
- Defined in src/transactions/index.ts:29

payTransaction

payTransaction(
transactionId: string | TransactionId,
paymentData: Pay,
): Promise<CreateTransactionResponse>
Submit payment details for transaction (for selected payment methods)
Parameters
- transactionId: string | TransactionId
  Transaction identifier
- paymentData: Pay
  Payment details
Returns Promise<CreateTransactionResponse>
Promise resolving to transaction response with payment status

See
https://openapi.sandbox.tpay.com/#tag/Transactions/operation/post_transactions_pay
- Defined in src/transactions/index.ts:60

Class TPayTransactionsModule

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TPayTransactionsModule

Properties

ProtectedapiClient_

Methods

cancelTransaction

Parameters

Returns Promise<TPayResponse<void, never>>

See

createRefund

Parameters

Returns Promise< TPayFlatResponse< TransactionDetails & { refundsCardsList: Refund[]; refundsList: Refund[]; refundsNoAccountList: Refund[]; }, >,>

See

createTransaction

Parameters

Returns Promise<CreateTransactionResponse>

See

generateQRCode

Parameters

Returns Promise<Blob>

See

getBankGroups

Parameters

Returns Promise<TPayResponse<BankGroup[], "groups">>

See

getChannels

Returns Promise< { requestId: string; result: "error" | "success" } & { channels: PaymentChannel[] } & { currency: string; language: string; },>

See

getRefunds

Parameters

Returns Promise< TPayFlatResponse< TransactionDetails & { refundsCardsList: Refund[]; refundsList: Refund[]; refundsNoAccountList: Refund[]; }, >,>

See

getTransaction

Parameters

Returns Promise<TPayFlatResponse<TransactionDetails>>

See

getTransactions

Parameters

Returns Promise<TPayPaginatedResponse<Transaction[], "transactions">>

See

payTransaction

Parameters

Returns Promise<CreateTransactionResponse>

See

Settings

On This Page

`Protected`apiClient_

Returns Promise<
TPayFlatResponse<
TransactionDetails & {
refundsCardsList: Refund[];
refundsList: Refund[];
refundsNoAccountList: Refund[];
},
>,
>

Returns Promise<
{ requestId: string; result: "error"
| "success" } & { channels: PaymentChannel[] } & {
currency: string;
language: string;
},
>

Returns Promise<
TPayFlatResponse<
TransactionDetails & {
refundsCardsList: Refund[];
refundsList: Refund[];
refundsNoAccountList: Refund[];
},
>,
>