# Save PayPal for purchase later with the iOS SDK (/sdk/ios/save-without-purchase/paypal) Store PayPal payment method for future purchases. Allow customers to save their PayPal Wallets and charge them after a set amount of time. For example, you can offer a free trial and charge payers after the trial expires. Payers don't need to be present when charged and no checkout is required. 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 [#availability] ### See supported countries [#see-supported-countries] * 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 ## Use cases [#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 ## Before you begin [#before-you-begin] Before implementing vaulted payments, enable vaulting features in the PayPal Developer Dashboard. 1. Log in to the [PayPal Developer Dashboard](https://developer.paypal.com/home/). 2. In the navigation menu, use the **Sandbox | Live** toggle to select **Live**. 3. Under **Apps & Credentials** > **REST API apps**, select your app name. 4. To enable vaulting for your account: * Go to **Features** > **Payment capabilities**. * In the **Payment capabilities** menu, select the **Save payment methods** toggle to enable vaulting. 5. To add the ability to save PayPal and Venmo payment methods: * Go to **Features** > **Payment methods**. * In the **Payment methods** menu, select the **PayPal and Venmo** toggle so you can save PayPal and Venmo payment options. > **Warning:** PayPal requires Risk Data Acquisition (RDA) to reduce fraud. You must implement risk data collection for all customer-initiated transactions (CIT) that use PayPal and Venmo Payment Tokens. Payment attempts that are missing RDA data are likely to be declined due to insufficient risk identifiers. Use the PayPal > > [FraudNet](/ratepay/fraudnet) > > and > > [Magnes](/limited-release/magnes) > > libraries to collect and pass RDA data during payment processing. ## Know before you code [#know-before-you-code] * To save payment methods, you must be able to identify payers uniquely. For example, payers create an account and log in to your app. * Complete the steps in [Get started](/api/rest/) to get the following sandbox account information from the Developer Dashboard: * Your sandbox account login information * Your access token * This integration requires a PayPal Developer account. * This integration must include a server-side call to exchange a setup token for a payment method token. ## How it works [#how-it-works] PayPal encrypts payment method information and stores it in a digital vault for that customer. 1. The payer saves their payment method. 2. For a first-time payer, PayPal creates a customer ID. Store this within your system for future use. 3. Use the customer ID to retrieve saved payment methods and add new ones for existing customers in your application. The checkout process is now shorter because it uses saved payment information. ## 1. Check eligibility [#1-check-eligibility] 1. Go to [paypal.com](https://www.paypal.com) and sign in with your business account. 2. Go to **Account Settings** > **Payment Preferences** > **Save PayPal and Venmo payment methods**. 3. In the Save PayPal and Venmo payment methods section, select **Get Started**. 4. When you submit profile details, PayPal reviews your eligibility to save PayPal Wallets. 5. After PayPal reviews your eligibility, you'll see a status of **Success**, **Need more information**, or **Denied**. ## 2. Set up your account to save payment methods [#2-set-up-your-account-to-save-payment-methods] Enable the vaulting feature in the Developer Dashboard for both your sandbox and production apps before you integrate. ### Sandbox [#sandbox] Set up your sandbox business account to save payment methods: 1. Log in to the Developer Dashboard. 2. Under **REST API apps**, select your app name. 3. Under **Sandbox App Settings** > **App Feature Options**, check **Accept payments**. 4. Expand **Advanced options**. Confirm that **Vault** is selected. To go live, you'll need to be vetted to save PayPal Wallets. You can start the vetting process from the Developer Dashboard. * Only your sandbox business account is enabled to save payment methods. Your developer account remains unaffected. > **Note:** **Tip:** When prompted for data such as a phone number for a sandbox business request, enter any number that fits the required format. Since this is a sandbox request, the data doesn't have to be real. ### Production [#production] Set up your live business account to save payment methods: 1. Log in to the [PayPal Developer Dashboard](https://developer.paypal.com/home/). 2. In the navigation menu, use the **Sandbox | Live** toggle to select **Live**. 3. Access **Apps & Credentials**. 4. Select the production REST API app name. 5. To enable vaulting for your account: 1. Go to **Features** > **Payment capabilities**. 2. In the **Payment capabilities** menu, select the **Save payment methods** toggle to enable vaulting. 6. To add the ability to save PayPal and Venmo payment methods: 1. Go to **Features** > **Payment methods**. 2. In the **Payment methods** menu, select the **PayPal and Venmo** toggle so you can save PayPal and Venmo payment options. > **Warning:** PayPal requires Risk Data Acquisition (RDA) to reduce fraud. You must implement risk data collection for all customer-initiated transactions (CIT) that use PayPal and Venmo Payment Tokens. Payment attempts that are missing RDA data are likely to be declined due to insufficient risk identifiers. Use the PayPal > > [FraudNet](/ratepay/fraudnet) > > and > > [Magnes](/limited-release/magnes) > > libraries to collect and pass RDA data during payment processing. ## 3. Add the PayPalWebPayments module to your app [#3-add-the-paypalwebpayments-module-to-your-app] Add the `PayPalWebPayments` package dependency for your app using Swift Package Manager or CocoaPods: #### Swift Package Manager 1. Open Xcode. 2. [Follow the guide](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) to add package dependencies to your app. 3. Enter [`https://github.com/paypal/paypal-ios/`](https://github.com/paypal/paypal-ios/) as the repository URL. 4. Select the checkbox for the `PayPalWebPayments` framework. #### CocoaPods Include `PayPal/PayPalWebPayments` in your Podfile. ```ruby lineNumbers # Podfile pod 'PayPal/PayPalWebPayments' ``` ## 4. Add PayPal button [#4-add-paypal-button] Add a button to your app's UI: ```swift lineNumbers Button("PayPal") { // Create a setup token server-side (see next step) } ``` ## 5. Create a setup token [#5-create-a-setup-token] Request a setup token from your server, create a `PayPalVaultRequest` object, and call the `vault()` method. > **Warning:** PayPal requires Risk Data Acquisition (RDA) to reduce fraud. You must implement risk data collection for all customer-initiated transactions (CIT) that use PayPal and Venmo Payment Tokens. Payment attempts that are missing RDA data are likely to be declined due to insufficient risk identifiers. Use the PayPal > > [FraudNet](/ratepay/fraudnet) > > and > > [Magnes](/limited-release/magnes) > > libraries to collect and pass RDA data during payment processing. ### Client-side code sample [#client-side-code-sample] ```swift lineNumbers let config = CoreConfig(clientID: "CLIENT_ID", environment: .sandbox) let setupTokenResponse = createVaultSetupToken() let vaultRequest = PayPalVaultRequest(setupTokenID: setupTokenResponse.setupTokenId) let paypalClient = PayPalWebCheckoutClient(config: config) paypalClient.vaultDelegate = self paypalClient.vault(vaultRequest) // MARK: - PayPalVaultDelegate func paypal(_ paypalWebClient: PayPalWebCheckoutClient, didFinishWithVaultResult paypalVaultResult: PayPalVaultResult) { // Handle success } func paypal(_ paypalWebClient: PayPalWebCheckoutClient, didFinishWithVaultError vaultError: CoreSDKError) { // Handle error } func paypalDidCancel(_ paypalWebClient: PayPalWebCheckoutClient) { // Handle cancellation } ``` ### Modify the code [#modify-the-code] Copy the code sample and modify it as follows: 1. Change `CLIENT_ID` to your clientId. 2. In the `createVaultSetupToken` method, call the endpoint on your server to create a setup token with the [Payment Method Tokens API](/api/payment-tokens/v3/). `createVaultSetupToken` returns the setup token as a string. ### Server-side code sample [#server-side-code-sample] Set up your server to call the [Payment Method Tokens API](/api/payment-tokens/v3/). The SDK uses the Payment Method Tokens API to save payment methods in the background. Use the following request as a template to create a setup token. > **Note:** **Note:** The `return_url` and `cancel_url` values are required, but can have filler values such as in the following sample. ```bash lineNumbers curl -v -k -X POST 'https://api-m.sandbox.paypal.com/v3/vault/setup-tokens' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS-TOKEN' \ -H 'PayPal-Request-Id: REQUEST-ID' \ -d '{ "payment_source": { "paypal": { "usage_type": "PLATFORM", "experience_context": { "return_url": "https://example.com/returnUrl", "cancel_url": "https://example.com/cancelUrl" } } } }' ``` ### Modify the code [#modify-the-code-1] 1. Change `ACCESS-TOKEN` to your sandbox app's access token. 2. Change `REQUEST-ID` to a set of unique alphanumeric characters such as a timestamp. ### Response [#response] ```json lineNumbers { "id": "4G4976650J0948357", "customer": { "id": "customer_4029352050" }, "status": "PAYER_ACTION_REQUIRED", "payment_source": { "paypal": { "description": "Description for PayPal to be shown to PayPal payer", "usage_pattern": "IMMEDIATE", "shipping": { "name": { "full_name": "Firstname Lastname" }, "address": { "address_line_1": "123 Main Street", "address_line_2": "Unit A", "admin_area_2": "Anytown", "admin_area_1": "CA", "postal_code": "12345", "country_code": "US" } }, "permit_multiple_payment_tokens": false, "usage_type": "PLATFORM", "customer_type": "CONSUMER" } }, "links": [ { "href": "https://api-m.sandbox.paypal.com/v3/vault/setup-tokens/4G4976650J0948357", "rel": "self", "method": "GET", "encType": "application/json" }, { "href": "https://sandbox.paypal.com/agreements/approve?approval_session_id=4G4976650J0948357", "rel": "approve", "method": "GET", "encType": "application/json" } ] } ``` ### Payer approval [#payer-approval] The payer is redirected to PayPal to approve the vault setup. After approval, the payer is returned to your app. ## 6. Create a payment token with the vault setup token ID [#6-create-a-payment-token-with-the-vault-setup-token-id] Convert the setup token to a payment token that can be used to process a transaction: ```bash lineNumbers curl -v -k -X POST 'https://api-m.sandbox.paypal.com/v3/vault/payment-tokens' \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ACCESS-TOKEN" \ -H "PayPal-Request-Id: REQUEST-ID" \ -d '{ "payment_source": { "token": { "id": "VAULT-SETUP-TOKEN", "type": "SETUP_TOKEN" } } }' ``` ### Modify the code [#modify-the-code-2] 1. Change `ACCESS-TOKEN` to your sandbox app's access token. 2. Change `REQUEST-ID` to a set of unique alphanumeric characters such as a timestamp. 3. Change `VAULT-SETUP-TOKEN` to the value passed from the client. 4. Save the resulting `payment token` returned from the API to use in future transactions. ## 7. Integrate back end [#7-integrate-back-end] The following sample shows a complete back-end integration to save PayPal for purchase later: ```javascript lineNumbers import "dotenv/config"; import express from "express"; const { PORT = 8888 } = process.env; const app = express(); app.set("view engine", "ejs"); app.use(express.static("public")); // Create setup token app.post("/create/setup/token", async (req, res) => { try { // Use your access token to securely generate a setup token // with an empty payment_source const vaultResponse = await fetch( "https://api-m.sandbox.paypal.com/v3/vault/setup-tokens", { method: "POST", body: JSON.stringify({ payment_source: { paypal: {} } }), headers: { Authorization: "Bearer ${ACCESS-TOKEN}", "PayPal-Request-Id": Date.now(), }, }, ); // Return the reponse to the client res.json(vaultResponse); } catch (err) { res.status(500).send(err.message); } }); // Create payment token from a setup token app.post("/create/payment/token/", async (req, res) => { try { const paymentTokenResult = await fetch( "https://api-m.sandbox.paypal.com/v3/vault/payment-tokens", { method: "POST", body: { payment_source: { token: { id: req.body.vaultSetupToken, type: "SETUP_TOKEN", }, }, }, headers: { Authorization: "Bearer ${ACCESS-TOKEN}", "PayPal-Request-Id": Date.now(), }, }, ); const paymentMethodToken = paymentTokenResult.id; const customerId = paymentTokenResult.customer.id; await save(paymentMethodToken, customerId); res.json(captureData); } catch (err) { res.status(500).send(err.message); } }); const save = async function (paymentMethodToken, customerId) { // Specify where to save the payment method token }; app.listen(PORT, () => { console.log("Server listening at http://localhost:${PORT}/"); }); ``` ## 8. Test your integration [#8-test-your-integration] 1. In your app, render a PayPal button and initate the vault. 2. Create a setup token. 3. Call the vault function in the SDK. 4. Create a payment token with the updated setup token. 5. Store the PayPal-generated customer ID in your system. 6. Log in to [sandbox](https://www.sandbox.paypal.com/) with your merchant account and verify the transaction. 7. Return to your app and initiate another transaction. Use the PayPal-generated payment token as a payment source. 8. Verify that the transaction captures successfully without having to complete PayPal Web Checkout again. ## Optional: Show saved payment methods [#optional-show-saved-payment-methods] Create a view where payers can see their payment methods using the [Payment Method Tokens API](/api/payment-tokens/v3/customer-payment-tokens-get) ## Next step [#next-step] [Go live](/api/rest/production/) with your integration.