Class TPayCollectModule

TPayCollectModule provides methods for managing trusted bank accounts for collect transactions.

See

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

Hierarchy (View Summary)

SDKModule
- TPayCollectModule

Index

Constructors

Properties

Methods

addBankAccount getBankAccounts

Constructors

constructor

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

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

addBankAccount

addBankAccount(
bankAccountData: AddBankAccountRequest,
): Promise<AddBankAccountResponse>
Adding a bank account to the trusted list
Parameters
- bankAccountData: AddBankAccountRequest
  Bank account details
Returns Promise<AddBankAccountResponse>
Promise resolving to created bank account details

See
https://openapi.sandbox.tpay.com/#tag/Collect/operation/post_collect_bank_accounts_post
- Defined in src/collect/index.ts:31

getBankAccounts

getBankAccounts(
params?: BankAccountListParams,
): Promise<
TPayPaginatedResponse<TPay.Collect.BankAccount[], "bankAccounts">,
>
Fetch list of trusted bank accounts
Parameters
- Optionalparams: BankAccountListParams
  Query parameters for pagination
Returns Promise<TPayPaginatedResponse<TPay.Collect.BankAccount[], "bankAccounts">>
Promise resolving to paginated list of bank accounts

See
https://openapi.sandbox.tpay.com/#tag/Collect/operation/get_collect_bank_accounts_get
- Defined in src/collect/index.ts:21