bc-payments-sdk/dist/modules/payments/PayPalPayment.d.ts

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.

import { IPaymentProvider } from "../../base/contracts/IPaymentProvider";
import { BasePaymentProvider } from "../../base/entity/BasePaymentProvider";
/**
 * Class {PayPalPayment} extends {BasePaymentProvider} and implements {IPaymentProvider}.
 * It provides the concrete implementation of the PayPal payment provider.
 *
 * @class PayPalPayment
 * @extends BasePaymentProvider
 * @implements IPaymentProvider
 *
 * @remark
 * This class is responsible for initializing the PayPal SDK and providing the concrete implementation of the PayPal payment provider methods.
 */
export declare class PayPalPayment extends BasePaymentProvider implements IPaymentProvider {
    initPaymentIntent(data: any): void;
    requestPayment(data: any): Promise<any>;
    /**
     * Retrieves the details of an order from PayPal.
     *
     * 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://developer.paypal.com/docs/api/orders/v2/#orders_get
     *
     * @param data - The order ID required by PayPal.
     * @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>;
}