bc-clearpay-sdk/dist/base/contracts/IPayment.d.ts

BetterCommerce's ClearPay NodeJS SDK enables BC client applications to integrate with ClearPay merchant API system. It publishes an interface to interact with [ClearPay API v2](https://developers.clearpay.co.uk/clearpay-online/reference) endpoints.

import { IPaymentIntent } from "../../models/IPaymentIntent";
export interface IPayment {
    /**
     * Initiate a payment. This endpoint creates a checkout that is used to initiate the Clearpay payment process. Clearpay uses the information in the order request to assist with the consumer’s pre-approval process.
     * API Reference - https://developers.clearpay.co.uk/clearpay-online/reference/create-checkout
     * @param data {IPaymentIntent}
     */
    initIntent(data: IPaymentIntent): any;
    /**
     * Capture Full Payment. This endpoint performs a payment capture for the full value of the payment plan.
     * API Reference - https://developers.clearpay.co.uk/clearpay-online/reference/capture-full-payment
     * @param data
     */
    requestPayment(data: any): any;
    /**
     * Get Payment By Order ID. This endpoint retrieves an individual payment along with its order details.
     * API Reference - https://developers.clearpay.co.uk/clearpay-online/reference/get-payment-by-order-id
     * @param data {String}
     * @returns
     */
    getDetails(data: any): any;
}