Save PayPal with the JavaScript SDK

CurrentLast updated: March 8th 2024, @ 1:17:47 pm

Select a payment method

After customers save their PayPal Wallet, they can select it for faster checkout. Customers won't have to enter payment details for future transactions.

To save PayPal Wallets, payers need to log in to your site, make a purchase, and remain on your site when transactions take place.

Customers with a PayPal Wallet can:

Review PayPal transactions and transaction history
Review, add, or remove funding sources
Review and cancel recurring payments
Hold a balance in their PayPal account
Use PayPal to send and receive money
Withdraw money to a linked bank account
Use PayPal to transact with merchants

Availability

Australia
Austria
Belgium
Bulgaria
Canada
China
Cyprus
Czech Republic
Denmark
Estonia
Finland
France
Germany
Hong Kong
Hungary
Ireland
Italy
Japan
Latvia
Liechtenstein
Lithuania
Luxembourg
Malta
Netherlands
Norway
Poland
Portugal
Romania
Singapore
Slovakia
Slovenia
Spain
Sweden
United Kingdom
United States

Know before you code

This integration requires a PayPal Developer account.
This procedure modifies an existing standard payments or advanced credit and debit card payments integration.
Your payments integration must have a server-side capture call or a server-side authorization and capture call.
To save payment methods, you must be able to uniquely identify payers. For example, payers create an account and log in to your site.
Complete the steps in Get started to get the following sandbox account information from the Developer Dashboard:
- Your sandbox account login information
- Your access token

GitHub Codespaces are cloud-based development environments where you can code and test your PayPal integrations. Learn more

How it works

PayPal encrypts payment method information and stores it in a digital vault for that customer.

The payer saves their payment method.
For a first-time payer, PayPal creates a customer ID. Store this within your system for future use.
When the customer returns to your website and is ready to check out, pass their PayPal-generated customer ID to the JavaScript SDK. The customer ID tells the JavaScript SDK to save or reuse a saved payment method.
The payer completes a billing agreement.
The JavaScript SDK populates the checkout page with each saved payment method. Each payment method appears as a one-click button next to other ways to pay.

The checkout process is now shorter because it uses saved payment information.

Return payer experience

The following is an example of what a payer sees after they save their PayPal Wallet on your site. Returning payers can select their saved payment method at checkout to pay faster.

The payer uses a credit card in their PayPal Wallet in the following example:

Phone screen. Pay with PayPal button is highlighted at checkout.

Use cases

Businesses save payment methods if they want customers to:

Check out without re-entering a payment method
Pay after use, for example, ride-sharing and food delivery

Check eligibility

Go to paypal.com and sign in with your business account.
Go to Account Settings > Payment Preferences > Save PayPal and Venmo payment methods.
In the Save PayPal and Venmo payment methods section, select Get Started.
When you submit profile details, PayPal reviews your eligibility to save PayPal Wallets and Venmo accounts.
After PayPal reviews your eligibility, you'll see a status of Success, Need more information, or Denied.

1. Set up sandbox to save payment methods

Set up your sandbox and live business accounts to save payment methods:

Log in to the Developer Dashboard.
Under REST API apps, select your app name.
Under Sandbox App Settings > App Feature Options, check Accept payments.
Expand Advanced options. Confirm that Vault is selected.

To go live, you'll need to be vetted for PayPal Wallet. You can start the vetting process from the Merchant Servicing Dashboard.

Only your sandbox business account is enabled for vaulting payment methods. Your developer account remains unaffected.
You'll complete production onboarding when you're ready to go live.

Tip: When prompted for data such as a phone number for the sandbox business request, enter any number that fits the required format. Since this is a sandbox request, the data doesn't have to be factual.

2. Generate user ID token for payer

The OAuth 2.0 API to retrieve an access_token has an additional parameter, response_type, that can be set to id_token. Include the id_token and access_token in the response.

First-time payer
Returning payer

A payer wants to save a payment method for the first time. Modify the following code to generate a user ID token for the payer:

Sample server-side user ID token request

1curl -s -X POST "https://api-m.sandbox.paypal.com/v1/oauth2/token" \
2  -u CLIENT_ID:CLIENT_SECRET \
3 -H "Content-Type: application/x-www-form-urlencoded" \
4 -d "grant_type=client_credentials" \
5 -d "response_type=id_token"

Modify the code

Copy the sample request code.
Change CLIENT_ID to your client ID.
Change CLIENT_SECRET to your client secret.

Sample response

1{
2     "access_token" : "A21AAJ--LVQmYlaxd_TDFOqVs4C3Xa7kPfa0Es7O35_9TEWaWRCMw7-NBJuBWqXZhb3eOolNnMtxwhoMP3NqHOJm1rvPDehfQ",
3     "app_id" : "APP-80W284485P519543T",
4     "expires_in" : 32400,
5     "id_token" : "eyJraWQiOiJjMmVjMmZiYjIzMGU0ZDkzOTNhMGFmZjEzZTY4MjFjMSIsInR5cCI6IkpXVCIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJodHRwczovL2FwaS5zYW5kYm94LnBheXBhbC5jb20iLCJzdWIiOiJQQ0haQ1RMMjVSNllXIiwiYWNyIjpbImNsaWVudCJdLCJzY29wZSI6WyJCcmFpbnRyZWU6VmF1bHQiXSwib3B0aW9ucyI6eyJjdXN0b21lcl9pZCI6IjIxMzM3NTk5MiJ9LCJheiI6ImdjcC5zbGMiLCJleHRlcm5hbF9pZCI6WyJQYXlQYWw6UENIWkNUTDI1UjZZVyIsIkJyYWludHJlZTo2ZDNtY3pqN2h3cHE4Y2cyIl0sImV4cCI6MTY2NDIzOTA1MCwiaWF0IjoxNjY0MjM4MTUwLCJqdGkiOiJVMkFBSVNTRkozbVlJUE8wdGYwTF93NFVmTHpfeGFCNHhYRndkTnRibTNXOVhtQ2xoU2NuWGZtMmRxbjU5QjY2akRVbzNhd1Y0ODlsbFpZOVBuV2RFTVN4ZlpZVDZKTS1mUi1rdEotcV9pdkZKMHlCWXdpdU1HaldPR2psZWktUSJ9.PSDUMcZxsEEUlKNqKHgFhrmAcKeCeJMIMhzMrVV5PpTftlB_Xmgzwl1Fir0H0OYSjmopcVPNfXyXl55jxaqJdQ",
6     "nonce" : "2022-09-27T00:22:30ZxsLQJVSYoAx7jqj1JJgr3onjVSPVL5juzZbId-Z-bwQ",
7     "scope" : "https://uri.paypal.com/services/invoicing https://uri.paypal.com/services/vault/payment-tokens/read https://uri.paypal.com/services/disputes/read-buyer https://uri.paypal.com/services/payments/realtimepayment https://uri.paypal.com/services/disputes/update-seller https://uri.paypal.com/services/paypalhere openid https://uri.paypal.com/services/payments/payment/authcapture https://uri.paypal.com/services/disputes/read-seller Braintree:Vault https://uri.paypal.com/services/payments/refund https://uri.paypal.com/services/identity/activities https://api-m.sandbox.paypal.com/v1/vault/credit-card https://api-m.sandbox.paypal.com/v1/payments/.* https://uri.paypal.com/services/reporting/search/read https://uri.paypal.com/payments/payouts https://uri.paypal.com/services/vault/payment-tokens/readwrite https://api-m.sandbox.paypal.com/v1/vault/credit-card/.* https://uri.paypal.com/services/shipping/trackers/readwrite https://uri.paypal.com/services/subscriptions https://uri.paypal.com/services/applications/webhooks https://api-m.sandbox.paypal.com/v1/payments/refund https://api-m.sandbox.paypal.com/v1/payments/sale/.*/refund",
8     "token_type" : "Bearer"
9  }

A successful request returns fields including an access_token, id_token, and the number of seconds the access_token token is valid.

The id_token:

Uniquely identifies each payer.
Expires in a few minutes because it's meant to be used during checkout. Generate new tokens if the current tokens expire.

Tip: Each buyer session is unique. Set up your server to generate a new client token each time payment fields render on your page.

3. Pass user ID token to JavaScript SDK

Pass the id_token from your server into the JavaScript SDK using the data-user-id-token.

1<script src="https://www.paypal.com/sdk/js?client-id=YOUR_CLIENT_ID" data-user-id-token="YOUR-ID-TOKEN"></script>

4. Add PayPal button

Add the JavaScript SDK code to show the PayPal button on your product and checkout pages.
Determine where the SDK should show the PayPal button. Use configuration attributes to control the layout of the button.

HTML

1<!-- Set up a container element for the button -->
2<div id="paypal-button-container"></div>
3<!-- Include the PayPal JavaScript SDK. Replace <YOUR_CLIENT_ID> with your client ID.-->
4<script src="https://www.paypal.com/sdk/js?client-id=YOUR_CLIENT_ID" data-user-id-token="YOUR-ID-TOKEN"></script>
5<script>
6  // Render the eligible PayPal buttons within the #paypal-button-container
7  paypal.Buttons().render('#paypal-button-container')
8</script>

5. Create order

Include client-side callbacks to:

Manage interactions with APIs
Manage payer approval flows
Handle any events that lead to cancellation or error during payer approval

Client-side code snippet

1<script>
2  paypal.Buttons({
3      // Call your server to set up the transaction
4      createOrder: function(data, actions) {
5        return fetch('/yourserver.com/createOrder', {
6          method: 'post',
7          body: JSON.stringify({
8            source: data.paymentSource, //paypal / venmo / etc.
9          }),
10          // Here for product info
11        }).then(function(res) {
12          return res.json();
13        }).then(function(orderData) {
14          return orderData.id;
15        });
16      },
17      // Authorize or capture the transaction after payer approves
18      onApprove: (data, actions) => {
19        return fetch('/yourserver.com/order/' + data.orderID + '/capture/', {
20          method: 'post'
21        });
22      },
23      onCancel(data, actions) {
24        console.log(`Order Canceled - ID: ${data.orderID}`);
25      },
26      onError(err) {
27        console.error(err);
28      }
29  }).render('#paypal-button-container');
30</script>

Server-side code snippet

Set up your server to call the Create Order API. The button that the payer selects determines the payment_source sent in the following sample.

This SDK uses the Orders v2 API to save payment methods in the background. Use the following request to add attributes needed to save a PayPal Wallet.

Request

In the following request, the payment_source.paypal.attributes.vault.store_in_vault with the value ON_SUCCESS means the PayPal button is saved with a successful authorization or capture.

Pass the payment_source.paypal.experience_context and include the return_url and cancel_url to redirect the payer after they approve or cancel the order.

Create an order with PayPal as a payment source and store the PayPal Wallet in vault:

1curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/ \
2 -H "Content-Type: application/json" \
3 -H "Authorization: Bearer ACCESS-TOKEN" \
4 -H "PayPal-Request-Id: REQUEST-ID" \
5 -d '{
6    "intent": "CAPTURE",
7    "purchase_units": [{
8      "amount": {
9        "currency_code": "USD",
10        "value": "100.00"
11      }
12    }],
13    "payment_source": {
14      "paypal": {
15        "attributes": {
16          "vault": {
17            "store_in_vault": "ON_SUCCESS",
18            "usage_type": "MERCHANT",
19            "customer_type": "CONSUMER"
20          }
21        },
22      }
23    }
24  }'

Response

Return the id to your client to call the payer approval flow if the payment_source needs payer approval.

Note: The request to save the PayPal button is made when the order is created through payment_source.attributes.vault.store_in_vault. Vault details are available only after an order is authorized or captured.

1{
2    "id": "5O190127TN364715T",
3    "status": "PAYER_ACTION_REQUIRED",
4    "payment_source": {
5      "paypal": {}
6    },
7    "links": [{
8        "href": "https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T",
9        "rel": "self",
10        "method": "GET"
11      },
12      {
13        "href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
14        "rel": "payer-action",
15        "method": "GET"
16      }
17    ]
18  }

6. Payer approval

If payer approval is required, the client SDK calls the payer approval flow. The approval flow takes the payer through PayPal Checkout.

7. Authorize or capture order

After the payer approves, the onApprove function is called in the JavaScript SDK. Depending on the intent passed, the server calls the following APIs:

Capture Order API if the intent passed was CAPTURE
Authorize Order API if the intent passed was AUTHORIZE as part of your Create Order call.

If authorization or capture is successful, a vault.id is also created.

Authorize order request

1curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/authorize \
2 -H "Content-Type: application/json" \
3 -H "Authorization: Bearer ACCESS-TOKEN" \
4 -d '{}'

Capture order request

1curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/capture \
2 -H "Content-Type: application/json" \
3 -H "Authorization: Bearer ACCESS-TOKEN" \
4 -d '{}'

Capture order response

The HTTP response codes HTTP 2xx or HTTP 200 are returned for a successful request.

The capture is successful if the purchase_units[0].payments.captures.status is COMPLETED. You can confirm with the payer that the payment has been captured.

In the response from the authorize or capture request, the Orders v2 API interacts with the Payment Method Tokens v3 API. The Payment Method Tokens v3 API allows a PayPal Wallet to be saved. The response from the Orders v2 API contains the:

vault.id
customer.id
vault.status
links for the payment token of a recently saved PayPal Wallet.

Capture order

1{
2   "id": "5O190127TN364715T",
3   "status": "COMPLETED",
4   "payment_source": {
5     "paypal": {
6       "attribute": {
7         "vault": {
8           "id": "3nqvjt3n",
9           "customer": {
10               "id": "208743798"
11           },
12           "status": "VAULTED",
13           "links": [{
14               "href": "https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/3nqvjt3n",
15               "rel": "self",
16               "method": "GET"
17             },
18             {
19               "href": "https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/3nqvjt3n",
20               "rel": "delete",
21               "method": "DELETE"
22             },
23             {
24               "href": "https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T",
25               "rel": "up",
26               "method": "GET"
27             }
28           ]
29         }
30       },
31       "name": {
32         "given_name": "Firstname",
33         "surname": "Lastname"
34       },
35       "email_address": "customer@example.com",
36       "phone_number": {
37         "national_number": "2025212022"
38       },
39       "account_id": "QYR5Z8XDVJNXQ",
40       "address": {
41         "country_code": "US"
42       },
43     }
44   },
45   "payer": {
46     "name": {
47       "given_name": "Firstname",
48       "surname": "Lastname"
49     },
50     "email_address": "customer@example.com",
51     "phone_number": {
52       "national_number": "2025212022"
53     },
54     "payer_id": "QYR5Z8XDVJNXQ",
55     "address": {
56       "country_code": "US"
57     }
58   }
59   "purchase_units": [{
60     "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
61     "payments": {
62       "captures": [{
63         "id": "3C679366HH908993F",
64         "status": "COMPLETED",
65         "amount": {
66           "currency_code": "USD",
67           "value": "100.00"
68         },
69         "seller_protection": {
70           "status": "ELIGIBLE",
71           "dispute_categories": [
72             "ITEM_NOT_RECEIVED",
73             "UNAUTHORIZED_TRANSACTION"
74           ]
75         },
76         "final_capture": true,
77         "seller_receivable_breakdown": {
78           "gross_amount": {
79             "currency_code": "USD",
80             "value": "100.00"
81           },
82           "paypal_fee": {
83             "currency_code": "USD",
84             "value": "3.00"
85           },
86           "net_amount": {
87             "currency_code": "USD",
88             "value": "97.00"
89           }
90         },
91         "create_time": "2022-01-01T21:20:49Z",
92         "update_time": "2022-01-01T21:20:49Z",
93         "links": [{
94             "href": "https://api-m.sandbox.paypal.com/v2/payments/captures/3C679366HH908993F",
95             "rel": "self",
96             "method": "GET"
97           },
98           {
99             "href": "https://api-m.sandbox.paypal.com/v2/payments/captures/3C679366HH908993F/refund",
100             "rel": "refund",
101             "method": "POST"
102           }
103         ]
104       }]
105     }
106   }],
107   "links": [{
108     "href": "https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T",
109     "rel": "self",
110     "method": "GET"
111   }]
112 }

Save approved payment source

If the payment has been authorized or captured, the payer does not need to be present to save a payment_source. To keep checkout times as short as possible, the Orders API responds as soon as payment is captured.

If the attributes.vault.status returned after payment is APPROVED, you won't have a vault.id yet. An example of the attributes object from this scenario is in the following sample:

1"attributes": {
2        "vault": {
3          "status": "APPROVED",
4          "links": [
5            {
6              "href": "https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T",
7              "rel": "up",
8              "method": "GET"
9            }
10          ]
11        }
12      }

The Payment Method Tokens API still saves the payment source even after the Orders API returns its response and sends a webhook after the payment source is saved.

In order to retrieve a vault_id when an APPROVED status is returned, you'll need to subscribe to the VAULT.PAYMENT-TOKEN.CREATED webhook.

The Payment Method Tokens API sends a webhook after the payment source is saved. An example of the VAULT.PAYMENT-TOKEN.CREATED webhook payload is shown in the following sample:

1{
2  "id": "WH-72S4353495632143A-68K769747M133873M",
3  "event_version": "1.0",
4  "create_time": "2022-08-27T01:25:57.462Z",
5  "resource_type": "payment_token",
6  "resource_version": "3.0",
7  "event_type": "VAULT.PAYMENT-TOKEN.CREATED",
8  "summary": "A payment token has been created.",
9  "resource": {
10    "time_created": "2022-08-26T18:25:57.449PDT",
11    "links": [
12      {
13        "href": "https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/7vrxmrw",
14        "rel": "self",
15        "method": "GET",
16        "encType": "application/json"
17      },
18      {
19        "href": "https://api-m.sandbox.paypal.com/v3/vault/payment-tokens/7vrxmrw",
20        "rel": "delete",
21        "method": "DELETE",
22        "encType": "application/json"
23      }
24    ],
25    "id": "3nqvjt3n",
26    "payment_source": {
27      "paypal": {
28        "permit_multiple_payment_tokens": false,
29        "usage_type": "MERCHANT",
30        "customer_type": "CONSUMER",
31        "email_address": "email@example.com",
32        "payer_id": "VTR4JYK7STE7J"
33      }
34    },
35    "customer": {
36      "id": "208743798"
37    }
38  },
39  "links": [
40    {
41      "href": "https://api-m.sandbox.paypal.com/v1/notifications/webhooks-events/WH-72S4353495632143A-68K769747M133873M",
42      "rel": "self",
43      "method": "GET"
44    },
45    {
46      "href": "https://api-m.sandbox.paypal.com/v1/notifications/webhooks-events/WH-72S4353495632143A-68K769747M133873M/resend",
47      "rel": "resend",
48      "method": "POST"
49    }
50  ]
51}

In the previous example, the resource.id field is the vault ID. The resource.customer.id is the PayPal-generated customer ID.

8. Test your integration

Run the following tests in the PayPal sandbox to ensure you can save PayPal Wallets.

Save payment method

On your checkout page, click the PayPal button.
Log in to the payer account and approve the payment and billing agreement.
Capture the transaction.
Store the PayPal-generated customer ID in your system.
Log in to sandbox with your merchant account and verify the transaction.
Refresh the page that contains the PayPal button. Ensure the JavaScript SDK is initialized with the PayPal-generated customer ID.
Ensure the PayPal button displays the payer's preferred payment method.
Ensure that the payment method you just saved is visible with the other buttons.
Select the PayPal button again to test the return payer flow.

Sample integration

See a sample Save Payment Method integration in the PayPal GitHub repository.

Next steps

Test and go live with this integration.
Change the credentials and API URLs from api-m.sandbox.paypal.com to api-m.paypal.com when going live with your integration.
You can create orders without the payment_source.paypal.attributes.vault for subsequent or recurring transactions.
You can get a payment token, list all payment tokens, delete a payment token, and more with the Payment Method Tokens API.