Class TPayRefundsModule

TPayRefundsModule provides methods for creating and managing refunds based on card tokens.

See

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

Hierarchy (View Summary)

SDKModule
- TPayRefundsModule

Index

Constructors

Properties

Methods

createRefund getRefund getRefunds

Constructors

constructor

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

Properties

`Protected`apiClient_

apiClient_: AxiosInstance

Methods

createRefund

createRefund(
refundData: TPay.Refunds.CreateRefundRequest,
): Promise<CreateRefundResponse>
Create new refund based on card token
Parameters
- refundData: TPay.Refunds.CreateRefundRequest
  Refund details
Returns Promise<CreateRefundResponse>
Promise resolving to refund creation response

See
https://openapi.sandbox.tpay.com/#tag/Refunds/operation/post_refund_create
- Defined in src/refunds/index.ts:33

getRefund

getRefund(refundId: string | RefundId): Promise<RefundDetails>
Fetch status of single refund request
Parameters
- refundId: string | RefundId
  Refund identifier
Returns Promise<RefundDetails>
Promise resolving to refund details

See
https://openapi.sandbox.tpay.com/#tag/Refunds/operation/get_refund_get_single
- Defined in src/refunds/index.ts:43

getRefunds

getRefunds(
params?: RefundListParams,
): Promise<
TPayPaginatedResponse<{ list: RefundListItem[] }, "transactions">,
>
Fetch list of refunds
Parameters
- Optionalparams: RefundListParams
  Query parameters for filtering refunds
Returns Promise<TPayPaginatedResponse<{ list: RefundListItem[] }, "transactions">>
Promise resolving to paginated list of refunds

See
https://openapi.sandbox.tpay.com/#tag/Refunds/operation/get_refund_get
- Defined in src/refunds/index.ts:23