Class TPayMarketplaceModule

TPayMarketplaceModule provides methods for creating and managing multi-merchant transactions.

See

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

Hierarchy (View Summary)

SDKModule
- TPayMarketplaceModule

Index

Constructors

Properties

Methods

cancelTransaction createRefund createTransaction getBankGroups getTransaction payTransaction

Constructors

constructor

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

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

cancelTransaction

cancelTransaction(transactionId: string | TransactionId): Promise<void>
Cancel marketplace transaction
Parameters
- transactionId: string | TransactionId
  Transaction ULID
Returns Promise<void>
Promise resolving to void (200 OK)

See
https://openapi.sandbox.tpay.com/#tag/Marketplace/operation/post_marketplace_transaction_cancel
- Defined in src/marketplace/index.ts:82

createRefund

createRefund(
transactionId: string | TransactionId,
refundData: CreateMarketplaceRefundRequest,
): Promise<CreateMarketplaceRefundResponse>
Create new refund for marketplace transaction
Parameters
- transactionId: string | TransactionId
  Transaction ULID
- refundData: CreateMarketplaceRefundRequest
  Refund details
Returns Promise<CreateMarketplaceRefundResponse>
Promise resolving to refund response

See
https://openapi.sandbox.tpay.com/#tag/Marketplace/operation/post_marketplace_transaction_refund
- Defined in src/marketplace/index.ts:72

createTransaction

createTransaction(
transaction: CreateMarketplaceTransactionRequest,
): Promise<CreateMarketplaceTransactionResponse>
Create new marketplace transaction
Parameters
- transaction: CreateMarketplaceTransactionRequest
  Marketplace transaction data
Returns Promise<CreateMarketplaceTransactionResponse>
Promise resolving to transaction with payment URL

See
https://openapi.sandbox.tpay.com/#tag/Marketplace/operation/post_marketplace_transaction_create
- Defined in src/marketplace/index.ts:27

getBankGroups

getBankGroups(
merchantIds: GetBankGroupsRequest,
): Promise<TPayResponse<MarketplaceBankGroup[], "groups">>
Fetch list of Bank Groups available for given merchant's accounts
Parameters
- merchantIds: GetBankGroupsRequest
  List of merchant IDs
Returns Promise<TPayResponse<MarketplaceBankGroup[], "groups">>
Promise resolving to available bank groups

See
https://openapi.sandbox.tpay.com/#tag/Marketplace/operation/get_marketplace_get_bank_groups
- Defined in src/marketplace/index.ts:59

getTransaction

getTransaction(
transactionId: string | TransactionId,
params?: GetMarketplaceTransactionParams,
): Promise<MarketplaceTransactionDetails>
Fetch details and status of given transaction
Parameters
- transactionId: string | TransactionId
  Transaction ULID
- Optionalparams: GetMarketplaceTransactionParams
  Optional parameters (e.g., withPaymentAttempts)
Returns Promise<MarketplaceTransactionDetails>
Promise resolving to transaction details

See
https://openapi.sandbox.tpay.com/#tag/Marketplace/operation/get_marketplace_transaction_get
- Defined in src/marketplace/index.ts:38

payTransaction

payTransaction(
transactionId: string | TransactionId,
paymentData: PayMarketplaceTransactionRequest,
): Promise<any>
Provide payment details for marketplace transaction (applies to selected payment methods)
Parameters
- transactionId: string | TransactionId
  Transaction ULID
- paymentData: PayMarketplaceTransactionRequest
  Payment details
Returns Promise<any>
Promise resolving to payment response

See
https://openapi.sandbox.tpay.com/#tag/Marketplace/operation/post_marketplace_transaction_pay
- Defined in src/marketplace/index.ts:49