connect-sdk-nodejs/lib/v1/model/captures/index.d.ts

SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API

import { PaymentContext, SdkResponse } from "../../../model/types";
import { CaptureResponse, CreateDisputeRequest, DisputeResponse, DisputesResponse, ErrorResponse, RefundErrorResponse, RefundRequest, RefundResponse } from "../domain";
export interface CapturesClient {
    /**
     * Resource /{merchantId}/captures/{captureId} - <a href="https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/nodejs/captures/get.html">Get capture</a>
     */
    get(merchantId: string, captureId: string, paymentContext?: PaymentContext | null): Promise<SdkResponse<CaptureResponse, ErrorResponse>>;
    /**
     * Resource /{merchantId}/captures/{captureId}/refund - <a href="https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/nodejs/captures/refund.html">Create Refund</a>
     */
    refund(merchantId: string, captureId: string, postData: RefundRequest, paymentContext?: PaymentContext | null): Promise<SdkResponse<RefundResponse, RefundErrorResponse>>;
    /**
     * Resource /{merchantId}/captures/{captureId}/disputes - <a href="https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/nodejs/captures/disputes.html">Get disputes</a>
     */
    disputes(merchantId: string, captureId: string, paymentContext?: PaymentContext | null): Promise<SdkResponse<DisputesResponse, ErrorResponse>>;
    /**
     * Resource /{merchantId}/captures/{captureId}/dispute - <a href="https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/nodejs/captures/dispute.html">Create dispute</a>
     */
    dispute(merchantId: string, captureId: string, postData: CreateDisputeRequest, paymentContext?: PaymentContext | null): Promise<SdkResponse<DisputeResponse, ErrorResponse>>;
}