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
noteThe examples on this page now use the PayPal Checkout component in conjunction with the PayPal JS SDK. The examples here require version 3.63.0 or higher of the Braintree JavaScript SDK.
If you are using the Braintree JavaScript SDK with the deprecated PayPal checkout.js library, review this migration guide to upgrade your integration.
To request a one-time payment, set flow to 'checkout' and include amount and currency options in your createPayment call. The value of currency must match the value passed into loadPayPalSDK.
If intent is used, the value must match in both loadPayPalSDK and createPayment.
Use a createOrder function to create the payment resource:
// Create a client.
braintree.client.create({
authorization: CLIENT_AUTHORIZATION
}, function (clientErr, clientInstance) {
// Stop if there was a problem creating the client.
// This could happen if there is a network error or if the authorization
// is invalid.
if (clientErr) {
console.error('Error creating client:', clientErr);
return;
}
// Create a PayPal Checkout component.
braintree.paypalCheckout.create({
client: clientInstance
}, function (paypalCheckoutErr, paypalCheckoutInstance) {
paypalCheckoutInstance.loadPayPalSDK({
currency: 'USD',
intent: 'capture'
}, function () {
paypal.Buttons({
fundingSource: paypal.FUNDING.PAYPAL,
createOrder: function () {
return paypalCheckoutInstance.createPayment({
flow: 'checkout', // Required
amount: 10.00, // Required
currency: 'USD', // Required, must match the currency passed in with loadPayPalSDK
intent: 'capture', // Must match the intent passed in with loadPayPalSDK
enableShippingAddress: true,
shippingAddressEditable: false,
shippingAddressOverride: {
recipientName: 'Scruff McGruff',
line1: '1234 Main St.',
line2: 'Unit 1',
city: 'Chicago',
countryCode: 'US',
postalCode: '60652',
state: 'IL',
phone: '123.456.7890'
}
});
},
onApprove: function (data, actions) {
return paypalCheckoutInstance.tokenizePayment(data, function (err, payload) {
// Submit `payload.nonce` to your server
});
},
onCancel: function (data) {
console.log('PayPal payment cancelled', JSON.stringify(data, 0, 2));
},
onError: function (err) {
console.error('PayPal error', err);
}
}).render('#paypal-button').then(function () {
// The PayPal button will be rendered in an html element with the ID
// `paypal-button`. This function will be called when the PayPal button
// is set up and ready to be used
});
});
});
});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.
Get a Payment Method Nonce
Get a payment method nonce that represents a previously vaulted PayPal payment method by generating the nonce on your server or fetching a customer's saved payment methods on the client.
On the server:
Generate a nonce containing the previously vaulted PayPal payment method using PaymentMethodNonce.create() and pass this payment method nonce down to your client.
On the client:
Retrieve the nonce on the client using VaultManager.fetchPaymentMethods().
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 such as PayPalAccount
});
});Use the payment method nonce
Create a payment with the retrieved nonce as a vaultInitiatedCheckoutPaymentMethodToken parameter.
paypal.Buttons({
createOrder: function () {
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.
PayPal Credit
US and UK merchants can add PayPal Credit to a Checkout flow integration with a few additional lines of code. For full info on the availability and benefits of offering PayPal Credit, see the support article. For integration details, see the developer guide.