{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","tabs","tab","admonition"]},"type":"markdown"},"seo":{"title":"PayPal onboarding","description":"Transform your commerce with PXP's unified platform—seamless payments, real-time insights, and global growth in one powerful integration.","lang":"en-UK","siteUrl":"https://developer.pxp.io","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"paypal-onboarding","__idx":0},"children":["PayPal onboarding"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Connect your PayPal Business account to your site so you can accept PayPal payments in your iOS app."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-start","__idx":1},"children":["Before you start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you haven't already, make sure that you have activated the Components and PayPal services in the Unity Portal. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/checkout/components/activate"},"children":["Activation"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-connect-your-paypal-account","__idx":2},"children":["Step 1: Connect your PayPal account"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Log in with an existing account","disable":false},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"a","attributes":{"target":"_blank","href":"https://portal.pxp.io/"},"children":["Unity Portal"]},", go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant setup > Sites"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select a site."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Services"]}," tab, find the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["PayPal service"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PayPal account"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connect PayPal account"]},". A PayPal pop-up opens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter your credentials, then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Agree and Continue"]},". A confirmation message is displayed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Return to PXP"]}," to go back to the Unity Portal."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your connection is successful, a success message is displayed and your connection details are visible. You're now ready to proceed with configuring PayPal for iOS payouts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your connection is unsuccessful, a warning is displayed. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/checkout/components/ios/paypal/payouts/troubleshooting"},"children":["Troubleshooting"]}," guide for more information."]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Create a new account","disable":false},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"a","attributes":{"target":"_blank","href":"https://portal.pxp.io"},"children":["Unity Portal"]},", go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant setup > Sites"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select a site."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Services"]}," tab, find the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["PayPal service"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PayPal account"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connect PayPal account"]},". A PayPal pop-up opens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create An Account"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter your legal name, email address, and a password, then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Account"]}," to confirm."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add your business and personal information, then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submit"]},". A confirmation message is displayed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Return to PXP"]}," to go back to the Unity Portal."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your connection is successful, a success message is displayed and your connection details are visible. You're now ready to proceed with configuring PayPal for iOS payouts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your connection is unsuccessful, a warning is displayed. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/checkout/components/ios/paypal/payouts/troubleshooting"},"children":["Troubleshooting"]}," guide for more information."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-create-a-paypal-app","__idx":3},"children":["Step 2: Create a PayPal app"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now configure your PayPal Developer account for backend API integration:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://developer.paypal.com/dashboard/","target":"_blank"},"children":["PayPal Developer Dashboard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Apps & Credentials"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the environment:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox:"]}," For development and testing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Live:"]}," For production"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create App"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["App Name"]}," (e.g., \"My App Payouts\")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant"]}," as the app type."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create App"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-enable-the-payouts-api","__idx":4},"children":["Step 3: Enable the Payouts API"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In your app settings, scroll to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Features"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payouts"]}," is enabled."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If not enabled, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enable"]}," next to Payouts."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you don't see the Payouts option, your PayPal Business account may need additional verification. Contact PayPal Support for assistance."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-copy-your-credentials","__idx":5},"children":["Step 4: Copy your credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You'll need these credentials for your backend integration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sandbox-credentials","__idx":6},"children":["Sandbox credentials"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox"]}," environment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select your app"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the following:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID:"]}," Used for backend API authentication."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Secret:"]}," Used for backend API authentication."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"live-credentials","__idx":7},"children":["Live credentials"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Live"]}," environment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select your app."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the following:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID:"]}," For production backend API authentication."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Secret:"]}," For production backend API authentication."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"security-best-practices","__idx":8},"children":["Security best practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Never commit credentials to version control."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store secrets in environment variables or secure vaults."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use different credentials for sandbox and live environments."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rotate secrets regularly."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5-create-sandbox-test-accounts","__idx":9},"children":["Step 5: Create sandbox test accounts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For testing, you'll need to create several sandbox accounts."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-payout-sender-account","__idx":10},"children":["Create a payout sender Account"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Developer Dashboard, go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox > Accounts"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Account"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business"]},"the  account type."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account Balance"]}," (e.g., $10,000 for testing)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Account"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note the email and password for testing."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-payout-receiver-accounts","__idx":11},"children":["Create payout receiver accounts"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create additional ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Personal"]}," sandbox accounts."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["These will receive test payouts."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create multiple accounts to test different scenarios."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-6-configure-webhook-settings-optional","__idx":12},"children":["Step 6: Configure webhook settings (optional)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To receive real-time notifications about the payout status:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In your app settings, scroll to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add Webhook"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter your webhook URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://yourdomain.com/api/webhooks/paypal\n"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select the following event types:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT.PAYOUTSBATCH.SUCCESS"]},": Payout batch completed"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT.PAYOUTSBATCH.DENIED"]},": Payout batch denied"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT.PAYOUTS-ITEM.SUCCEEDED"]},": Individual payout succeeded"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT.PAYOUTS-ITEM.FAILED"]},": Individual payout failed"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT.PAYOUTS-ITEM.BLOCKED"]},": Payout blocked by PayPal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT.PAYOUTS-ITEM.RETURNED"]},": Payout returned/refunded"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},"."]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhooks are recommended for production but not required. You can also poll the PayPal API for payout status."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-7-verify-your-setup","__idx":13},"children":["Step 7: Verify your setup"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"test-payout-api-access","__idx":14},"children":["Test Payout API access"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run a test API call to verify payout permissions:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api-m.sandbox.paypal.com/v1/oauth2/token \\\n  -H \"Content-Type: application/x-www-form-urlencoded\" \\\n  -u \"YOUR_CLIENT_ID:YOUR_SECRET\" \\\n  -d \"grant_type=client_credentials\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If successful, you'll receive an access token response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environment-configuration","__idx":15},"children":["Environment configuration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sandbox-environment","__idx":16},"children":["Sandbox environment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API base URL:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api-m.sandbox.paypal.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Web URL:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.sandbox.paypal.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use for:"]}," Development and testing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test accounts:"]}," Use sandbox accounts created in Step 5"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"live-environment","__idx":17},"children":["Live environment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API base URL:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api-m.paypal.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Web URL:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.paypal.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use for:"]}," Production only"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Real accounts:"]}," Actual PayPal user accounts"]}]}]},"headings":[{"value":"PayPal onboarding","id":"paypal-onboarding","depth":1},{"value":"Before you start","id":"before-you-start","depth":2},{"value":"Step 1: Connect your PayPal account","id":"step-1-connect-your-paypal-account","depth":2},{"value":"Step 2: Create a PayPal app","id":"step-2-create-a-paypal-app","depth":2},{"value":"Step 3: Enable the Payouts API","id":"step-3-enable-the-payouts-api","depth":2},{"value":"Step 4: Copy your credentials","id":"step-4-copy-your-credentials","depth":2},{"value":"Sandbox credentials","id":"sandbox-credentials","depth":3},{"value":"Live credentials","id":"live-credentials","depth":3},{"value":"Security best practices","id":"security-best-practices","depth":4},{"value":"Step 5: Create sandbox test accounts","id":"step-5-create-sandbox-test-accounts","depth":2},{"value":"Create a payout sender Account","id":"create-a-payout-sender-account","depth":3},{"value":"Create payout receiver accounts","id":"create-payout-receiver-accounts","depth":3},{"value":"Step 6: Configure webhook settings (optional)","id":"step-6-configure-webhook-settings-optional","depth":2},{"value":"Step 7: Verify your setup","id":"step-7-verify-your-setup","depth":2},{"value":"Test Payout API access","id":"test-payout-api-access","depth":3},{"value":"Environment configuration","id":"environment-configuration","depth":2},{"value":"Sandbox environment","id":"sandbox-environment","depth":3},{"value":"Live environment","id":"live-environment","depth":3}],"frontmatter":{"seo":{"title":"PayPal onboarding"}},"lastModified":"2026-06-12T11:56:36.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/checkout/components/ios/paypal/payouts/onboarding","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}