Worldline Connect Node.js SDK
    Preparing search index...

    Interface PaymentsClient

    interface PaymentsClient {
        approve(
            merchantId: string,
            paymentId: string,
            postData: ApprovePaymentRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<PaymentApprovalResponse, ErrorResponse>>;
        cancel(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CancelPaymentResponse, ErrorResponse>>;
        cancelapproval(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CancelApprovalPaymentResponse, ErrorResponse>>;
        capture(
            merchantId: string,
            paymentId: string,
            postData: CapturePaymentRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CaptureResponse, ErrorResponse>>;
        captures(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CapturesResponse, ErrorResponse>>;
        complete(
            merchantId: string,
            paymentId: string,
            postData: CompletePaymentRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CompletePaymentResponse, ErrorResponse>>;
        create(
            merchantId: string,
            postData: CreatePaymentRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CreatePaymentResponse, PaymentErrorResponse>>;
        devicefingerprint(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<DeviceFingerprintDetails, ErrorResponse>>;
        dispute(
            merchantId: string,
            paymentId: string,
            postData: CreateDisputeRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<DisputeResponse, ErrorResponse>>;
        disputes(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<DisputesResponse, ErrorResponse>>;
        finalizecapture(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<PaymentResponse, ErrorResponse>>;
        find(
            merchantId: string,
            paymentContext: FindPaymentsParams,
        ): Promise<SdkResponse<FindPaymentsResponse, ErrorResponse>>;
        get(
            merchantId: string,
            paymentId: string,
            paymentContext: GetPaymentParams,
        ): Promise<SdkResponse<PaymentResponse, ErrorResponse>>;
        processchallenged(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<PaymentResponse, ErrorResponse>>;
        refund(
            merchantId: string,
            paymentId: string,
            postData: RefundRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<RefundResponse, RefundErrorResponse>>;
        refunds(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<RefundsResponse, ErrorResponse>>;
        thirdPartyStatus(
            merchantId: string,
            paymentId: string,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<ThirdPartyStatusResponse, ErrorResponse>>;
        tokenize(
            merchantId: string,
            paymentId: string,
            postData: TokenizePaymentRequest,
            paymentContext?: PaymentContext | null,
        ): Promise<SdkResponse<CreateTokenResponse, ErrorResponse>>;
    }
    Index

    Methods

    approve cancel cancelapproval capture captures complete create devicefingerprint dispute disputes finalizecapture find get processchallenged refund refunds thirdPartyStatus tokenize

    Methods

    Settings

    Member Visibility

    On This Page

    Methods