Interface RefundsClient

Hierarchy

RefundsClient

Index

Methods

Methods

approve

approve(merchantId: string, refundId: string, postData: ApproveRefundRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<void, ErrorResponse>>

Resource /{merchantId}/refunds/{refundId}/approve - Approve refund

Parameters
- merchantId: string
- refundId: string
- postData: ApproveRefundRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<void, ErrorResponse>>

cancel

cancel(merchantId: string, refundId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<void, ErrorResponse>>

Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund

Parameters
- merchantId: string
- refundId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<void, ErrorResponse>>

cancelapproval

cancelapproval(merchantId: string, refundId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<void, ErrorResponse>>

Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund

Parameters
- merchantId: string
- refundId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<void, ErrorResponse>>

find

find(merchantId: string, paymentContext: FindRefundsParams): Promise<SdkResponse<FindRefundsResponse, ErrorResponse>>

Resource /{merchantId}/refunds - Find refunds

Parameters
- merchantId: string
- paymentContext: FindRefundsParams
Returns Promise<SdkResponse<FindRefundsResponse, ErrorResponse>>

get

get(merchantId: string, refundId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<RefundResponse, ErrorResponse>>

Resource /{merchantId}/refunds/{refundId} - Get refund

Parameters
- merchantId: string
- refundId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<RefundResponse, ErrorResponse>>