bc-payments-sdk
Version:
BetterCommerce's Payments NodeJS SDK is a complete solution for storefront clients that integrate payments. `bc-payments-sdk` is a single point interface for storefront clients for interacting with payment gateways.
58 lines (57 loc) • 2.86 kB
TypeScript
import { IPaymentProvider } from "../../base/contracts/IPaymentProvider";
import { BasePaymentProvider } from "../../base/entity/BasePaymentProvider";
/**
* Class {ClearPayPayment} is a concrete implementation of a payment provider.
* It provides a set of methods that can be used to interact with the Clearpay payment gateway.
*
* @class ClearPayPayment
* @extends {BasePaymentProvider}
* @implements {IPaymentProvider}
*/
export declare class ClearPayPayment extends BasePaymentProvider implements IPaymentProvider {
/**
* Initiates a payment intent using the Clearpay payment gateway.
*
* This method initializes the SDK and attempts to create a payment intent
* with the provided data. If successful, it returns the result of the intent
* creation. If the SDK initialization fails, it returns null. In case of an
* error during the process, it returns an object containing the error details.
*
* API Reference - https://developers.clearpay.co.uk/clearpay-online/reference/create-checkout
*
* @param data - The payment intent data required by Clearpay.
* @returns A promise that resolves to the result of the payment intent creation
* or an object with error details if an error occurs.
*/
initPaymentIntent(data: any): Promise<any>;
/**
* Requests a payment or payout from Clearpay.
*
* This method initializes the SDK and attempts to request a payment or payout
* with the provided data. If successful, it returns the result of the request.
* If the SDK initialization fails, it returns null. In case of an
* error during the process, it returns an object containing the error details.
*
* API Reference - https://developers.clearpay.co.uk/clearpay-online/reference/capture-full-payment
*
* @param data - The payment data required by Clearpay.
* @returns A promise that resolves to the result of the payment request
* or an object with error details if an error occurs.
*/
requestPayment(data: any): Promise<any>;
/**
* Retrieves the details of an order from Clearpay.
*
* This method attempts to retrieve the order details with the provided data.
* If successful, it returns the result of the order details request.
* If the SDK initialization fails, it returns null. In case of an
* error during the process, it returns an object containing the error details.
*
* API Reference - https://developers.clearpay.co.uk/clearpay-online/reference/get-payment-by-order-id
*
* @param data - The order ID required by Clearpay.
* @returns A promise that resolves to the result of the order details request
* or an object with error details if an error occurs.
*/
getOrderDetails(data: any): Promise<any>;
}