@paypal/react-paypal-js
Version:
React components for the PayPal JS SDK
43 lines (42 loc) • 1.91 kB
TypeScript
import type { BasePaymentSessionReturn, PayPalPresentationModeOptions, PayPalCreditOneTimePaymentSessionOptions } from "../types";
export type UsePayPalCreditOneTimePaymentSessionProps = ((Omit<PayPalCreditOneTimePaymentSessionOptions, "orderId"> & {
createOrder: () => Promise<{
orderId: string;
}>;
orderId?: never;
}) | (PayPalCreditOneTimePaymentSessionOptions & {
createOrder?: never;
orderId: string;
})) & PayPalPresentationModeOptions;
/**
* Hook for managing PayPal Credit one-time payment sessions.
*
* This hook creates and manages a PayPal Credit payment session. It handles session lifecycle, resume flows
* for redirect-based flows, and provides methods to start, cancel, and destroy the session.
*
* @returns Object with: `error` (any session error), `isPending` (SDK loading), `handleClick` (starts session), `handleCancel` (cancels session), `handleDestroy` (cleanup)
*
* @example
* function CreditCheckoutButton() {
* const { error, isPending, handleClick, handleCancel } = usePayPalCreditOneTimePaymentSession({
* presentationMode: 'popup',
* createOrder: async () => ({ orderId: 'ORDER-123' }),
* onApprove: (data) => console.log('Approved:', data),
* onCancel: () => console.log('Cancelled'),
* });
* const { eligiblePaymentMethods } = usePayPal();
* const creditDetails = eligiblePaymentMethods?.getDetails?.("credit");
*
* if (isPending) return null;
* if (error) return <div>Error: {error.message}</div>;
*
* return (
* <paypal-credit-button
* countryCode={creditDetails?.countryCode}
* onClick={handleClick}
* onCancel={handleCancel}
* />
* );
* }
*/
export declare function usePayPalCreditOneTimePaymentSession({ presentationMode, fullPageOverlay, autoRedirect, createOrder, orderId, ...callbacks }: UsePayPalCreditOneTimePaymentSessionProps): BasePaymentSessionReturn;