{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","required","optional"]},"type":"markdown"},"seo":{"title":"How it works","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"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"how-it-works","__idx":0},"children":["How it works"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Learn about PXP's PayPal and Venmo payout components."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The PayPal payouts components enable you to send payouts directly to your customers' PayPal or Venmo wallets. Whether you're paying vendors, freelancers, partners, or disbursing refunds, rebates, and rewards — the payouts components provide a streamlined experience built on top of PayPal's payout rails."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With the payouts components, you can benefit from:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Simplified disbursements:"]}," Send payouts directly to PayPal or Venmo wallets without managing the underlying PayPal API complexity."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SDK or merchant-initiated payouts:"]}," Choose whether the SDK handles the payout execution or trigger it from your own backend after your own validation checks."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customisable UI components:"]}," Use pre-built components with configurable styling, or build your own UI and call the APIs directly."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operational safeguards:"]}," Benefit from built-in logging, retries, and reconciliation handled by the gateway."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payout-options","__idx":2},"children":["Payout options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payouts components support the following wallet types:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PayPal:"]}," Send payouts to recipients using their PayPal email address or Payer ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Venmo:"]}," Send payouts to recipients using their Venmo email, phone number, or handle."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payout-initiation-modes","__idx":3},"children":["Payout initiation modes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When initiating a payout, you can choose who triggers the actual payout request:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SDK-initiated payout:"]}," The SDK handles the payout execution after your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onPrePayoutSubmit"]}," callback approves it. This is the fastest time-to-market option."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant-initiated payout:"]}," The SDK calls ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onClick"]}," (if configured) and returns without executing the payout. Your backend triggers the payout via API. This gives you maximum control for additional validation or business logic."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"SDK-initiated"},"children":["SDK-initiated"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Merchant-initiated"},"children":["Merchant-initiated"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proceedPayoutWithSdk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payout trigger"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The SDK calls PXP backend automatically."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your backend calls the payout API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Control level"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Simplified flow."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full control over timing and validation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use cases"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard payouts, quick integration."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom validation, compliance checks, multi-step approval."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In SDK-initiated mode (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proceedPayoutWithSdk: true"]},"), the SDK calls the PXP backend after your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onPrePayoutSubmit"]}," callback approves the payout, and then invokes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onPostPayout"]}," with the result. Provide ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onPrePayoutSubmit"]}," when you use this mode — without it, the SDK does not execute the payout. In merchant-initiated mode (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proceedPayoutWithSdk: false"]},", the default), the SDK calls ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onClick"]}," (if configured) and doesn't run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onPrePayoutSubmit"]},", execute the payout, or call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onPostPayout"]},". Your backend calls the payout API directly and can implement additional approval workflows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-transaction-intents","__idx":4},"children":["Supported transaction intents"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you initiate a payout transaction, you need to provide key information about the transaction method, amount, and currency."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The transaction method includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["entry type"]},", which describes the origin of the transaction. For payouts, this is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ecom"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["intent"]},", which describes the purpose of a transaction and indicates the intended money flow direction."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payouts support the following intent:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Intent"},"children":["Intent"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Disburse funds to a recipient's PayPal or Venmo wallet. Use this for all payout transactions."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sdk-components","__idx":5},"children":["SDK components"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payouts SDK provides several components you can use based on your integration needs:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Component"},"children":["Component "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"40%","data-label":"Type"},"children":["Type "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"40%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payout-amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display-only payout amount. Use this to show the payout amount to the customer before confirming."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PayPal receiver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paypal-payout-receiver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display-only PayPal email from config with optional masking. Use this for returning customers when you have their PayPal email/Payer ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Venmo receiver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["venmo-payout-receiver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display-only Venmo receiver from config with optional masking. Use this for returning customers when you have their Venmo details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submission"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payout-submission"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Withdraw with PayPal/Venmo\" button that executes the payout. Use this for returning customers when you already have stored wallet details."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All components follow the same basic lifecycle:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create the component with any configuration and callbacks you need."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Mount the component into a container in your DOM to make it visible and interactive."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Unmount the component when the user leaves the page or when the component is no longer needed."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":6},"children":["Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before integrating the payouts components, ensure you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A merchant account with PXP (credentials/API key)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your PayPal merchant account onboarded with PXP."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verified identity/account (if required by compliance)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sufficient funds in your gateway balance to cover payout amounts and fees."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The recipients' PayPal or Venmo identifiers (if using the withdrawal flow)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An HTTPS endpoint with a valid SSL certificate (if you plan to receive webhooks)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At minimum, your SDK initialisation must provide:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { PxpCheckout, IntentType, CurrencyType } from \"@pxpio/web-components-sdk\";\n\nconst pxpCheckoutSdk = PxpCheckout.initialize({\n  environment: \"test\",                 // or \"production\"\n  session: sessionData,\n  ownerId: \"your-owner-id\",\n  ownerType: \"MerchantGroup\",\n  transactionData: {\n    amount: 100,                       // > 0\n    currency: \"USD\" as CurrencyType,   // 3-letter ISO code\n    entryType: \"Ecom\",\n    intent: {\n      paypal: IntentType.Payout        // required for payouts\n    },\n    merchantTransactionId: crypto.randomUUID(),\n    merchantTransactionDate: () => new Date().toISOString()\n  },\n  paypalConfig: {\n    payoutConfig: {\n      proceedPayoutWithSdk: true // Defaults to false (merchant-initiated)\n      // Add paypalWallet / venmoWallet for the withdrawal flow\n    }\n  }\n});\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"compliance","__idx":7},"children":["Compliance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you offer PayPal or Venmo payouts, you must meet PayPal branding and behaviour requirements, and you remain responsible for financial, privacy, and security obligations in your markets."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"branding-and-appearance","__idx":8},"children":["Branding and appearance"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Requirement"},"children":["Requirement"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Logos"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PayPal logos and acceptance marks are displayed in parity with other payout options anywhere the payout method is presented."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Logos"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PayPal logos are taken from ",{"$$mdtype":"Tag","name":"a","attributes":{"target":"_blank","href":"https://www.paypal.com/uk/webapps/mpp/logo-center"},"children":["official sources"]}," and aren't modified."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Branding"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The correct capitalisation and spelling of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayPal"]}," is always used in both text and images (instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Paypal"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Pay Pal"]},", and similar variants)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accessibility"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"target":"_blank","href":"https://search.google.com/test/mobile-friendly"},"children":["Google Mobile-Friendly Test Tool"]}," recognises the main web pages of your site as mobile-friendly."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Optional","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accessibility"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The viewport meta tag ensures optimal rendering on mobile devices: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Optional","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Buttons"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PayPal or Venmo payout buttons are presented with equal prominence and close proximity to other withdrawal methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Buttons"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PayPal payout buttons are placed above other payout options."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Buttons"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The PayPal button is sized in parity with other payout buttons or otherwise in keeping with other elements on the page. See the ",{"$$mdtype":"Tag","name":"a","attributes":{"target":"_blank","href":"https://developer.paypal.com/docs/business/checkout/reference/style-guide/"},"children":["PayPal style guide"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"behaviour","__idx":9},"children":["Behaviour"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Requirement"},"children":["Requirement"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fees"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You don't add any additional surcharge or fee for PayPal or Venmo payout transactions beyond what PayPal charges."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer journey"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Selecting the PayPal payout method takes the user directly to the PayPal login/consent step (where applicable) and then back to your site without deviations or intermediate steps."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payout methods"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If payout methods can be stored and/or set as a preference, PayPal/Venmo can also be stored or set as the preferred payout method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payout methods"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For the customer's first payout, no payout method should be preselected by default. For subsequent payouts, the customer's previously used payout method may be preselected."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Optional","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payout methods"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When a payout method is selected, any fields specific to other payout methods are hidden. For example, bank details hidden when PayPal is selected."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Optional","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer isn't required to create or log into a store/application account to receive a payout."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Optional","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirmation page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["After the payout initiation, the user sees a confirmation page/step indicating the payout status; PayPal details or logos are presented in parity with other payout methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mobile experience"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm iFrame isn't used."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Receiver validation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PayPal email/phone or Venmo handle is validated before submission where possible; PayPal error responses are surfaced to the user with guidance to correct details."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"your-regulatory-responsibilities","__idx":10},"children":["Your regulatory responsibilities"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You own KYC, AML, transaction limits, data protection, consent, and record-keeping for your integration. Before you go live, confirm at least the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Customer identity verification where your market requires it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["AML monitoring and payout limits appropriate to your risk policy."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Secure handling of personal and financial data, including encryption in transit (TLS 1.2 or higher) and at rest for any stored wallet identifiers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Inbound API credentials (token ID and token value) kept on your backend only — never embed them in client-side JavaScript."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Clear customer consent for payout terms and privacy where required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Audit logging for payout initiation, approval, success, and failure."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Country-specific regulatory requirements for the markets you serve."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Legal and security review of your payout flows."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Store only the wallet identifiers you need for returning customers, such as the PayPal payer ID and email. Don't keep unnecessary sensitive personal data in the browser."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whats-next","__idx":11},"children":["What's next?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now that you understand how payouts work, you're ready to start integrating:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/components/web/quickstart"},"children":["Quickstart"]},": Set up the Web SDK in your project."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/components/web/paypal/onboarding"},"children":["Onboarding"]},": Connect your PayPal Business account for payouts."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/components/web/paypal/withdrawal-flow"},"children":["Withdrawal flow"]},": Implement payouts for returning customers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/components/web/paypal/about-configuration"},"children":["Configuration"]},": Configure the appearance and behaviour of components."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/components/web/paypal/events"},"children":["Events"]},": Handle payout events and callbacks."]}]}]},"headings":[{"value":"How it works","id":"how-it-works","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Payout options","id":"payout-options","depth":2},{"value":"Payout initiation modes","id":"payout-initiation-modes","depth":2},{"value":"Supported transaction intents","id":"supported-transaction-intents","depth":2},{"value":"SDK components","id":"sdk-components","depth":2},{"value":"Requirements","id":"requirements","depth":2},{"value":"Compliance","id":"compliance","depth":2},{"value":"Branding and appearance","id":"branding-and-appearance","depth":3},{"value":"Behaviour","id":"behaviour","depth":3},{"value":"Your regulatory responsibilities","id":"your-regulatory-responsibilities","depth":3},{"value":"What's next?","id":"whats-next","depth":2}],"frontmatter":{"seo":{"title":"How it works"}},"lastModified":"2026-11-11T13:23:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/payout/components/web/paypal/how-it-works","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}