Interface RefundsClient

interface RefundsClient {
    approve(
        merchantId: string,
        refundId: string,
        postData: ApproveRefundRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<void, ErrorResponse>>;
    cancel(
        merchantId: string,
        refundId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<void, ErrorResponse>>;
    cancelapproval(
        merchantId: string,
        refundId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<void, ErrorResponse>>;
    find(
        merchantId: string,
        paymentContext: FindRefundsParams,
    ): Promise<SdkResponse<FindRefundsResponse, ErrorResponse>>;
    get(
        merchantId: string,
        refundId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<RefundResponse, ErrorResponse>>;
}

Index

Methods

approve cancel cancelapproval find get

Methods

approve

approve(
    merchantId: string,
    refundId: string,
    postData: ApproveRefundRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<void, ErrorResponse>>
Resource /{merchantId}/refunds/{refundId}/approve - Approve refund
Parameters
- merchantId: string
- refundId: string
- postData: ApproveRefundRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<void, ErrorResponse>>

cancel

cancel(
    merchantId: string,
    refundId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<void, ErrorResponse>>
Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund
Parameters
- merchantId: string
- refundId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<void, ErrorResponse>>

cancelapproval

cancelapproval(
    merchantId: string,
    refundId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<void, ErrorResponse>>
Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund
Parameters
- merchantId: string
- refundId: string
- OptionalpaymentContext: PaymentContext | null
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?: PaymentContext | null,
): Promise<SdkResponse<RefundResponse, ErrorResponse>>
Resource /{merchantId}/refunds/{refundId} - Get refund
Parameters
- merchantId: string
- refundId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<RefundResponse, ErrorResponse>>