@paypal/paypal-js
    Preparing search index...

    Interface VenmoPaymentsInstance

    Interface for managing Venmo payment operations within the PayPal SDK.

    This interface provides methods for creating and managing Venmo payment sessions, allowing merchants to integrate Venmo as a payment method in their applications.

    The VenmoPaymentsInstance enables seamless integration with Venmo's payment flow, providing a secure and user-friendly way to process payments through the Venmo platform.

    interface VenmoPaymentsInstance {
        createVenmoOneTimePaymentSession: (
            paymentSessionOptions: VenmoOneTimePaymentSessionOptions,
        ) => VenmoOneTimePaymentSession;
        createVenmoSavePaymentSession: (
            paymentSessionOptions: VenmoSavePaymentSessionOptions,
        ) => VenmoSavePaymentSession;
    }
    Index

    Properties

    createVenmoOneTimePaymentSession createVenmoSavePaymentSession

    Properties

    createVenmoOneTimePaymentSession: (
        paymentSessionOptions: VenmoOneTimePaymentSessionOptions,
    ) => VenmoOneTimePaymentSession

    Creates a Venmo one-time payment session for processing payments through Venmo.

    Type Declaration

    This method allows you to configure callback functions to handle different stages of the Venmo checkout process, including payment approval, cancelation, and errors.

    const venmoSession = sdkInstance.createVenmoOneTimePaymentSession({
      onApprove: (data) => {
        console.log('Venmo payment approved:', data);
      },
      onCancel: () => {
        console.log('Venmo payment canceled');
      },
      onError: (data) => {
        console.error('Venmo payment error:', data);
      }
    });
    createVenmoSavePaymentSession: (
        paymentSessionOptions: VenmoSavePaymentSessionOptions,
    ) => VenmoSavePaymentSession

    Creates a Venmo save payment session for storing payment methods for future use.

    Type Declaration

    This method allows you to configure a Venmo vault setup flow where a buyer can save their Venmo account for future transactions without a purchase.

    const venmoSaveSession = sdkInstance.createVenmoSavePaymentSession({
      onApprove: async ({ vaultSetupToken }) => {
        console.log('Venmo payment method saved:', vaultSetupToken);
      },
      onCancel: () => {
        console.log('Venmo save payment canceled');
      },
      onError: (data) => {
        console.error('Venmo save payment error:', data);
      }
    });

    const createVaultSetupToken = () =>
      Promise.resolve({ vaultSetupToken: 'vault_setup_token' });

    await venmoSaveSession.start(
      { presentationMode: 'auto' },
      createVaultSetupToken()
    );

    Settings

    On This Page

    Properties