Checkout with PayPal is a one-time payment checkout experience that gives you more control throughout the entire checkout process. It offers a streamlined checkout flow that keeps customers local to your website throughout the payment authorization process.

Unlike the Vault flow, Checkout with PayPal does not provide the ability to store a customer’s PayPal account in the Vault. However, if you are located in a country that supports PayPal One Touch™, your customer can make repeat purchases without re-entering their user credentials after their initial purchase.

Checkout with PayPal supports the following features:

  • Select or add shipping addresses in the PayPal account
  • Select or add funding instruments in the PayPal account
  • PayPal One Touch™ for Web
  • Two factor authentication support (currently only for US, UK, CA, DE, AT, and AU)

Typical use cases for the Checkout With PayPal flow:

  • Checkout from Cart/Product pages
  • Checkout page replacement
  • As a payment source

Invoking the Checkout with PayPal flow

To invoke Express Checkout you must ensure singleUse, amount, and currency are passed in your client options.

HTML
<script type="text/javascript">
braintree.setup('CLIENT-TOKEN-FROM-SERVER', 'custom', {
  paypal: {
    container: 'paypal-container',
    singleUse: true, // Required
    amount: 10.00, // Required
    currency: 'USD', // Required
    locale: 'en_US',
    enableShippingAddress: true,
    shippingAddressOverride: {
      recipientName: 'Scruff McGruff',
      streetAddress: '1234 Main St.',
      extendedAddress: 'Unit 1',
      locality: 'Chicago',
      countryCodeAlpha2: 'US',
      postalCode: '60652',
      region: 'IL',
      phone: '123.456.7890',
      editable: false
    }
  },
  onPaymentMethodReceived: function (obj) {
    doSomethingWithTheNonce(obj.nonce);
  }
});
</script>

See our JavaScript PayPal client reference for more information on the options available in the Checkout with PayPal flow.

Vault-initiated checkout

Vault-initiated checkout grants customers the ability to skip the login screen of the Checkout with PayPal flow if you have previously vaulted the customer's payment method. This gives the customer the opportunity to create a one-time payment with a different financial instrument than the one that is already vaulted.

Integration

On the server:

Generate a nonce containing the previously vaulted PayPal payment method using PaymentMethodNonce.create().

Ruby
result = gateway.payment_method.create(
  :customer_id => "131866",
  :payment_method_nonce => nonce_from_the_client
)
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

On the client:

Retrieve the nonce on the client using VaultManager.fetchPaymentMethods().

JavaScript
vaultManagerInstance.fetchPaymentMethods(function (err, paymentMethods) {
  paymentMethods.forEach(function (paymentMethod) {
    // add payment method to UI
    // paymentMethod.nonce <- transactable nonce associated with payment method
    // paymentMethod.details <- object with additional information about payment method
    // paymentMethod.type <- a constant signifying the type
  });
});

Create a payment with the retrieved nonce as a vaultInitiatedCheckoutPaymentMethodToken parameter.

JavaScript
paypal.Buttons({
  createOrder: function () {
    // when createPayment resolves, it is automatically passed to checkout.js
    return paypalCheckoutInstance.createPayment({
      flow: 'checkout',
      amount: '10.00',
      currency: 'USD',
      intent: 'capture',
      vaultInitiatedCheckoutPaymentMethodToken: token // This is the nonce obtained from fetchPaymentMethods
    });
  },
}).render('#paypal-button');

Continue the Checkout with PayPal flow as usual.

Country support

PayPal is available to merchants in all countries that we support and to customers in 140+ countries. Ensure you are using a desired locale code as outlined in our JavaScript PayPal client reference.

Currency presentment

The currency of the transaction is presented to the customer in the Checkout with PayPal flow. We support all currencies that PayPal REST APIs support.

See the server-side section for details on charging a transaction in a specific currency.