Interface CapturesClient

interface CapturesClient {
    dispute(
        merchantId: string,
        captureId: string,
        postData: CreateDisputeRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<DisputeResponse, ErrorResponse>>;
    disputes(
        merchantId: string,
        captureId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<DisputesResponse, ErrorResponse>>;
    get(
        merchantId: string,
        captureId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<CaptureResponse, ErrorResponse>>;
    refund(
        merchantId: string,
        captureId: string,
        postData: RefundRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<RefundResponse, RefundErrorResponse>>;
}

Index

Methods

dispute disputes get refund

Methods

dispute

dispute(
    merchantId: string,
    captureId: string,
    postData: CreateDisputeRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<DisputeResponse, ErrorResponse>>
Resource /{merchantId}/captures/{captureId}/dispute - Create dispute
Parameters
- merchantId: string
- captureId: string
- postData: CreateDisputeRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<DisputeResponse, ErrorResponse>>

disputes

disputes(
    merchantId: string,
    captureId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<DisputesResponse, ErrorResponse>>
Resource /{merchantId}/captures/{captureId}/disputes - Get disputes
Parameters
- merchantId: string
- captureId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<DisputesResponse, ErrorResponse>>

get

get(
    merchantId: string,
    captureId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<CaptureResponse, ErrorResponse>>
Resource /{merchantId}/captures/{captureId} - Get capture
Parameters
- merchantId: string
- captureId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<CaptureResponse, ErrorResponse>>

refund

refund(
    merchantId: string,
    captureId: string,
    postData: RefundRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<RefundResponse, RefundErrorResponse>>
Resource /{merchantId}/captures/{captureId}/refund - Create Refund
Parameters
- merchantId: string
- captureId: string
- postData: RefundRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<RefundResponse, RefundErrorResponse>>