Class TPayTokenizationModule

TPayTokenizationModule provides methods for creating and managing card tokens.

See

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

Hierarchy (View Summary)

SDKModule
- TPayTokenizationModule

Index

Constructors

Properties

Methods

createToken deleteToken getToken

Constructors

constructor

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

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

createToken

createToken(tokenData: CreateTokenRequest): Promise<CreateTokenResponse>
Request creation of new card token without processing payment
Parameters
- tokenData: CreateTokenRequest
  Token configuration data
Returns Promise<CreateTokenResponse>
Promise resolving to token creation response with URL

See
https://openapi.sandbox.tpay.com/#tag/Tokenization/operation/post_tokens_create
- Defined in src/tokenization/index.ts:20

deleteToken

deleteToken(tokenValue: string | TokenValue): Promise<void>
Request removal of previously established card token
Parameters
- tokenValue: string | TokenValue
  Token value
Returns Promise<void>
Promise resolving to void (204 No Content)

See
https://openapi.sandbox.tpay.com/#tag/Tokenization/operation/delete_tokens_delete
- Defined in src/tokenization/index.ts:40

getToken

getToken(tokenValue: string | TokenValue): Promise<TokenDetails | null>
Fetch details of previously established card token
Parameters
- tokenValue: string | TokenValue
  Token value
Returns Promise<TokenDetails | null>
Promise resolving to token details (200) or void (204 if not found)

See
https://openapi.sandbox.tpay.com/#tag/Tokenization/operation/get_tokens_get
- Defined in src/tokenization/index.ts:30