Frontend Capabilities

# Integrate Venmo

Venmo is a US-based peer-to-peer (P2P) payment solution that allows users to transfer and receive money easily and quickly via a smartphone application. It is one of the most popular payment methods in the US.

This tutorial guides you on the following:

  • Use Chargebee.js to integrate the Venmo payment method on your website to collect payments.

  • Create a subscription after the user checks out post making a purchase.

# Gateway prerequisites

Chargebee currently supports Venmo services via Braintree. Learn more (opens new window) about how to connect Venmo via Braintree.

# Setting up Chargebee JS

# Inserting chargebee.js script in your application

Include the following script in your HTML page. You need to do this only once per page.

<script src="https://js.chargebee.com/v2/chargebee.js"></script>
1

# Initializing a Chargebee instance

Inside your JavaScript code, initialize chargebee with the publishable key (opens new window) once the page is loaded and get 'chargebee instance' object. This object is used further to create components.

Example:

var cbInstance = Chargebee.init({
	site: "site-name", // your test site
	domain: "https://mybilling.acme.com" // this is an optional parameter.
    publishableKey: "test__"
})
1
2
3
4
5

Learn more about ​​initializing a Chargebee instance.

# Create a Payment Intent

You should create a payment intent before submitting the form to authorize the payments.

payment_intent performs the essential function of tracking different events involved in a transaction. This includes:

  • Automatically changing its status based on the outcome of authorization and capture events.

  • Automatically refunding in case of an error post-payment.

A payment_intent can be created at your server-side using create a payment intent API (opens new window) and returned to the client side. The payment method handler uses the created payment_intent internally to perform authorization.

Here's the sample code to create a payment_intent.

TIP

This must be done from your backend to avoid exposing sensitive data.

Example

TIP

The payment intent creation should be initiated as a request from your front end.

Front end code 
function createPaymentIntent() {
  return fetch("/payment-intents", {
    body: JSON.stringify({
      amount: 500,
      currency_code: "USD",
      payment_method_type: "venmo",
    }),
  })
    .then(function (response) {
      return response.json();
    })
    .then(function (responseJson) {
      return responseJson.payment_intent;
    });
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# Authorize payment intent

Follow these steps to integrate Venmo payments into your website.

# 1. Create a container in DOM to load the Venmo button

Create a DOM container to hold and display the Venmo button component.

<div id='venmo-button'></div>
1

# 2. Setup Venmo

Set up Venmo on your Checkout page using the below steps:

# a. Load venmo integration

load venmo integration using cbInstance.load("venmo").

# b. Set payment intent

Pass the payment_intent object to venmoHandler.setPaymentIntent(payment_intent).

# c. Mount the payment button

Use the venmoHandler.mountPaymentButton function to mount the Venmo button inside the container element. This function takes the query selector for the container element as an input parameter.

Sample Code 
cbInstance.load('venmo')
        .then((venmoHandler) => {
                venmoHandler.setPaymentIntent(intent);
                return venmoHandler.mountPaymentButton("venmo-button");
        })
        .then(() => venmoHandler.handlePayment())
        .then((data) => console.log("success", data))
        .catch((error) => console.log("error", error));
1
2
3
4
5
6
7
8
9

# 3. Handle Payment

Use the venmoHandler.handlePayment function to initiate the transaction. The handlePayment function resolves to an authorized payment intent once the user authorizes the payment using the Venmo wallet. Learn more about the Venmo Handler.

Sample Code
  • Promises
  • Callbacks

# Create a subscription

Pass the ID of the successfully authorized payment_intent to Chargebee’s create a subscription API (opens new window).

  • Curl

← Voucher-based Payments →