{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","admonition"]},"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 how Payout Drop-in selects methods, renders the accordion, and completes a withdrawal."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payout Drop-in is a single withdrawal component that orchestrates Card, PayPal, Apple Pay, and Google Pay for returning shoppers. It reuses the Web SDK's secure payout paths and presents eligible stored instruments in a vertical accordion."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Drop-in doesn't collect new card primary account numbers for first-time vaulting. Shoppers must already have an eligible stored instrument or a linked PayPal account before a method appears."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-benefits","__idx":2},"children":["Key benefits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Drop-in gives you these benefits:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-built accordion:"]}," One mount point for eligible payout methods instead of wiring each component yourself."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Session-driven methods:"]}," Candidate methods come from the payout Session ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedFundingTypes"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Instrument-aware UI:"]}," Methods appear only when the shopper still has an eligible token or PayPal association after filtering."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Shared callbacks:"]}," Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onSuccess"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onError"]},", and optional hooks across methods (with PayPal-specific differences documented in the method guides)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Portal branding:"]}," Colours, fonts, and method order come from the payout Drop-in site configuration."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-steps","__idx":3},"children":["Integration steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A full Web integration involves these high-level steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set up the Unity Portal:"]}," Activate the Payout Drop-in service and related payout method services, enable methods, configure branding, whitelist domains where Drop-in is hosted, and set up webhooks for payout verification."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prepare shopper instruments:"]}," Ensure returning shoppers have vaulted cards, Apple Pay or Google Pay device tokens, or a linked PayPal account for the methods you enable."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Install the SDK:"]}," Install ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@pxpio/web-components-sdk"]}," and import ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayoutDropIn"]}," from the package root."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a payout session:"]}," On your backend, create a session with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType: \"PayoutDropIn\""]}," and payout intents for each method you enable. Keep inbound credentials on the server."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Embed Drop-in:"]}," Initialise with the session, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerId"]},", transaction data, and callbacks, then call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create(containerId)"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify on your backend:"]}," Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onSuccess"]}," as submission acknowledgement. Confirm the payout with merchant transaction webhooks or a server-side lookup before marking the withdrawal complete."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ready to integrate? Follow the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/web/quickstart"},"children":["Web SDK quickstart"]},", or see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/web/implementation"},"children":["Implementation"]}," for the full mount and reconciliation pattern."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-method-visibility-is-decided","__idx":4},"children":["How method visibility is decided"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At mount time, Drop-in:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reads the session ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedFundingTypes"]}," to build a candidate method list."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Loads the site payout configuration (branding, labels, payment method order)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Loads shopper-specific data (active card tokens and, when needed, PayPal wallet association)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Filters by instrument type, expiry, and optional merchant blacklists."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renders an accordion of methods that still have something to pay out to."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If nothing remains, reports ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SDK1701"]}," through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onError"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table maps each method to its session signal and shopper requirement."]},{"$$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":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Session signal"},"children":["Session signal"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Shopper requirement"},"children":["Shopper requirement"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedFundingTypes.cards"]}," is present (including an empty array). ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardSchemes"]}," alone doesn't enable card."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper ID plus at least one eligible plain-card token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Apple Pay"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedFundingTypes.wallets.applePay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper ID plus at least one Apple Pay device token (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["panType: Device"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Google Pay"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedFundingTypes.wallets.googlePay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper ID plus at least one Google Pay device token (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["panType: Device"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PayPal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedFundingTypes.wallets.paypal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper ID plus an active PayPal wallet association."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/payout-methods"},"children":["Payout method overview"]}," for filtering detail and per-method behaviour."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"ui-behaviour","__idx":5},"children":["UI behaviour"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Drop-in uses a vertical accordion:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Eligible methods appear as expandable panels."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only one method is expanded at a time where the accordion controls expansion."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Method order follows the site payout configuration when a manual order is set. Otherwise, Drop-in uses its default order among the common methods."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Loading and empty states are handled in the mount container, including configuration failures (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SDK1700"]},") and no eligible methods (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SDK1701"]},")."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"success-and-verification","__idx":6},"children":["Success and verification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payout submission succeeds, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onSuccess"]}," receives transaction identifiers such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["systemTransactionId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionId"]},". Always verify on your backend before completing the withdrawal. Payout Drop-in uses the same merchant transaction webhook channel as other products."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/web/quickstart"},"children":["Quickstart"]}," for webhook handling patterns and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/get-started/manage-webhooks"},"children":["Manage webhooks"]}," for subscription and signature validation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whats-next","__idx":7},"children":["What's next?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Continue with these guides:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/activation"},"children":["Activation"]},": Enable Payout Drop-in in the Unity Portal."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/onboarding"},"children":["Onboarding"]},": Prepare vaulted instruments and linked wallets."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/payout/drop-in/web/quickstart"},"children":["Web SDK quickstart"]},": Follow our end-to-end sandbox walkthrough."]}]}]},"headings":[{"value":"How it works","id":"how-it-works","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Key benefits","id":"key-benefits","depth":2},{"value":"Integration steps","id":"integration-steps","depth":2},{"value":"How method visibility is decided","id":"how-method-visibility-is-decided","depth":2},{"value":"UI behaviour","id":"ui-behaviour","depth":2},{"value":"Success and verification","id":"success-and-verification","depth":2},{"value":"What's next?","id":"whats-next","depth":2}],"frontmatter":{"seo":{"title":"How it works"}},"lastModified":"2026-11-11T13:55:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/payout/drop-in/how-it-works","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}