Class TPayAccountsModule

TPayAccountsModule provides methods for managing merchant accounts, categories, legal forms, and related entities. Requires Partner API authentication.

See

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

Hierarchy (View Summary)

SDKModule
- TPayAccountsModule

Index

Constructors

Properties

Methods

createAccount createMerchant getAccount getAccounts getCategories getCategory getDocumentType getDocumentTypes getLegalForm getLegalForms getMCCs getPOS

Constructors

constructor

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

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

createAccount

createAccount(account: Account): Promise<TPayFlatResponse<AccountDetails>>
Create new account
Parameters
- account: Account
  Account data
Returns Promise<TPayFlatResponse<AccountDetails>>
Promise resolving to created account details

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/post_post_accounts
- Defined in src/accounts/index.ts:42

createMerchant

createMerchant(account: Account): Promise<TPayFlatResponse<AccountDetails>>
Create new merchant account (v1 endpoint)
Parameters
- account: Account
  Account data
Returns Promise<TPayFlatResponse<AccountDetails>>
Promise resolving to created merchant account details

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/post_post_merchants
- Defined in src/accounts/index.ts:137

getAccount

getAccount(accountId: string | AccountId): Promise<AccountDetails>
Fetch merchant's account details
Parameters
- accountId: string | AccountId
  Account identifier
Returns Promise<AccountDetails>
Promise resolving to account details

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_account
- Defined in src/accounts/index.ts:127

getAccounts

getAccounts(
params?: AccountListParams,
): Promise<TPayPaginatedResponse<Account[], "list">>
Fetch list of merchant's accounts
Parameters
- Optionalparams: AccountListParams
  Optional pagination parameters
Returns Promise<TPayPaginatedResponse<Account[], "list">>
Promise resolving to paginated list of accounts

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_accounts
- Defined in src/accounts/index.ts:32

getCategories

getCategories(): Promise<TPayPaginatedResponse<AccountCategory[], "list">>
Get list of account categories

Returns Promise<TPayPaginatedResponse<AccountCategory[], "list">>
Promise resolving to paginated list of categories

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_categories
- Defined in src/accounts/index.ts:51

getCategory

getCategory(
categoryId: number | CategoryId,
): Promise<TPayFlatResponse<AccountCategory>>
Get specified category by its ID
Parameters
- categoryId: number | CategoryId
  Category identifier
Returns Promise<TPayFlatResponse<AccountCategory>>
Promise resolving to category details

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_category
- Defined in src/accounts/index.ts:61

getDocumentType

getDocumentType(
documentTypeId: number | DocumentTypeId,
): Promise<TPayFlatResponse<DocumentType>>
Get a single document type
Parameters
- documentTypeId: number | DocumentTypeId
  Document type identifier
Returns Promise<TPayFlatResponse<DocumentType>>
Promise resolving to document type details

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_document
- Defined in src/accounts/index.ts:117

getDocumentTypes

getDocumentTypes(): Promise<TPayPaginatedResponse<DocumentType[], "list">>
Get list of all document types

Returns Promise<TPayPaginatedResponse<DocumentType[], "list">>
Promise resolving to paginated list of document types

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_documents
- Defined in src/accounts/index.ts:107

getLegalForm

getLegalForm(
legalFormId: number | LegalFormId,
): Promise<TPayFlatResponse<AccountLegalForm>>
Get specified legal form by its ID
Parameters
- legalFormId: number | LegalFormId
  Legal form identifier
Returns Promise<TPayFlatResponse<AccountLegalForm>>
Promise resolving to legal form details

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_legal_form
- Defined in src/accounts/index.ts:80

getLegalForms

getLegalForms(): Promise<TPayPaginatedResponse<AccountLegalForm[], "list">>
Get list of account Legal Forms

Returns Promise<TPayPaginatedResponse<AccountLegalForm[], "list">>
Promise resolving to paginated list of legal forms

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_legal_forms
- Defined in src/accounts/index.ts:70

getMCCs

getMCCs(): Promise<TPayPaginatedResponse<AccountMCC[], "list">>
Get list of account MCCs (Merchant Category Codes)

Returns Promise<TPayPaginatedResponse<AccountMCC[], "list">>
Promise resolving to paginated list of MCCs

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_mccs
- Defined in src/accounts/index.ts:89

getPOS

getPOS(): Promise<TPayResponse<AccountPOS[], "list">>
Get list of account POS (Point of Sale) systems

Returns Promise<TPayResponse<AccountPOS[], "list">>
Promise resolving to list of POS systems

See
https://openapi.sandbox.tpay.com/#tag/Accounts/operation/get_get_accounts_pos
- Defined in src/accounts/index.ts:98