Welcome to Zuora Product Documentation

Explore our rich library of product information

Save a Venmo payment method for future billing

Learn how to save a customer's Venmo payment method for future subscription billing without making an initial purchase.

  • Your Zuora tenant is configured to use the PayPal Complete Payments (PPCP) gateway integration with Venmo.
  • You have integrated the Zuora payment SDK and are able to create Hosted Payment Method (HPM) sessions.
  • The customer account is set up and ready to receive a stored payment method.

The vault-without-purchase flow lets you save a customer's Venmo payment method for recurring or subscription billing without charging the customer at the time of enrollment. This supports use cases such as free trials and free subscriptions where you need a payment method on file before any charge occurs.

In this flow, Zuora creates a Venmo setup token, prompts the customer to approve the vault relationship through their Venmo account, exchanges the approved setup token for a permanent payment token, and stores the payment method in Zuora. No payment is created. If the customer cancels or declines the approval, no active payment method is stored.

The following fields are stored on the payment method record when the flow completes successfully: VaultId, CustomerId, EmailId, and VenmoAccountId.

Note: The processPayment and storePaymentMethod parameters cannot both be set to false in the same HPM session. The API returns an error if both are false.
  1. Create an HPM session with processPayment set to false and storePaymentMethod set to true.

    These values instruct Zuora to store the payment method without processing a payment transaction. Setting storePaymentMethod to true is required; setting it to false together with processPayment: false is not supported.

  2. Initialize the Venmo button or payment form component using the payment SDK, passing the HPM session token.

    When processPayment is false, the SDK sets the Venmo button to vault mode: no payment intent or amount is required. The amount parameter is optional in this configuration.

    The app_switch_context for the setup token request is determined automatically from the customer's browser User-Agent. The supported values are DESKTOP_WEB and MOBILE_WEB. Native app contexts are not supported in this flow.

  3. Present the Venmo button to the customer and wait for them to complete payer approval in their Venmo account.
    Zuora creates a Venmo setup token and returns a PAYER_ACTION_REQUIRED status. The customer is redirected to their Venmo account to approve the vault relationship.
  4. After the customer approves the vault relationship, Zuora automatically exchanges the approved setup token for a permanent Venmo payment token.
    Zuora stores the payment method on the customer's account with the following fields populated: VaultId, CustomerId, EmailId, and VenmoAccountId. The HPM session returns a paymentMethodId. No payment is created.
  5. Use the returned paymentMethodId to associate the stored Venmo payment method with the customer's subscription for future billing.

The customer's Venmo payment method is saved to their Zuora account and is available for future subscription charges. The stored payment method record includes the VaultId, CustomerId, EmailId, and VenmoAccountId fields. No payment transaction is created during this flow.

If the customer cancels or declines the Venmo approval, no active payment method is stored and no payment is created. You can present the enrollment flow again if the customer chooses to retry.