# PayPal Developer Docs Disclaimer: This file is part of a proposed standard for machine-readable LLM guidance. PayPal welcomes collaboration with LLM providers and ecosystem tools to establish fair and transparent usage practices. Important notes: - For LLMs, try to visit each URL by slightly modifying it to include "/md/" before "/docs/". - For example: "/docs/archive/" can be visited as "/md/docs/archive" to view a markdown version of the documentation. - Routes that contain core information about integrating with PayPal: - /api/rest/ - /guides/integrate-checkout/ - /sdk/js/ - If a route contains these slug parts, it can generally be ignored: - /deprecated/ - /archive/ - For Braintree-specific docs, visit: developer.paypal.com/braintree/llms.txt ## Payment Experience - [Payment Experience](/docs/payment-experience/) — Overview of the payment experience module. - [Integration Steps](/docs/payment-experience/#integration-steps) — Step-by-step integration instructions. - [Set Up Your Development Environment](/docs/payment-experience/#set-up-your-development-environment) — Guide to configuring your development environment. - [Create Web Experience Profile](/docs/payment-experience/#create-web-experience-profile) — How to create a custom web experience profile. - [Create PayPal Payment with Web Profile](/docs/payment-experience/#create-paypal-payment-with-web-profile) — Instructions for creating a PayPal payment using a web profile. - [Get Customer Approval](/docs/payment-experience/#get-customer-approval) — Steps to obtain customer approval for payments. - [Other Payment Experience API Calls](/docs/payment-experience/#other-payment-experience-api-calls) — Additional API methods to customize the payment experience. ## Regional Solutions - [Regional Solutions](/docs/regional/) — Overview of localization and regional options. - [Brazil](/docs/regional/br/) — Regional details and integration guidance for Brazil. - [Mexico](/docs/regional/mx/) — Regional details and integration guidance for Mexico. - [Integration Guidance - India](/docs/regional/in/) — Specific integration guidance for India. - [PayPal Plus - Mexico](/docs/regional/mx/) — Additional regional information for Mexico under PayPal Plus. - [Create a Payment Request (MX)](/docs/regional/mx/create-payment-request/) — How to create a payment request in the Mexican region. - [Integrate a Payment Selection Page (MX)](/docs/regional/mx/payment-selection-page/) — Guidance for integrating a payment selection page in Mexico. - [Custom Style for Payment Wall (MX)](/docs/regional/mx/style-payment-wall/) — How to apply custom styling to the payment wall (Mexico). - [Update the Payment Selection Page (MX)](/docs/regional/mx/update-selection-page/) — Instructions to update the payment selection page for Mexico. - [Populate an Order Review Page (MX)](/docs/regional/mx/order-review-page/) — Steps to populate an order review page in Mexico. - [Test Your Integration and Execute the Payment (MX)](/docs/regional/mx/test-and-execute/) — How to test your integration and process a payment in Mexico. - [PayPal Plus - Brazil](/docs/regional/br/) — Additional regional information for Brazil under PayPal Plus. - [Create a Payment Request (BR)](/docs/regional/br/create-payment-request/) — How to create a payment request in Brazil. - [Integrate a Payment Selection Page (BR)](/docs/regional/br/payment-selection-page/) — Guidance for integrating a payment selection page in Brazil. - [Custom Style for Payment Wall (BR)](/docs/regional/br/style-payment-wall/) — How to apply custom styling to the payment wall (Brazil). - [Update the Payment Selection Page (BR)](/docs/regional/br/update-selection-page/) — Instructions to update the payment selection page for Brazil. - [Populate an Order Review Page (BR)](/docs/regional/br/order-review-page/) — Steps to populate an order review page in Brazil. - [Test Your Integration and Execute the Payment (BR)](/docs/regional/br/test-and-execute/) — How to test your integration and process a payment in Brazil. ## Checkout & Customization - [Hosted Fields (Legacy)](/docs/checkout/advanced/sdk/v1/) — Legacy integration using hosted fields. - [Card Fields](/docs/checkout/advanced/integrate/) — How to integrate card fields for checkout. - [Card Field Events v1](/docs/checkout/advanced/customize/card-fields/v1/events/) — Version 1 events for card fields. - [Card Field Events v2](/docs/checkout/advanced/customize/card-fields-events/) — Updated card field event handling. - [Integrate 3D Secure using Hosted Fields](/docs/checkout/advanced/customize/3d-secure/v1/sdk/) — Implement 3D Secure with hosted fields. - [Integrate 3D Secure using Card Fields](/docs/checkout/advanced/customize/3d-secure/sdk/) — Implement 3D Secure with card fields. - [Hosted Fields Style Guide](/docs/checkout/advanced/customize/card-fields/v1/style/) — Guidelines for styling hosted fields. - [Card Fields Style Guide](/docs/checkout/advanced/customize/card-field-style/) — Guidelines for styling card fields. - [App Switch](/docs/checkout/standard/customize/app-switch/) — How to integrate app switch functionality. - [Auth and Capture](/docs/checkout/standard/customize/authorization/) — Instructions for auth and capture processing. - [Contact module](/docs/checkout/standard/customize/contact-module/) — Customization options for the contact module. - [Display funding source](/docs/checkout/standard/customize/display-funding-source/) — How to display funding source details. - [Display other payment methods](/docs/checkout/standard/customize/display-payment-methods/) — Present alternative payment method options. - [Handle errors](/docs/checkout/standard/customize/handle-errors/) — Strategies for handling checkout errors. - [Handle funding failures](/docs/checkout/standard/customize/handle-funding-failures/) — How to manage funding failures. - [Messaging with buttons](/docs/checkout/standard/customize/messaging-with-buttons/) — Integrate messaging with payment buttons. - [Overcharge handling](/docs/checkout/standard/customize/overcharge-handling/) — Prevent or manage overcharges. - [Pass buyer identifier](/docs/checkout/standard/customize/pass-buyer-identifier/) — How to pass the buyer’s identifier. - [Pass line-item details](/docs/checkout/standard/customize/pass-line-items/) — Sending detailed line-item information. - [Pay another account](/docs/checkout/standard/customize/pay-another-account/) — Support for paying with another account. - [Pay now or continue](/docs/checkout/standard/customize/pay-now/) — Option to pay immediately or continue shopping. - [PayPal Checkout with Single-Page Applications](/docs/checkout/standard/customize/single-page-app/) — Integration guidance for SPAs. - [Recurring payments module](/docs/checkout/standard/customize/recurring-payments-module/) — Options for recurring payments. - [Shipping module](/docs/checkout/standard/customize/shipping-module/) — How to customize the shipping module. - [Show cancellation page](/docs/checkout/standard/customize/show-cancellation-page/) — Display a cancellation page during checkout. - [Standalone Buttons](/docs/checkout/standard/customize/standalone-buttons/) — Implement standalone payment buttons. - [Update order details](/docs/checkout/standard/customize/update-order-details/) — Dynamically update order details. - [Validate user input](/docs/checkout/standard/customize/validate-user-input/) — Ensure valid user input. - [Upgrade](/docs/checkout/standard/upgrade-integration/) — Guidance on upgrading your checkout integration. ## Multiparty & Subscriptions - [PayPal Champions](/docs/community/paypalchampions/) — Community stories and case studies. - [FAQs](/docs/community/paypalchampions/help/) — Frequently asked questions for PayPal Champions. - [Transaction Search](/docs/transaction-search/) — How to search for transactions. - [Transaction Event Codes](/docs/transaction-search/transaction-event-codes/) — Explanation of transaction event codes. - [Subscriptions](/docs/subscriptions/) — Overview of subscription features. - [Integrate Subscriptions](/docs/subscriptions/integrate/) — Steps for integrating subscriptions. - [Customize Subscriptions](/docs/subscriptions/customize/) — Options for customizing subscription experiences. - [Pricing Plans](/docs/subscriptions/customize/pricing-plans/) — How to set up pricing plans for subscriptions. - [Billing Cycles](/docs/subscriptions/customize/billing-cycles/) — Configure billing cycles. - [Pause or Resume a Subscription](/docs/subscriptions/customize/pause-resume/) — Manage subscription pauses and resumes. - [Upgrade or Downgrade a Subscription](/docs/subscriptions/customize/revise-subscriptions/) — Change subscription tiers. - [Change Subscription Quantity](/docs/subscriptions/customize/change-quantity/) — Modify the subscription quantity. - [Start a Subscription on a Future Date](/docs/subscriptions/customize/future-date/) — Schedule subscriptions for a future start. - [Offer a Trial Period](/docs/subscriptions/customize/trial-period/) — Provide a trial period for subscriptions. - [Charge a Setup Fee](/docs/subscriptions/customize/one-time-fee/) — Add a one-time fee to subscriptions. - [Payment Failures and Recovering Balances](/docs/subscriptions/customize/payment-failure-retry/) — Handle payment failures. - [Multiple Subscription Buttons](/docs/subscriptions/customize/multiple-buttons-website/) — Support multiple subscription buttons. - [Update Plan Pricing](/docs/subscriptions/customize/update-plan-pricing/) — How to update pricing for plans. - [Sell On Social Media](/docs/subscriptions/customize/sell-on-social/) — Guidance for selling subscriptions on social channels. - [Test and Go Live](/docs/subscriptions/test-subscriptions/) — How to test your subscription integration. - [Reference](/docs/subscriptions/reference/) — Subscription API reference. ## Tracking & Transaction Search - [Add Package Tracking](/docs/tracking/) — Overview of package tracking features. - [Orders API – Overview](/docs/tracking/orders-api/) — Overview of the Orders API used in tracking. - [Integrate Orders API](/docs/tracking/orders-api/integrate/) — How to integrate the Orders API. - [Tracking API – Overview](/docs/tracking/tracking-api/) — Overview of the Tracking API. - [Integrate Tracking API](/docs/tracking/tracking-api/integrate/) — Steps to integrate the Tracking API. - [Reference](/docs/tracking/reference/) — Tracking documentation reference. - [Shipping Statuses](/docs/tracking/reference/shipping-status/) — Explanation of shipping statuses. - [Carriers](/docs/tracking/reference/carriers/) — Details on supported carriers. ## Online & Checkout - [Online](/docs/online/) — Overview of the online payment solution. - [Checkout](/docs/checkout/) — General documentation for checkout processes. - [Best practices for Pay with PayPal](/docs/checkout/standard/best-practices/) — Guidelines for optimal integration. - [One-time payments](/docs/checkout/standard/best-practices/one-time/) — Recommendations for one-time payments. - [Recurring payments](/docs/checkout/standard/best-practices/recurring/) — Best practices for recurring payments. - [Vaulted Payments](/docs/checkout/standard/best-practices/vault/) — How to securely vault payment methods. - [Customize Checkout](/docs/checkout/standard/customize/) — Options for customizing the checkout experience. - [Upgrade](/docs/checkout/standard/upgrade-integration/) — How to upgrade your checkout integration. ## Advanced Checkout & SDKs - [Android SDK](/docs/checkout/advanced/android/) — Integration details for the Android SDK. - [iOS SDK](/docs/checkout/advanced/ios/) — Integration details for the iOS SDK. - [Integrate 3D Secure using Hosted Fields](/docs/checkout/advanced/customize/3d-secure/v1/sdk/) — Implement 3D Secure with hosted fields. - [Integrate 3D Secure using Card Fields](/docs/checkout/advanced/customize/3d-secure/sdk/) — Implement 3D Secure with card fields. - [3D Secure API](/docs/checkout/advanced/customize/3d-secure/api/) — API-based integration for 3D Secure. - [Response Parameters for 3D Secure](/docs/checkout/advanced/customize/3d-secure/response-parameters/) — Details on response parameters. - [Test Scenarios for 3D Secure](/docs/checkout/advanced/customize/3d-secure/test/) — How to test 3D Secure scenarios. - [Acquirer Reference Number](/docs/checkout/advanced/customize/acquirer-reference-number/) — Managing acquirer reference numbers. - [Card Field Properties](/docs/checkout/advanced/customize/card-field-properties/) — Customizing properties of card fields. - [Card Field Events](/docs/checkout/advanced/customize/card-fields-events/) — Handling events emitted by card fields. - [Fraud Protection](/docs/checkout/advanced/customize/fraud-protection/) — Basic fraud protection setup. - [Fraud Protection Advanced](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/) — Advanced fraud protection features. - [Getting started with Fraud Protection Advanced](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/getting-started/) — Introduction and setup. - [Activate Fraud Protection Advanced](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/getting-started/activate/) — How to activate advanced fraud protection. - [Upgrade Fraud Protection Advanced](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/getting-started/upgrade/) — Upgrade instructions. - [Disable Fraud Protection Advanced](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/getting-started/disable/) — How to disable the feature. - [Fraud Protection Filters](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/filters/) — How to set up filters. - [Manage Fraud Lists](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/lists/) — Manage lists for fraud protection. - [Review Fraud Transactions](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/review/) — How to review flagged transactions. - [Monitor Fraud Activity](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/monitoring/) — Monitor activity for fraud indicators. - [Integrate Fraud Protection Advanced](/docs/checkout/advanced/customize/fraud-protection/fraud-protection-advanced/integration/) — Integration guidelines. - [Real-Time Account Updater](/docs/checkout/advanced/customize/rtau/) — How to implement a real-time account updater. - [SCA Payment Indicators](/docs/checkout/advanced/customize/sca-payment-indicators/) — Understanding SCA payment indicators. - [Level 2/Level 3 Processing](/docs/checkout/advanced/customize/processing/) — Details on advanced processing requirements. - [Third-Party Network Token Processing](/docs/checkout/advanced/3rd-party-token-processing/) — How to process tokens from third-party networks. - [Update Order Details](/docs/checkout/advanced/customize/update-order-details/) — How to update order details. - [Handle Buyer Errors](/docs/checkout/advanced/customize/handle-errors/) — Strategies for error handling. - [Initiate Future Transactions](/docs/checkout/advanced/customize/reference-transactions/) — How to initiate future transactions. - [Card Decline Errors](/docs/checkout/advanced/card-decline-errors/) — Explanation of card decline error codes. - [Eligibility](/docs/checkout/advanced/eligibility/) — Determining feature eligibility. - [Upgrade Advanced Checkout](/docs/checkout/advanced/upgrade/) — Instructions to upgrade your advanced checkout integration. - [Fastlane – Reference](/docs/checkout/fastlane/reference/) — Fastlane reference for checkout. - [Fastlane – Upgrade](/docs/checkout/fastlane/upgrade/) — Fastlane upgrade instructions. ## 3rd Party Integrations & Payouts - [Pay Later offers – US Commerce Platforms](/docs/checkout/pay-later/us/commerce-platforms/) — Overview of US commerce platforms for Pay Later. - *(Further entries for specific platforms such as Angell EYE, BigCommerce, Cart.com, Centarro, CubeCart, Freewebstore, JotForm, Magento 2, Gene Commerce, IWD, Magento Braintree, Miva, OpenCart, PinnacleCart, Salesforce, Shift4Shop, Solidus, UENI, Volusion, Volt, Vortx, WooCommerce, etc.)* - [Pay Later offers – GB Commerce Platforms](/docs/checkout/pay-later/gb/commerce-platforms/) — Overview for GB commerce platforms. - *(Entries for platforms such as Angell EYE, BigCommerce, Bluepark, CubeCart, EKM, Freewebstore, Holbi, Magento 2, IWD, Gene Commerce, Magento PayPal Express, Magento Braintree, Mal's, Miva, OpenCart, RomanCart, Salesforce, Sellr, Shift4Shop, UENI, Visualsoft, Viva Wallet, etc.)* - [Pay Later offers – FR Commerce Platforms](/docs/checkout/pay-later/fr/commerce-platforms/) — Overview for French commerce platforms. - *(Entries for Angell EYE, CubeCart, Freewebstore, Magento 2, IWD, Magento PayPal Express, Magento Braintree, OpenCart, PrestaShop, SAP, Viva Wallet, WooCommerce, etc.)* - [Pay Later offers – DE Commerce Platforms](/docs/checkout/pay-later/de/commerce-platforms/) — Overview for German commerce platforms. - [Pay Later offers – AU Commerce Platforms](/docs/checkout/pay-later/au/commerce-platforms/) — Overview for Australian commerce platforms. - *(Entries for Angell EYE, BigCommerce, Commerce Vision, CubeCart, Freewebstore, Magento 2, IWD, Gene Commerce, Magento PayPal Express, Magento Braintree, Maropost, OpenCart, PrestaShop, Salesforce Commerce Cloud, SAP, WooCommerce, etc.)* - [Pay with Venmo](/docs/checkout/pay-with-venmo/) — How to integrate Venmo payments. - [Integrate Venmo](/docs/checkout/pay-with-venmo/integrate/) — Integration instructions. - [Test Venmo Integration](/docs/checkout/pay-with-venmo/test/) — How to test the Venmo integration. - [Save Payment Methods – During Purchase](/docs/checkout/save-payment-methods/during-purchase/) — How to save payment methods during a purchase. - [JS SDK: Save Cards](/docs/checkout/save-payment-methods/during-purchase/js-sdk/cards/) — Use the JS SDK to save cards. - [JS SDK: Save Apple Pay](/docs/checkout/save-payment-methods/during-purchase/js-sdk/applepay/) — Save Apple Pay details via JS SDK. - [JS SDK: Save PayPal](/docs/checkout/save-payment-methods/during-purchase/js-sdk/paypal/) — Save PayPal details. - [JS SDK: Save Venmo](/docs/checkout/save-payment-methods/during-purchase/js-sdk/venmo/) — Save Venmo details. - [Orders API: Save Cards](/docs/checkout/save-payment-methods/during-purchase/orders-api/cards/) — Using Orders API for saving cards. - [Orders API: Save PayPal](/docs/checkout/save-payment-methods/during-purchase/orders-api/paypal/) — Using Orders API for saving PayPal. - [Save Payment Methods – Purchase Later](/docs/checkout/save-payment-methods/purchase-later/) — How to save payment methods for later purchase. - *(Includes additional entries for JS SDK, Android SDK, iOS SDK, Payment Tokens API, etc.)* - [Alternative Payment Methods (APMs)](/docs/checkout/apm/) — Overview of alternative payment methods. - [Apple Pay](/docs/checkout/apm/apple-pay/) — Integration for Apple Pay. - [Bancontact](/docs/checkout/apm/bancontact/) — Integration for Bancontact. - [JS SDK](/docs/checkout/apm/bancontact/js-sdk/) — Using JS SDK for Bancontact. - [Orders API](/docs/checkout/apm/bancontact/orders-api/) — Using Orders API for Bancontact. - [BLIK](/docs/checkout/apm/blik/) — Integration for BLIK. - [JS SDK](/docs/checkout/apm/blik/js-sdk/) — Using JS SDK for BLIK. - [Orders API](/docs/checkout/apm/blik/orders-api/) — Using Orders API for BLIK. - [EPS](/docs/checkout/apm/eps/) — Integration for EPS. - [JS SDK](/docs/checkout/apm/eps/js-sdk/) — Using JS SDK for EPS. - [Orders API](/docs/checkout/apm/eps/orders-api/) — Using Orders API for EPS. - [iDEAL](/docs/checkout/apm/ideal/) — Integration for iDEAL. - [JS SDK](/docs/checkout/apm/ideal/js-sdk/) — Using JS SDK for iDEAL. - [Orders API](/docs/checkout/apm/ideal/orders-api/) — Using Orders API for iDEAL. - [Multibanco](/docs/checkout/apm/multibanco/) — Integration for Multibanco. - [JS SDK](/docs/checkout/apm/multibanco/js-sdk/) — Using JS SDK for Multibanco. - [Orders API](/docs/checkout/apm/multibanco/orders-api/) — Using Orders API for Multibanco. - [MyBank](/docs/checkout/apm/mybank/) — Integration for MyBank. - [JS SDK](/docs/checkout/apm/mybank/js-sdk/) — Using JS SDK for MyBank. - [Orders API](/docs/checkout/apm/mybank/orders-api/) — Using Orders API for MyBank. - [Pay upon Invoice](/docs/checkout/apm/pay-upon-invoice/) — Integration for Pay upon Invoice. - [Integrate PUI](/docs/checkout/apm/pay-upon-invoice/integrate-pui-merchant/) — Merchant integration for Pay upon Invoice. - [FraudNet for PUI](/docs/checkout/apm/pay-upon-invoice/fraudnet/) — How to integrate FraudNet with Pay upon Invoice. - [Przelewy24](/docs/checkout/apm/przelewy24/) — Integration for Przelewy24. - [JS SDK](/docs/checkout/apm/przelewy24/js-sdk/) — Using JS SDK for Przelewy24. - [Orders API](/docs/checkout/apm/przelewy24/orders-api/) — Using Orders API for Przelewy24. - [Trustly](/docs/checkout/apm/trustly/) — Integration for Trustly. - [JS SDK](/docs/checkout/apm/trustly/js-sdk/) — Using JS SDK for Trustly. - [Orders API](/docs/checkout/apm/trustly/orders-api/) — Using Orders API for Trustly. - [Reference for APMs](/docs/checkout/apm/reference/) — APM reference documentation. ## Additional Topics - [Payment Methods](/docs/checkout/payment-methods/) — Overview of online payment methods. - [Subscriptions REST API](/docs/api/subscriptions/v1/) — REST API documentation for subscriptions. - [Catalog Products REST API](/docs/api/catalog-products/v1/) — REST API documentation for catalog products. - [Support](/docs/support/) — How to get help and support. - [Invoicing](/docs/invoicing/) — Overview of invoicing features. - [Integrate Invoicing](/docs/invoicing/integrate/) — How to integrate invoicing. - [Customize Invoicing](/docs/invoicing/customize/) — Customization options for invoicing. - [Test and Go Live for Invoicing](/docs/invoicing/test-and-go-live/) — Testing your invoicing integration. - [Reference for Invoicing](/docs/invoicing/reference/) — Invoicing reference documentation. - [Invoicing REST API](/docs/api/invoicing/v2/#invoices/) — REST API for invoicing. - [Invoicing Webhooks](/docs/invoicing/webhooks/) — Webhook integration for invoicing. - [3rd Party](/docs/3rd-party/) — Overview of third-party integrations. - [Plugins](/docs/3rd-party/plugins/) — Available plugins and integrations. - [Payouts](/docs/payouts/) — Overview of payout solutions. - [Standard Payouts](/docs/payouts/standard/) — Documentation for standard payout integrations. - [Integrate API for Payouts](/docs/payouts/standard/integrate-api/) — How to integrate the Payouts API. - [Customize Payouts API](/docs/payouts/standard/integrate-api/customize/) — Customization options for the Payouts API. - [Test and Go Live for Payouts API](/docs/payouts/standard/integrate-api/test-and-go-live/) — Testing the Payouts API. - [Large Batch Payouts](/docs/payouts/standard/large-batch/) — Managing large batch payouts. - [File Validation Errors](/docs/payouts/standard/large-batch/file-validation-errors/) — Handling file validation errors. - [Payouts Web](/docs/payouts/standard/payouts-web/) — Web-based payouts solution. - [Customize Payouts Web](/docs/payouts/standard/payouts-web/customize/) — Customizing your payouts web experience. - [Reports for Payouts](/docs/payouts/standard/reports/) — Payout reporting tools. - [Search Transactions on Reports Page](/docs/payouts/standard/reports/search-transactions/) — How to search transactions in reports. - [View Transaction Activities](/docs/payouts/standard/reports/view-transaction-activities/) — Viewing transaction activity details. - [Get Settlement and Transaction Details](/docs/payouts/standard/reports/settlement-and-transaction-details/) — Retrieve settlement and transaction details. - [Log in with PayPal for Payouts](/docs/payouts/standard/login-with-payouts/) — How to log in with PayPal for payouts. - [Use Payouts to Venmo](/docs/payouts/standard/payouts-to-venmo/) — How to use Venmo for payouts. - [Payouts Reference](/docs/payouts/standard/reference/) — Reference documentation for payouts. - [Payouts SDK](/docs/payouts/standard/reference/sdk/) — SDK reference for payouts. - [Payouts webhooks](/docs/payouts/standard/reference/webhooks/) — Webhook integration reference. - [Currency Conversion for Payouts](/docs/payouts/standard/reference/currency-conversion/) — Guidelines for currency conversion.