# Paypal Docs

## Docs

- [Payment links, buttons, and QR codes](https://paypal-sb-staging.mintlify.site/payments/methods/pay-links-buttons.md)
- [Payment Links and Buttons API](https://paypal-sb-staging.mintlify.site/payments/methods/pay-links-buttons-api.md)
- [Integrate PayPal Checkout with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/paypal/sdk/js/v6/paypal-checkout.md)
- [Integrate PayPal directly with the Orders v2 API](https://paypal-sb-staging.mintlify.site/payments/methods/paypal/api/one-time/orders-api-integration.md)
- [Pay Later](https://paypal-sb-staging.mintlify.site/payments/methods/pay-later/overview.md)
- [Get started with Pay Later](https://paypal-sb-staging.mintlify.site/payments/methods/pay-later/get-started.md)
- [Analytics logging](https://paypal-sb-staging.mintlify.site/payments/methods/pay-later/analytics.md)
- [Integrate Venmo with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/venmo/integrate.md)
- [Fastlane integration](https://paypal-sb-staging.mintlify.site/payments/methods/cards/fastlane.md)
- [Render card fields for one-time checkout with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/cards/js-sdk-v6-card-fields-one-time.md)
- [Integrate standalone payment buttons with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/cards/standalone-payment-button.md)
- [Integrate 3D Secure with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/cards/3ds.md)
- [Integrate Apple Pay with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/digital-wallets/apple-pay.md)
- [Integrate Google Pay with PayPal's JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/payments/methods/digital-wallets/google-pay.md)
- [Save PayPal with and without purchase with the JavaScript SDK](https://paypal-sb-staging.mintlify.site/payments/save/sdk/paypal/js-sdk-v6-vault.md)
- [Save cards with purchase with the JavaScript SDK](https://paypal-sb-staging.mintlify.site/payments/save/sdk/cards/js-sdk-v6-vault.md)
- [Save cards without purchase with the JavaScript SDK](https://paypal-sb-staging.mintlify.site/payments/save/sdk/cards/js-sdk-v6-vault-no-purchase.md)
- [Save payment methods directly with the Payment Method Tokens API](https://paypal-sb-staging.mintlify.site/payments/save/api/vault-api-integration.md)
- [Test saving cards with a direct Payment Method Tokens API integration](https://paypal-sb-staging.mintlify.site/payments/save/api/vault-api-integration-test.md)
- [PayPal Direct App Switch integration](https://paypal-sb-staging.mintlify.site/payments/features/app-switch.md)
- [Sandboxed <iframe> integration](https://paypal-sb-staging.mintlify.site/payments/features/iframe.md)
- [Overview](https://paypal-sb-staging.mintlify.site/growth/grow-business/invoicing/overview.md)
- [Integrate Invoicing API](https://paypal-sb-staging.mintlify.site/growth/grow-business/invoicing/integrate.md)
- [Test and go live with invoicing](https://paypal-sb-staging.mintlify.site/growth/grow-business/invoicing/test-go-live.md)
- [Invoicing webhooks](https://paypal-sb-staging.mintlify.site/growth/grow-business/invoicing/webhooks.md)
- [Troubleshooting Invoicing API](https://paypal-sb-staging.mintlify.site/growth/grow-business/invoicing/troubleshooting.md)
- [Add a Donate button to your website with PayPal's Donate SDK](https://paypal-sb-staging.mintlify.site/growth/grow-business/donate/integration.md)
- [Send, track, and manage payouts to multiple recipients](https://paypal-sb-staging.mintlify.site/growth/payouts/paypal-enterprise-payouts.md)
- [PayPal Payouts overview](https://paypal-sb-staging.mintlify.site/growth/payouts/overview.md)
- [Set up accounts and environment for payouts](https://paypal-sb-staging.mintlify.site/growth/payouts/set-up.md)
- [Plan your integration](https://paypal-sb-staging.mintlify.site/growth/payouts/plan-your-integration.md)
- [Use Web UI](https://paypal-sb-staging.mintlify.site/growth/payouts/send-money/use-web-ui.md)
- [Use large-batch file transfer](https://paypal-sb-staging.mintlify.site/growth/payouts/send-money/use-large-batch-file-transfer.md)
- [Use Payouts API](https://paypal-sb-staging.mintlify.site/growth/payouts/send-money/use-payouts-api.md)
- [Customize Web UI payouts](https://paypal-sb-staging.mintlify.site/growth/payouts/customize/customize-web-ui-payouts.md)
- [Customize Payouts API integration](https://paypal-sb-staging.mintlify.site/growth/payouts/customize/customize-payouts-api-integration.md)
- [Collect recipient information with AAC](https://paypal-sb-staging.mintlify.site/growth/payouts/customize/integrate-aac.md)
- [Track payout item status](https://paypal-sb-staging.mintlify.site/growth/payouts/manage-payouts/track-payout-item-status.md)
- [Cancel or reverse payouts](https://paypal-sb-staging.mintlify.site/growth/payouts/manage-payouts/cancel-reverse-payouts.md)
- [Handle unclaimed payouts](https://paypal-sb-staging.mintlify.site/growth/payouts/manage-payouts/handle-unclaimed-payouts.md)
- [View reports and transaction logs](https://paypal-sb-staging.mintlify.site/growth/payouts/manage-payouts/reports-transaction-logs.md)
- [Payouts API - test values](https://paypal-sb-staging.mintlify.site/growth/payouts/reference/payouts-api-test-values.md)
- [Payouts SDK](https://paypal-sb-staging.mintlify.site/growth/payouts/reference/payouts-sdk.md)
- [Countries and supported features](https://paypal-sb-staging.mintlify.site/growth/payouts/reference/countries-supported-features.md)
- [Use Enterprise Payouts - Hyperwallet](https://paypal-sb-staging.mintlify.site/growth/payouts/use-advanced-payouts.md)
- [Grow and run your business with reports and analytics](https://paypal-sb-staging.mintlify.site/growth/reports/overview.md)
- [How reports and analytics work](https://paypal-sb-staging.mintlify.site/growth/reports/how-it-works.md)
- [Get started with PayPal reports](https://paypal-sb-staging.mintlify.site/growth/reports/get-started.md)
- [Download reports from your dashboard](https://paypal-sb-staging.mintlify.site/growth/reports/dashboard-downloads.md)
- [Integrate reports using Transaction Reports API](https://paypal-sb-staging.mintlify.site/growth/reports/api.md)
- [Manage and automate reports](https://paypal-sb-staging.mintlify.site/growth/reports/manage-automate.md)
- [Test and verify reports](https://paypal-sb-staging.mintlify.site/growth/reports/test-verify-reports.md)
- [Report fields and formats reference](https://paypal-sb-staging.mintlify.site/growth/reports/fields-formats.md)
- [Troubleshooting reports and analytics](https://paypal-sb-staging.mintlify.site/growth/reports/troubleshooting.md)
- [Agentic commerce services](https://paypal-sb-staging.mintlify.site/growth/agentic-commerce/overview.md)
- [Quickstart guide](https://paypal-sb-staging.mintlify.site/growth/agentic-commerce/quickstart.md)
- [Product feed integration](https://paypal-sb-staging.mintlify.site/growth/agentic-commerce/product-feed-integration.md)
- [Cart orchestration](https://paypal-sb-staging.mintlify.site/growth/agentic-commerce/cart-orchestration-integration.md)
- [Create cart](https://paypal-sb-staging.mintlify.site/reference/api/rest/cart-operations/create-cart.md): Creates a new cart with the provided PayPalCart object. This is called by PayPal Shopping Cart when an AI agent or customer initiates a checkout process.
- [Get cart details](https://paypal-sb-staging.mintlify.site/reference/api/rest/cart-operations/get-cart-details.md): Retrieves the current state of a cart. Used by PayPal Shopping Cart to check cart status, validation issues, and current totals.
- [Update cart](https://paypal-sb-staging.mintlify.site/reference/api/rest/cart-operations/update-cart.md): Updates a cart by completely replacing its contents with the provided PayPalCart object. This is used when customers make changes like adding items, updating shipping address, applying coupons, or completing checkout fields.
- [Complete checkout](https://paypal-sb-staging.mintlify.site/reference/api/rest/checkout/complete-checkout.md): Completes the checkout process after customer has approved payment via PayPal. This endpoint receives the payment method with payer_id and finalizes the order.
- [Get started with PayPal REST APIs](https://paypal-sb-staging.mintlify.site/developer/how-to/api/get-started.md)
- [Making PayPal REST API requests](https://paypal-sb-staging.mintlify.site/developer/how-to/api/make-api-requests.md)
- [Handling API responses when integrating with PayPal APIs](https://paypal-sb-staging.mintlify.site/developer/how-to/api/handling-api-responses.md)
- [Rate limiting with PayPal REST APIs](https://paypal-sb-staging.mintlify.site/developer/how-to/api/rate-limiting.md)
- [Handling payment failures with PayPal](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/handling-payment-failures-with-paypal.md)
- [Common errors overview](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/overview.md)
- [Resource not found](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/resource-not-found.md)
- [Unprocessable entity](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/unprocessable-entity.md)
- [Agreement already canceled](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/agreement-already-cancelled.md)
- [Cannot pay self](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/cannot-pay-self.md)
- [Currency mismatch](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/currency-mismatch.md)
- [Currency not allowed](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/currency-not-allowed.md)
- [Duplicate transactions](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/duplicate-transaction.md)
- [Merchant not enabled for reference transaction](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/merchant-not-enabled-for-reference-transaction.md)
- [Not authorized](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/not-authorized.md)
- [Unsupported payee currency](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/unsupported-payee-currency.md)
- [Validation error](https://paypal-sb-staging.mintlify.site/developer/how-to/api/troubleshooting/common-errors/validation-error.md)
- [Set up JavaScript SDK v6](https://paypal-sb-staging.mintlify.site/developer/how-to/sdk/js/v6/configuration.md)
- [Upgrade from v5](https://paypal-sb-staging.mintlify.site/developer/upgrade/sdk/js/v5-v6.md)
- [Apps, scopes, and credentials](https://paypal-sb-staging.mintlify.site/developer/how-to/apps-scopes-credentials.md)
- [PayPal security guidelines for developers](https://paypal-sb-staging.mintlify.site/developer/how-to/security-guidelines.md)
- [Test card generator](https://paypal-sb-staging.mintlify.site/developer/sandbox/card-generator.md)
- [PayPal's AI resources for developers](https://paypal-sb-staging.mintlify.site/developer/tools/ai/ai-intro.md)
- [Agent toolkit quickstart guide](https://paypal-sb-staging.mintlify.site/developer/tools/ai/agent-toolkit-quickstart.md)
- [Agent tools reference](https://paypal-sb-staging.mintlify.site/developer/tools/ai/agent-tools-ref.md)
- [LLM integration quickstart guide](https://paypal-sb-staging.mintlify.site/developer/tools/ai/llm-integration.md)
- [MCP server quickstart guide](https://paypal-sb-staging.mintlify.site/developer/tools/ai/mcp-quickstart.md)
- [Prompts](https://paypal-sb-staging.mintlify.site/developer/tools/ai/prompt-best-practices.md)
- [PayPal JavaScript SDK v6 Reference](https://paypal-sb-staging.mintlify.site/reference/sdk/js/v6/reference.md)
- [Create order](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/create-order.md): Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal…
- [Show order details](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/show-order-details.md): Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
- [Update order](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/update-order.md): Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables y…
- [Confirm the Order](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/confirm-the-order.md): Payer confirms their intent to pay for the the Order with the given payment source.
- [Authorize payment for order](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/authorize-payment-for-order.md): Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the…
- [Capture payment for order](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/capture-payment-for-order.md): Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the crea…
- [Add tracking information for an Order.](https://paypal-sb-staging.mintlify.site/reference/api/rest/orders/add-tracking-information-for-an-order.md): Adds tracking information for an Order.
- [Update or cancel tracking information for an order](https://paypal-sb-staging.mintlify.site/reference/api/rest/trackers/update-or-cancel-tracking-information-for-an-order.md): Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody></tr><tr><td><code>items</code></td><td>replace</td><td>Using replace op for <code>items</code> will replace the en…
- [Receive updated order information via callback URL](https://paypal-sb-staging.mintlify.site/reference/api/rest/externalcallback/receive-updated-order-information-via-callback-url.md): The documentation for this 'endpoint' is different from the other endpoints under v2 Orders. For this endpoint the role of client and server is reversed. The client sending the request is PayPal, and the server sending the response is the merchant. In the request, PayPal will send the buyer's redact…
- [Show details for authorized payment](https://paypal-sb-staging.mintlify.site/reference/api/rest/authorizations/show-details-for-authorized-payment.md): Shows details for an authorized payment, by ID.
- [Capture authorized payment](https://paypal-sb-staging.mintlify.site/reference/api/rest/authorizations/capture-authorized-payment.md): Captures an authorized payment, by ID.
- [Reauthorize authorized payment](https://paypal-sb-staging.mintlify.site/reference/api/rest/authorizations/reauthorize-authorized-payment.md): Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30…
- [Void authorized payment](https://paypal-sb-staging.mintlify.site/reference/api/rest/authorizations/void-authorized-payment.md): Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
- [Show captured payment details](https://paypal-sb-staging.mintlify.site/reference/api/rest/captures/show-captured-payment-details.md): Shows details for a captured payment, by ID.
- [Refund captured payment](https://paypal-sb-staging.mintlify.site/reference/api/rest/captures/refund-captured-payment.md): Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an <code>amount</code> object in the JSON request body.
- [Show refund details](https://paypal-sb-staging.mintlify.site/reference/api/rest/refunds/show-refund-details.md): Shows details for a refund, by ID.
- [List all payment tokens](https://paypal-sb-staging.mintlify.site/reference/api/rest/payment-tokens/list-all-payment-tokens.md): Returns all payment tokens for a customer.
- [Create payment token for a given payment source](https://paypal-sb-staging.mintlify.site/reference/api/rest/payment-tokens/create-payment-token-for-a-given-payment-source.md): Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
- [Retrieve a payment token](https://paypal-sb-staging.mintlify.site/reference/api/rest/payment-tokens/retrieve-a-payment-token.md): Returns a readable representation of vaulted payment source associated with the payment token id.
- [Delete payment token](https://paypal-sb-staging.mintlify.site/reference/api/rest/payment-tokens/delete-payment-token.md): Delete the payment token associated with the payment token id.
- [Create a setup token](https://paypal-sb-staging.mintlify.site/reference/api/rest/setup-tokens/create-a-setup-token.md): Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
- [Retrieve a setup token](https://paypal-sb-staging.mintlify.site/reference/api/rest/setup-tokens/retrieve-a-setup-token.md): Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
- [List invoices](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/list-invoices.md): Lists invoices. To filter the invoices that appear in the response, you can specify one or more optional query parameters.
- [Create draft invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/create-draft-invoice.md): Creates a draft invoice. To move the invoice from a draft to payable state, you must <a href="#invoices_send">send the invoice</a>.<br/><br/>In the JSON request body, include invoice details including merchant information. The <code>invoice</code> object must include an <code>items</code> array.<blo…
- [Send invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/send-invoice.md): Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date:<ul><li>If the invoice issue date is current or in the past, sends the invoice immediately.</li><li>If the invoice issue date is in the future, schedules the invoice to be sent on that date.<…
- [Send invoice reminder](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/send-invoice-reminder.md): Sends a reminder to the payer about an invoice, by ID. In the JSON request body, include a `notification` object that defines the subject of the reminder and other details. <blockquote><strong>Notes:</strong><ul><li>API caller can send only 2 reminders in a day.</li></ul></blockquote>.
- [Cancel sent invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/cancel-sent-invoice.md): Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and CC: emails.
- [Record payment for invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/record-payment-for-invoice.md): Records a payment for the invoice. If no payment is due, the invoice is marked as `PAID`. Otherwise, the invoice is marked as `PARTIALLY PAID`.
- [Delete external payment](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/delete-external-payment.md): Deletes an external payment, by invoice ID and transaction ID.
- [Record refund for invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/record-refund-for-invoice.md): Records a refund for the invoice. If all payments are refunded, the invoice is marked as `REFUNDED`. Otherwise, the invoice is marked as `PARTIALLY REFUNDED`.
- [Delete external refund](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/delete-external-refund.md): Deletes an external refund, by invoice ID and transaction ID.
- [Generate QR code](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/generate-qr-code.md): Generates a QR code for an invoice, by ID. The QR code is a PNG image in <a href="https://www.base64encode.org/">Base64-encoded</a> format that corresponds to the invoice ID. You can generate a QR code for an invoice and add it to a paper or PDF invoice. When customers use their mobile devices to sc…
- [Generate invoice number](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/generate-invoice-number.md): Generates the next invoice number that is available to the merchant. The next invoice number uses the prefix and suffix from the last invoice number and increments the number by one. For example, the next invoice number after `INVOICE-1234` is `INVOICE-1235`.
- [Show invoice details](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/show-invoice-details.md): Shows details for an invoice, by ID.
- [Fully update invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/fully-update-invoice.md): Fully updates an invoice, by ID. In the JSON request body, include a complete `invoice` object. This call does not support partial updates. <blockquote><strong>Notes:</strong><ul><li>API caller can change/modify recipient only 2 times in 72 hours.</li></ul></blockquote>.
- [Delete invoice](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoices/delete-invoice.md): Deletes a draft or scheduled invoice, by ID. Deletes invoices in the draft or scheduled state only. For invoices that have already been sent, you can <a href="/docs/api/invoicing/v2/#invoices_cancel">cancel the invoice</a>. After you delete a draft or scheduled invoice, you can no longer use it or s…
- [Search for invoices](https://paypal-sb-staging.mintlify.site/reference/api/rest/search-invoices/search-for-invoices.md): Searches for and lists invoices that match search criteria. If you pass multiple criteria, the response lists invoices that match all criteria.
- [List templates](https://paypal-sb-staging.mintlify.site/reference/api/rest/templates/list-templates.md): Lists merchant-created templates with associated details. The associated details include the emails, addresses, and phone numbers from the user's PayPal profile.<br/>The user can select which values to show in the business information section of their template.
- [Create template](https://paypal-sb-staging.mintlify.site/reference/api/rest/templates/create-template.md): Creates an invoice template. You can use details from this template to create an invoice. You can create up to 50 templates.<blockquote><strong>Note:</strong> Every merchant starts with three PayPal system templates that are optimized for the unit type billed. The template includes `Quantity`, `Hour…
- [Show template details](https://paypal-sb-staging.mintlify.site/reference/api/rest/templates/show-template-details.md): Shows details for a template, by ID.
- [Fully update template](https://paypal-sb-staging.mintlify.site/reference/api/rest/templates/fully-update-template.md): Fully updates a template, by ID. In the JSON request body, include a complete `template` object. This call does not support partial updates.
- [Delete template](https://paypal-sb-staging.mintlify.site/reference/api/rest/templates/delete-template.md): Deletes a template, by ID.
- [List Connections.](https://paypal-sb-staging.mintlify.site/reference/api/rest/connections/list-connections.md): Lists connections to accounting platforms per merchant.
- [List Connection Status for an Invoice.](https://paypal-sb-staging.mintlify.site/reference/api/rest/invoice-connection-details/list-connection-status-for-an-invoice.md): Lists connections to accounting platforms per invoice.
- [Create Exchange Rate Quote](https://paypal-sb-staging.mintlify.site/reference/api/rest/quote-exchange-rates/create-exchange-rate-quote.md): <strong>Purpose:</strong><ul><p>The PayPal Exchange Rate Quote API enables businesses to dynamically display prices in multiple currencies by generating exchange rate quotes for currency pair.</p></ul><strong>Key Features:</strong><ul><p>FX Rate Guarantee: Guarantees exchange rates for a specified d…
- [List transactions](https://paypal-sb-staging.mintlify.site/reference/api/rest/transactions/list-transactions.md): Lists transactions. Specify one or more query parameters to filter the transaction that appear in the response.<blockquote><strong>Notes:</strong> <ul><li>If you specify one or more optional query parameters, the <code>ending_balance</code> response field is empty.</li><li>It takes a maximum of thre…
- [List all balances](https://paypal-sb-staging.mintlify.site/reference/api/rest/balances/list-all-balances.md): List all balances. Specify date time to list balances for that time that appear in the response.<blockquote><strong>Notes:</strong> <ul><li>It takes a maximum of three hours for balances to appear in the list balances call.</li><li>This call lists balances upto the previous three years.</li></ul></b…
- [Create batch payout](https://paypal-sb-staging.mintlify.site/reference/api/rest/payouts/create-batch-payout.md): Creates a batch payout. In the JSON request body, pass a `sender_batch_header` and an `items` array. The `sender_batch_header` defines how to handle the payout. The `items` array defines the payout items.<br/>You can make payouts to one or more recipients.<blockquote><strong>Notes:</strong> <ul><li>…
- [Show payout batch details](https://paypal-sb-staging.mintlify.site/reference/api/rest/payouts/show-payout-batch-details.md): Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.
- [Show payout item details](https://paypal-sb-staging.mintlify.site/reference/api/rest/payouts-item/show-payout-item-details.md): Shows details for a payout item, by ID. A <code>payout_item_id</code> helps you identify denied payments. If a payment is denied, you can use the <code>payout_item_id</code> to identify the payment even if it lacks a <code>transaction_id</code>.
- [Cancel unclaimed payout item](https://paypal-sb-staging.mintlify.site/reference/api/rest/payouts-item/cancel-unclaimed-payout-item.md): Cancels an unclaimed payout item, by ID. If no one claims the unclaimed item within 30 days, the API automatically returns the funds to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund. You can cancel payout items with a <code>transaction_status</code> of <co…
- [List webhooks](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks/list-webhooks.md): Lists webhooks for an app.
- [Create webhook](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks/create-webhook.md): Subscribes your webhook listener to events.
- [Show webhook details](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks/show-webhook-details.md): Shows details for a webhook, by ID.
- [Delete webhook](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks/delete-webhook.md): Deletes a webhook, by ID.
- [Update webhook](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks/update-webhook.md): Updates a webhook to replace webhook fields with new values. Supports only the `replace` operation. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events.
- [List event subscriptions for webhook](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks/list-event-subscriptions-for-webhook.md): Lists event subscriptions for a webhook, by ID.
- [List webhook lookups](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-lookup/list-webhook-lookups.md): Lists webhook lookups.
- [Create webhook lookup](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-lookup/create-webhook-lookup.md): Creates a webhook lookup. A webhook lookup ties the API caller's REST API app to the subject account (or, if no subject is specified, to the API caller's account). If a webhook event is generated for an event that is tied to the account but not to a particular REST API app (for example, payments ini…
- [Show webhook lookup details](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-lookup/show-webhook-lookup-details.md): Shows details for a webhook lookup, by ID.
- [Delete webhook lookup](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-lookup/delete-webhook-lookup.md): Deletes a webhook lookup, by ID.
- [Verify webhook signature](https://paypal-sb-staging.mintlify.site/reference/api/rest/verify-webhook-signature/verify-webhook-signature.md): Verifies a webhook signature.
- [List available events](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-event-types/list-available-events.md): Lists available events to which any webhook can subscribe. For a list of supported events, see [Webhook event names](/docs/api/notifications/webhooks/event-names/).
- [List event notifications](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-events/list-event-notifications.md): Lists webhooks event notifications. Use query parameters to filter the response.
- [Show event notification details](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-events/show-event-notification-details.md): Shows details for a webhooks event notification, by ID.
- [Resend event notification](https://paypal-sb-staging.mintlify.site/reference/api/rest/webhooks-events/resend-event-notification.md): Resends a webhook event notification, by ID. Any pending notifications are not resent.
- [Simulate webhook event](https://paypal-sb-staging.mintlify.site/reference/api/rest/simulate-event/simulate-webhook-event.md): Simulates a webhook event. In the JSON request body, specify a sample payload.<br>You need to subscribe to the following webhook events for Pay upon Invoice:<br><table><thead><tr><th>Event</th><th>Trigger</th></tr></thead><tbody><tr><td><code>PAYMENT.CAPTURE.COMPLETED</code></td><td>A payment captur…
- [List disputes](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes/list-disputes.md): Lists disputes with a summary set of details, which shows the <code>dispute_id</code>, <code>reason</code>, <code>status</code>, <code>dispute_state</code>, <code>dispute_life_cycle_stage</code>, <code>dispute_channel</code>, <code>dispute_amount</code>, <code>create_time</code> and <code>update_tim…
- [Show dispute details](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes/show-dispute-details.md): Shows details for a dispute, by ID.<blockquote><strong>Note:</strong> The fields that appear in the response depend on the access. For example, if the merchant requests shows dispute details, the customer's email ID does not appear.</blockquote>
- [Partially update dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes/partially-update-dispute.md): Partially updates a dispute, by ID. Seller can update the `communication_detail` value or The partner can add the `partner action` information.
- [Provide evidence](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/provide-evidence.md): Provides evidence for a dispute, by ID. A merchant can provide evidence for disputes with the <code>WAITING_FOR_SELLER_RESPONSE</code> status while customers can provide evidence for disputes with the <code>WAITING_FOR_BUYER_RESPONSE</code> status. Evidence can be a proof of delivery or proof of ref…
- [Appeal dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/appeal-dispute.md): Appeals a dispute, by ID. To appeal a dispute, use the <code>appeal</code> link in the <a href="/docs/api/reference/api-responses/#hateoas-links/">HATEOAS links</a> from the show dispute details response. If this link does not appear, you cannot appeal the dispute. Submit new evidence as a document…
- [Accept claim](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/accept-claim.md): Accepts liability for a claim, by ID. When you accept liability for a claim, the dispute closes in the customer’s favor and PayPal automatically refunds money to the customer from the merchant's account. Allowed accept_claim_type values for the request is available in dispute details <a href="/docs/…
- [Settle dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/settle-dispute.md): <blockquote><strong>Important:</strong> This method is for sandbox use only.</blockquote> Settles a dispute in either the customer's or merchant's favor. Merchants can make this call in the sandbox to complete end-to-end dispute resolution testing, which mimics the dispute resolution that PayPal age…
- [Update dispute status](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/update-dispute-status.md): <blockquote><strong>Important:</strong> This method is for sandbox use only.</blockquote> Updates the status of a dispute, by ID, from <code>UNDER_REVIEW</code> to either:<ul><li><code>WAITING_FOR_BUYER_RESPONSE</code></li><li><code>WAITING_FOR_SELLER_RESPONSE</code></li></ul>This status change enab…
- [Escalate dispute to claim](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/escalate-dispute-to-claim.md): Escalates the dispute, by ID, to a PayPal claim. To make this call, the stage in the dispute lifecycle must be `INQUIRY`.
- [Send message about dispute to other party](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/send-message-about-dispute-to-other-party.md): Sends a message about a dispute, by ID, to the other party in the dispute. Merchants and customers can only send messages if the `dispute_life_cycle_stage` value is `INQUIRY`. For constraints and rules regarding documents that can be attached as part of the message, see <a href="/docs/integration/di…
- [Make offer to resolve dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/make-offer-to-resolve-dispute.md): Makes an offer to the other party to resolve a dispute, by ID. To make this call, the stage in the dispute lifecycle must be `INQUIRY`. If the customer accepts the offer, PayPal automatically makes a refund. Allowed offer_type values for the request is available in dispute details <a href="/docs/api…
- [Accept offer to resolve dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/accept-offer-to-resolve-dispute.md): The customer accepts the offer from merchant to resolve a dispute, by ID. PayPal automatically refunds the amount proposed by merchant to the customer.
- [Deny offer to resolve dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/deny-offer-to-resolve-dispute.md): Denies an offer that the merchant proposes for a dispute, by ID.
- [Acknowledge returned item](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/acknowledge-returned-item.md): Acknowledges that the customer returned an item for a dispute, by ID. A merchant can make this request for disputes with the `MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` reason. Allowed acknowledgement_type values for the request is available in dispute details <a href="/docs/api/customer-disputes/v1/#…
- [Provide supporting information for dispute](https://paypal-sb-staging.mintlify.site/reference/api/rest/disputes-actions/provide-supporting-information-for-dispute.md): Provides supporting information for a dispute, by ID. A merchant or buyer can make this request for disputes if they find the `provide-supporting-info` link in the HATEOAS links in the list disputes response. The party can provide the supporting information to PayPal to defend themselves only when t…
- [Country and region codes](https://paypal-sb-staging.mintlify.site/reference/codes/country-codes.md)
- [Currency codes](https://paypal-sb-staging.mintlify.site/reference/codes/currency-codes.md)
- [State and province codes](https://paypal-sb-staging.mintlify.site/reference/codes/state-province-codes.md)
- [Locale codes](https://paypal-sb-staging.mintlify.site/reference/codes/locale-codes.md)
- [Webhook message format](https://paypal-sb-staging.mintlify.site/reference/webhook-events/webhook-format.md)
- [Orders V2](https://paypal-sb-staging.mintlify.site/reference/webhook-events/orders-v2.md)
- [Payments v2](https://paypal-sb-staging.mintlify.site/reference/webhook-events/payments-v2.md)
- [Payment Method Tokens v3](https://paypal-sb-staging.mintlify.site/reference/webhook-events/payment-method-tokens-v3.md)
- [Payouts v1](https://paypal-sb-staging.mintlify.site/reference/webhook-events/payouts-v1.md)
- [Invoicing v2](https://paypal-sb-staging.mintlify.site/reference/webhook-events/invoicing-v2.md)
- [Disputes v1](https://paypal-sb-staging.mintlify.site/reference/webhook-events/disputes-v1.md)

## OpenAPI Specs

- [openapi](https://paypal-sb-staging.mintlify.site/openapi.yml)
- [vault_payment_tokens_v3](https://paypal-sb-staging.mintlify.site/api-reference/vault_payment_tokens_v3.json)
- [ubb_v1](https://paypal-sb-staging.mintlify.site/api-reference/ubb_v1.json)
- [ubb_openapi_inline](https://paypal-sb-staging.mintlify.site/api-reference/ubb_openapi_inline.json)
- [reporting_transactions_v1](https://paypal-sb-staging.mintlify.site/api-reference/reporting_transactions_v1.json)
- [paypal-cart-agentic-commerce-v1](https://paypal-sb-staging.mintlify.site/api-reference/paypal-cart-agentic-commerce-v1.yaml)
- [payments_payouts_batch_v1](https://paypal-sb-staging.mintlify.site/api-reference/payments_payouts_batch_v1.json)
- [payments_payment_v2](https://paypal-sb-staging.mintlify.site/api-reference/payments_payment_v2.json)
- [payments_payment_v1](https://paypal-sb-staging.mintlify.site/api-reference/payments_payment_v1.json)
- [notifications_webhooks_v1](https://paypal-sb-staging.mintlify.site/api-reference/notifications_webhooks_v1.json)
- [invoicing_v2](https://paypal-sb-staging.mintlify.site/api-reference/invoicing_v2.json)
- [invoicing_v1](https://paypal-sb-staging.mintlify.site/api-reference/invoicing_v1.json)
- [customer_disputes_v1](https://paypal-sb-staging.mintlify.site/api-reference/customer_disputes_v1.json)
- [currency_exchange_v2](https://paypal-sb-staging.mintlify.site/api-reference/currency_exchange_v2.json)
- [checkout_orders_v2](https://paypal-sb-staging.mintlify.site/api-reference/checkout_orders_v2.json)
- [checkout_orders_v1](https://paypal-sb-staging.mintlify.site/api-reference/checkout_orders_v1.json)

## Optional

- [Server SDKs](https://developer.paypal.com/serversdk/java/getting-started/how-to-get-started)