Class TPayBlikModule

TPayBlikModule provides methods for managing BLIK aliases and recurring payments.

See

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

Hierarchy (View Summary)

SDKModule
- TPayBlikModule

Index

Constructors

Properties

Methods

createAlias deleteAlias getAlias

Constructors

constructor

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

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

createAlias

createAlias(aliasData: CreateAliasRequest): Promise<CreateAliasResponse>
Request establishing of new alias without processing payment
Parameters
- aliasData: CreateAliasRequest
  Alias configuration data
Returns Promise<CreateAliasResponse>
Promise resolving to alias creation response

See
https://openapi.sandbox.tpay.com/#tag/Blik/operation/post_post_blik_alias
- Defined in src/blik/index.ts:20

deleteAlias

deleteAlias(alias: string, deleteData: DeleteAliasRequest): Promise<void>
Request deletion of previously established alias
Parameters
- alias: string
  Alias value
- deleteData: DeleteAliasRequest
  Alias type specification
Returns Promise<void>
Promise resolving to void (204 No Content)

See
https://openapi.sandbox.tpay.com/#tag/Blik/operation/delete_delete_blik_alias
- Defined in src/blik/index.ts:44

getAlias

getAlias(alias: string, aliasType: "UID" | "PAYID"): Promise<GetAliasResponse>
Fetch previously established alias details
Parameters
- alias: string
  Alias value
- aliasType: "UID" | "PAYID"
  Type of the alias to fetch (UID or PAYID)
Returns Promise<GetAliasResponse>
Promise resolving to alias details

See
https://openapi.sandbox.tpay.com/#tag/Blik/operation/get_get_blik_alias
- Defined in src/blik/index.ts:31