PayPal
PayPal is a global online payment system that lets individuals and businesses send and receive money electronically. PayPal exposes a broad surface of REST APIs covering payments, orders, subscriptions, invoicing, payouts, disputes, payment tokens, shipping tracking, transaction reporting, partner referrals, payment experience, and webhook notifications.
Solid contracts, transparent operations, and an easy start — typically complete on four or five facets with one clear soft spot.
API Evangelist profiles PayPal the way a machine reads it — 672 machine-readable artifacts across 37 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — PayPal scores 66.7/100 (strong), with a separate agent-readiness read of 56/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
How we profile PayPal
Each block below is one kind of artifact we hold for PayPal. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 37
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
PayPal Activate API
The Activate API from PayPal — 2 operation(s) for activate.
PayPal Authorizations API
Use the `/authorizations` resource to show details for, capture payment for, reauthorize, and void authorized payments.
PayPal Balances API
Use the `/balances` resource to list balances.
PayPal Billing API
The Billing API from PayPal — 13 operation(s) for billing.
PayPal Cancel API
The Cancel API from PayPal — 1 operation(s) for cancel.
PayPal Capture API
The Capture API from PayPal — 1 operation(s) for capture.
PayPal Captures API
Use the `/captures` resource to show details for and refund a captured payment.
PayPal Deactivate API
The Deactivate API from PayPal — 1 operation(s) for deactivate.
PayPal Disputes-Actions API
Use the `/disputes` resource with a dispute ID and an action to:
- Accept a claim.
- Accept an offer to resolve a dispute.
- Acknowledge the return of an item r...
PayPal Disputes API
Use the `/disputes` resource to list disputes, create disputes, show dispute details, and partially a dispute. Normally, an agent at PayPal creates disputes but now you can run ...
PayPal Invoices API
Use the `/invoices` resource to create, update, and send invoices and invoice reminders. To manage invoices, you can also list invoices, show details for invoices, delete draft ...
PayPal Orders API
Use the `/orders` resource to create, update, retrieve, authorize, capture and track orders.
PayPal Partner-Referrals API
Enables you to create and get information about shared customer data.
PayPal Payment-Tokens API
Use the `/vault/payment-tokens` resource to create, retrieve, and delete a payment token that may optionally be associated with a customer.
PayPal Payouts API
Use the `/payouts` resource to create a batch payout, update the status for a batch payout, show the status of a batch payout with the transaction status and other data for indi...
PayPal Payouts-Item API
Use the `/payouts-item` resource to show payout item details and cancel an unclaimed payout item.
PayPal Plans API
The Plans API from PayPal — 5 operation(s) for plans.
PayPal Pricing API
The Pricing API from PayPal — 1 operation(s) for pricing.
PayPal Products API
Use `/products` resource to create and manage products.
PayPal Refunds API
Use the `/refunds` resource to show refund details.
PayPal Revise API
The Revise API from PayPal — 1 operation(s) for revise.
PayPal Schemes API
The Schemes API from PayPal — 1 operation(s) for schemes.
PayPal Search-Invoices API
Use the `/search-invoices` resource to search for and list invoices that match search criteria.
PayPal Setup-Tokens API
Use the `/vault/setup-tokens` resource to create and retrieve temporary vault payment methods.
PayPal Simulate-Event API
Use the `/simulate-event` resource to use a sample payload to simulate a webhook event. The events that this call generates only serve to validate the connection to the listener...
PayPal Subscriptions API
The Subscriptions API from PayPal — 8 operation(s) for subscriptions.
PayPal Suspend API
The Suspend API from PayPal — 1 operation(s) for suspend.
PayPal Templates API
Use the `/templates` resource to create, list, show details for, update, and delete invoice templates. Use the `/templates` resource when you create a third-party invoicing appl...
PayPal Trackers API
Use the `/trackers` resource to update and retrieve tracking information for PayPal orders.
PayPal Trackers-Batch API
Use the `/trackers-batch` resource to add tracking information for multiple PayPal transactions.
PayPal Transactions API
The Transactions API from PayPal — 2 operation(s) for transactions.
PayPal Verify-Webhook-Signature API
Use the `/verify-webhook-signature` resource to verify a webhook signature.
PayPal Web-Profiles API
Use the `/payment-experience/web-profiles` resource to create, show details for, list, update, partially update, and delete web experience profiles.
PayPal Webhooks API
Use the `/webhooks` resource to subscribe your webhook listener to events, list webhooks for an app, show details for, update, delete, and list event subscriptions for webhooks.
PayPal Webhooks-Event-Types API
Use the `/webhooks-event-types` resource to list available events to which any webhook can subscribe.
PayPal Webhooks-Events API
Use the `/webhooks-events` resource to list, show details for, and resend event notifications.
PayPal Webhooks-Lookup API
Use the `/webhooks-lookup` resource to create, list, show details for, and delete webhook lookups.
Scroll within the panel for all 37 ·
GraphQL 1
Where a provider ships GraphQL, the schema is the contract. We profile it alongside the REST surface so the whole interface is legible in one place.
GraphQL schemas published by this provider.
PayPal GraphQL Schema
This conceptual GraphQL schema represents the PayPal payments platform surface, covering REST APIs for Orders, Payments, Payouts, Subscriptions, Invoicing, Reporting, Disputes, ...
GRAPHQLPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Paypal Plans Pricing
PLANSRate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Paypal Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Paypal Finops
FINOPSFeatures 16
The notable capabilities this provider advertises, captured as structured features so they can be searched and compared instead of read one landing page at a time.
Notable capabilities this provider offers.
Scroll within the panel for all 16 ·
Spectral Rules 1
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
PayPal API Rules
SPECTRALJSON Schema 576
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
Accepted Response
JSON SCHEMA3ds_result
JSON SCHEMA400
JSON SCHEMA401
JSON SCHEMA403
JSON SCHEMA404
JSON SCHEMA409
JSON SCHEMA422
JSON SCHEMAAccept Claim Response Options
JSON SCHEMAAccept Claim Type
JSON SCHEMAAccept Offer Request
JSON SCHEMAaccount_id-2
JSON SCHEMAPayPal Account Identifier
JSON SCHEMAAccount
JSON SCHEMAACH Debit Response
JSON SCHEMAach_debit_response
JSON SCHEMAach_debit_verification_status
JSON SCHEMAAcknowledge Return Item Response Options
JSON SCHEMAAllowed Acknowledgement Type
JSON SCHEMAEvidence Extensions
JSON SCHEMATransaction Date and Time Stamps
JSON SCHEMAaddress_entity
JSON SCHEMAPortable Postal Address (Medium-Grained)
JSON SCHEMAPortable Postal Address (Medium-Grained)
JSON SCHEMASimple Postal Address (Coarse-Grained)
JSON SCHEMASettle Request
JSON SCHEMAadjudication_reason
JSON SCHEMAAdjudication
JSON SCHEMAadjudication_type
JSON SCHEMAAggregated Discount
JSON SCHEMAAgreed Refund Details
JSON SCHEMAAllowed Response Options
JSON SCHEMAAlternate Notification Method
JSON SCHEMAaltpay_recurring_attributes_request
JSON SCHEMAaltpay_recurring_attributes
JSON SCHEMAAmount Breakdown
JSON SCHEMAAmount Range
JSON SCHEMAInvoice Amount Summary
JSON SCHEMAAmount with Breakdown
JSON SCHEMAapple_pay_attributes
JSON SCHEMAApple Pay Card
JSON SCHEMADecrypted Apple Pay Token data.
JSON SCHEMADecrypted Apple Pay Payment details data.
JSON SCHEMAApple Pay Response
JSON SCHEMAApplePay payment request object
JSON SCHEMAApplication Context
JSON SCHEMAAuction Information
JSON SCHEMAauthentication_flow
JSON SCHEMAAuthentication Response
JSON SCHEMAAuthorization
JSON SCHEMAAuthorization
JSON SCHEMAAuhorization Status Details
JSON SCHEMAAuthorization Status
JSON SCHEMAAuthorization with Additional Data
JSON SCHEMAauthorizations.reauthorize-400
JSON SCHEMAauthorizations.reauthorize-422
JSON SCHEMAauthorizations.void-422
JSON SCHEMABalance Information
JSON SCHEMABalances Response
JSON SCHEMABancontact payment object
JSON SCHEMABancontact payment object
JSON SCHEMABank Response
JSON SCHEMABank Account
JSON SCHEMABatch status
JSON SCHEMABatch Tracker Collection
JSON SCHEMABeneficial_owners
JSON SCHEMABIC
JSON SCHEMAbilling_agreement_id
JSON SCHEMABilling Agreement
JSON SCHEMABilling Cycle Override
JSON SCHEMABilling Cycle
JSON SCHEMABilling Disputes Properties
JSON SCHEMABilling Experience Preference
JSON SCHEMABilling Information
JSON SCHEMABin Details
JSON SCHEMABirth details
JSON SCHEMABLIK Experience Context
JSON SCHEMABLIK one-click payment object
JSON SCHEMABLIK one-click payment object
JSON SCHEMABLIK payment object
JSON SCHEMABLIK payment object
JSON SCHEMABLIK level_0 payment object
JSON SCHEMABusiness_address_detail
JSON SCHEMABusiness address type
JSON SCHEMABusiness_beneficial_owner
JSON SCHEMABusiness document
JSON SCHEMADocument type
JSON SCHEMABusiness_entity
JSON SCHEMABusiness_incorporation
JSON SCHEMABusiness industry
JSON SCHEMABusiness name
JSON SCHEMABusiness Name
JSON SCHEMAThe business name type.
JSON SCHEMAPhone details
JSON SCHEMAPhone type
JSON SCHEMAbusiness
JSON SCHEMAThe business sub type.
JSON SCHEMABusiness type information
JSON SCHEMABusiness type
JSON SCHEMAbuyer_escalation_reason
JSON SCHEMACustomer
JSON SCHEMACanceled Recurring Billing
JSON SCHEMACancellation Details
JSON SCHEMACapability
JSON SCHEMACapture
JSON SCHEMACapture Request
JSON SCHEMACapture
JSON SCHEMACapture Status Details
JSON SCHEMACapture Status
JSON SCHEMAcaptures.refund-400
JSON SCHEMAcaptures.refund-422
JSON SCHEMACard Attributes Response
JSON SCHEMACard Attributes
JSON SCHEMACard Brand
JSON SCHEMACard Experience Context
JSON SCHEMAResponse of Card from Request
JSON SCHEMACard Request
JSON SCHEMACard Response
JSON SCHEMACard Response with billing address and name
JSON SCHEMACard
JSON SCHEMACard Stored Credential
JSON SCHEMACard Supplementary Data
JSON SCHEMACard Type
JSON SCHEMACard Verification Details
JSON SCHEMACard Verification Method
JSON SCHEMACard Verification Status
JSON SCHEMACarrier
JSON SCHEMACart Information
JSON SCHEMACheckout Option
JSON SCHEMACheckout Payment Intent
JSON SCHEMACLASSIC API integration
JSON SCHEMAcobranded card object
JSON SCHEMAContact Details
JSON SCHEMAConfiguration
JSON SCHEMAConfirm Order Request
JSON SCHEMAContact Information
JSON SCHEMAcountry_code-2
JSON SCHEMAcountry_code
JSON SCHEMACreate Payout Request
JSON SCHEMACreate Referral Data Response
JSON SCHEMACredit Not Processed
JSON SCHEMAcryptocurrency_quantity
JSON SCHEMACryptocurrency
JSON SCHEMAcryptocurrency_symbol
JSON SCHEMAcurrency_code-2
JSON SCHEMAcurrency_code
JSON SCHEMACurrency Range
JSON SCHEMACurrency
JSON SCHEMACustom Amount
JSON SCHEMAVault of a customer
JSON SCHEMABilling Cycle Execution Details
JSON SCHEMAdate_no_time
JSON SCHEMADate Range
JSON SCHEMADate and Time Range
JSON SCHEMAdate_time
JSON SCHEMAdate_year_month
JSON SCHEMADeny Offer Request
JSON SCHEMAdependent_process
JSON SCHEMAInvoice_Detail
JSON SCHEMADisbursement Mode
JSON SCHEMADiscount
JSON SCHEMAdispute_channel
JSON SCHEMADispute Summary Information
JSON SCHEMAdispute_lifecycle_stage
JSON SCHEMADispute Outcome
JSON SCHEMADispute Reason
JSON SCHEMADispute Details
JSON SCHEMADispute Search Response
JSON SCHEMADispute State
JSON SCHEMADocument
JSON SCHEMADuplicate Transaction
JSON SCHEMAeci_flag
JSON SCHEMAemail_address
JSON SCHEMAenrolled
JSON SCHEMAAn eps payment object
JSON SCHEMAAn eps payment object
JSON SCHEMABad Request Error
JSON SCHEMAUnauthorized Error
JSON SCHEMANot Authorized Error
JSON SCHEMANot found Error
JSON SCHEMAResource Conflict Error
JSON SCHEMAUnsupported Media Type Error
JSON SCHEMAUnprocessable Entity Error
JSON SCHEMAInternal Server Error
JSON SCHEMAService Unavailable Error
JSON SCHEMAerror_default
JSON SCHEMAError Details
JSON SCHEMAError Details
JSON SCHEMALink Description
JSON SCHEMAerror_location
JSON SCHEMAError
JSON SCHEMAEscalate Claim Request
JSON SCHEMAEvent Resend
JSON SCHEMAEvent
JSON SCHEMAEvent Type
JSON SCHEMAEvent Version
JSON SCHEMAEvent List
JSON SCHEMAEvent Type List
JSON SCHEMAEvidence Information
JSON SCHEMAEvidence
JSON SCHEMAExchange Rate
JSON SCHEMAexemption_details
JSON SCHEMAExperience Context
JSON SCHEMAExperience Context
JSON SCHEMAExtensions
JSON SCHEMAFailed Payment Details
JSON SCHEMAFee Policy
JSON SCHEMAFile Reference
JSON SCHEMAFinancial instrument.
JSON SCHEMABilling Cycle Frequency
JSON SCHEMAfull_name
JSON SCHEMAFunding source
JSON SCHEMAA giropay payment object
JSON SCHEMAA giropay payment object
JSON SCHEMAgoogle_pay_request
JSON SCHEMAiban_last_chars
JSON SCHEMAThe iDEAL payment object
JSON SCHEMAThe iDEAL payment object
JSON SCHEMABank Account Identifier
JSON SCHEMAIncentive Details
JSON SCHEMAIncentive Information
JSON SCHEMAIncorrect Transaction Amount
JSON SCHEMAIndividual_beneficial_owner
JSON SCHEMAIndividual_owner
JSON SCHEMAIndividual owner role type
JSON SCHEMAinstrument_id
JSON SCHEMAIntegration Details
JSON SCHEMAInvoice Creation Flow
JSON SCHEMAInvoice Detail
JSON SCHEMAInvoice Number
JSON SCHEMAInvoice Payment Term
JSON SCHEMAInvoice
JSON SCHEMAInvoice Status
JSON SCHEMAInvoicer Information
JSON SCHEMAInvoices
JSON SCHEMAinvoices.cancel-400
JSON SCHEMAinvoices.cancel-422
JSON SCHEMAinvoices.create-400
JSON SCHEMAinvoices.generate-qr-code-400
JSON SCHEMAinvoices.payments-400
JSON SCHEMAinvoices.payments-422
JSON SCHEMAinvoices.payments-delete-422
JSON SCHEMAinvoices.refunds-400
JSON SCHEMAinvoices.refunds-422
JSON SCHEMAinvoices.remind-400
JSON SCHEMAinvoices.remind-422
JSON SCHEMAinvoices.search-invoices-400
JSON SCHEMAinvoices.update-400
JSON SCHEMAIP Address
JSON SCHEMAitem_agreed_refund_details
JSON SCHEMAitem_booking_details
JSON SCHEMAitem_cancellation_details
JSON SCHEMAItem Details
JSON SCHEMATax Amount
JSON SCHEMAitem_digital_download_details
JSON SCHEMAItem Information
JSON SCHEMAitem_product_details
JSON SCHEMAItem
JSON SCHEMAitem_service_details
JSON SCHEMAItem Type
JSON SCHEMAlanguage
JSON SCHEMALast Payment Details
JSON SCHEMALegal Consent
JSON SCHEMALevel 2 Card Processing Data
JSON SCHEMALevel 3 Card Processing Data
JSON SCHEMAliability_shift
JSON SCHEMALineitem
JSON SCHEMALink Description
JSON SCHEMALink Description
JSON SCHEMAMake Offer Response Options
JSON SCHEMAMake Offer Request
JSON SCHEMAMandate
JSON SCHEMAMerchandise Dispute Properties
JSON SCHEMAMerchant Contacted Method
JSON SCHEMAMerchant Contacted Outcome
JSON SCHEMAmerchant_partner_customer_id
JSON SCHEMAMessage
JSON SCHEMAMetadata
JSON SCHEMAMoney
JSON SCHEMAmoney_movement_reason
JSON SCHEMAMoney movement
JSON SCHEMAMoney
JSON SCHEMAMyBank payment object
JSON SCHEMAMyBank payment object
JSON SCHEMAName
JSON SCHEMAName
JSON SCHEMANet Amount Breakdown Item
JSON SCHEMANetwork Token
JSON SCHEMANetwork Transaction Reference
JSON SCHEMANotification
JSON SCHEMAOffer History
JSON SCHEMAOffer
JSON SCHEMAOffer Type
JSON SCHEMARole type
JSON SCHEMAOffice Bearers
JSON SCHEMAOperation
JSON SCHEMAApplication Context
JSON SCHEMAAuthorize Request
JSON SCHEMAOrder
JSON SCHEMAOrder Capture Request
JSON SCHEMAConfirm Application Context
JSON SCHEMAOrder Request
JSON SCHEMAOrder
JSON SCHEMAOrder Status
JSON SCHEMAOrder Tracker Request.
JSON SCHEMAorders.authorize-400
JSON SCHEMAorders.authorize-403
JSON SCHEMAorders.authorize-422
JSON SCHEMAorders.capture-400
JSON SCHEMAorders.capture-403
JSON SCHEMAorders.capture-422
JSON SCHEMAorders.confirm-400
JSON SCHEMAorders.confirm-422
JSON SCHEMAorders.patch-400
JSON SCHEMAorders.patch-422
JSON SCHEMAorders.track.create-400
JSON SCHEMAorders.track.create-403
JSON SCHEMAorders.track.create-422
JSON SCHEMAorders.trackers.patch-400
JSON SCHEMAorders.trackers.patch-403
JSON SCHEMAorders.trackers.patch-404
JSON SCHEMAorders.trackers.patch-422
JSON SCHEMAordinal
JSON SCHEMAP24 payment object
JSON SCHEMAP24 payment object
JSON SCHEMApares_status
JSON SCHEMAPartial Payment
JSON SCHEMAPartner Configuration Override
JSON SCHEMAPatch Request
JSON SCHEMAPatch
JSON SCHEMAMerchant Base
JSON SCHEMApayee_payment_method_preference
JSON SCHEMAPayee
JSON SCHEMAPayer Base
JSON SCHEMAPayer Information
JSON SCHEMACustomer
JSON SCHEMAPayment by Other Means
JSON SCHEMAPayment Collection
JSON SCHEMAPayment Detail
JSON SCHEMApayment_initiator
JSON SCHEMAPayment Instruction
JSON SCHEMAPayment Instruction
JSON SCHEMAPayment Method
JSON SCHEMAPayment Preferences Override
JSON SCHEMAPayment Preferences
JSON SCHEMApayment_processor
JSON SCHEMAPayment Reference
JSON SCHEMAPayment Source Response
JSON SCHEMAPayment Source
JSON SCHEMAPayment Term
JSON SCHEMAPayment Term Type
JSON SCHEMAPayment Token Request
JSON SCHEMAPayment Token Response
JSON SCHEMAPayment Token Status
JSON SCHEMAPayment Type
JSON SCHEMAPayments
JSON SCHEMAPayout Attributes
JSON SCHEMAPayout Batch Header
JSON SCHEMAPayout Item
JSON SCHEMAPayout Batch
JSON SCHEMACurrency conversion resource
JSON SCHEMAPayout Header
JSON SCHEMAPayout Item
JSON SCHEMAPayout Item Detail
JSON SCHEMAPayout Item
JSON SCHEMACreate Payout Response
JSON SCHEMAPayout Sender Batch Header
JSON SCHEMAPayPal Wallet Attributes Response
JSON SCHEMAPayPal Wallet Attributes
JSON SCHEMAPayPal Wallet Experience Context
JSON SCHEMAPayPal Wallet Request
JSON SCHEMAPayPal Wallet Response
JSON SCHEMAPayPal Wallet
JSON SCHEMASaved PayPal Wallet Payment Source Response
JSON SCHEMApercentage
JSON SCHEMAPerson address detail
JSON SCHEMAPerson address type
JSON SCHEMAPerson document
JSON SCHEMADocument type
JSON SCHEMAPerson name
JSON SCHEMAPerson name type
JSON SCHEMAPhone details
JSON SCHEMAPerson
JSON SCHEMAPhone
JSON SCHEMAPhone Detail
JSON SCHEMAPhone number tag
JSON SCHEMAPhone
JSON SCHEMAPhone Type
JSON SCHEMAPhone Type
JSON SCHEMAPhone With Type
JSON SCHEMAPlan Collection
JSON SCHEMAPlan Override
JSON SCHEMACreate Plan Request
JSON SCHEMAPlan
JSON SCHEMAplans.activate-422
JSON SCHEMAplans.create-400
JSON SCHEMAplans.deactivate-422
JSON SCHEMAplans.patch-400
JSON SCHEMAplans.patch-422
JSON SCHEMAplans.update-pricing-schemes-400
JSON SCHEMAplans.update-pricing-schemes-422
JSON SCHEMAPlatform Fee
JSON SCHEMAPricing Scheme
JSON SCHEMAPricing Tier
JSON SCHEMAProcessing Instruction
JSON SCHEMAProcessor Response
JSON SCHEMAProduct Category
JSON SCHEMAProduct Element
JSON SCHEMAProduct Collection
JSON SCHEMAProduct Details
JSON SCHEMACreate Product Request
JSON SCHEMAProduct Details
JSON SCHEMAproducts.create-400
JSON SCHEMAproducts.patch-400
JSON SCHEMAproducts.patch-422
JSON SCHEMAPurchase Unit Request
JSON SCHEMAPurchase Unit
JSON SCHEMAPurpose Code
JSON SCHEMAPurpose
JSON SCHEMAQR Configuration
JSON SCHEMAReauthorize Request
JSON SCHEMARecipient type
JSON SCHEMARecipient Information
JSON SCHEMARecipient wallet
JSON SCHEMAReferral Data Response
JSON SCHEMACustomer Data
JSON SCHEMARefund Detail
JSON SCHEMARefund Details
JSON SCHEMARefund Payment Reference
JSON SCHEMARefund Request
JSON SCHEMARefund
JSON SCHEMARefund Status Details
JSON SCHEMARefund Status
JSON SCHEMARefunds
JSON SCHEMARelated Identifiers
JSON SCHEMARequire Evidence Request
JSON SCHEMAResource Version
JSON SCHEMAREST API Integration
JSON SCHEMAREST Endpoint Features
JSON SCHEMAReturn Details
JSON SCHEMASearch Data
JSON SCHEMASearch Response
JSON SCHEMASeller Protection
JSON SCHEMASeller Receivable Breakdown
JSON SCHEMAMerchant
JSON SCHEMASender Batch Header
JSON SCHEMAService Details
JSON SCHEMASetup Token
JSON SCHEMAMinimal Setup Token
JSON SCHEMACarrier.
JSON SCHEMAShipment Tracker.
JSON SCHEMAShipment Tracking Number Type.
JSON SCHEMAShipment Tracking Status.
JSON SCHEMAShipping Cost
JSON SCHEMAShipping Details
JSON SCHEMAShipping Information
JSON SCHEMAShipping Option
JSON SCHEMAShipping Type
JSON SCHEMAOrder Shipping Details
JSON SCHEMASimulate Event
JSON SCHEMASofort payment object
JSON SCHEMASofort payment object
JSON SCHEMAstatus
JSON SCHEMAstore_in_vault_instruction
JSON SCHEMAStore Information
JSON SCHEMAstored_payment_source_payment_type
JSON SCHEMAStored Payment Source
JSON SCHEMAstored_payment_source_usage_type
JSON SCHEMASubscriber Request Information
JSON SCHEMASubscriber Response Information
JSON SCHEMAActivate Subscription Request
JSON SCHEMASubscription Billing Information
JSON SCHEMACancel Subscription Request
JSON SCHEMACharge Amount from Subscriber
JSON SCHEMACreate Subscription Request
JSON SCHEMASubscription Modify Plan Request
JSON SCHEMASubscription
JSON SCHEMASubscription Status
JSON SCHEMASuspend Subscription
JSON SCHEMAsubscriptions.activate-400
JSON SCHEMAsubscriptions.activate-422
JSON SCHEMAsubscriptions.cancel-400
JSON SCHEMAsubscriptions.cancel-422
JSON SCHEMAsubscriptions.capture-400
JSON SCHEMAsubscriptions.capture-422
JSON SCHEMAsubscriptions.create-400
JSON SCHEMAsubscriptions.create-422
JSON SCHEMAsubscriptions.patch-400
JSON SCHEMAsubscriptions.patch-422
JSON SCHEMAsubscriptions.revise-400
JSON SCHEMAsubscriptions.revise-404
JSON SCHEMAsubscriptions.revise-422
JSON SCHEMAsubscriptions.suspend-400
JSON SCHEMAsubscriptions.suspend-422
JSON SCHEMAsubscriptions.transactions-400
JSON SCHEMASubsequent Action
JSON SCHEMASupplementary Data
JSON SCHEMACapture Identifier
JSON SCHEMASupporting Info
JSON SCHEMATax Information
JSON SCHEMATax
JSON SCHEMATaxes Override
JSON SCHEMATaxes
JSON SCHEMATemplate Configuration
JSON SCHEMATemplate Detail
JSON SCHEMATemplate Display Preference
JSON SCHEMATemplate Information
JSON SCHEMATemplate Item Field
JSON SCHEMATemplate Item Setting
JSON SCHEMATemplate Metadata
JSON SCHEMATemplate
JSON SCHEMATemplate Settings
JSON SCHEMATemplate Subtotal Field
JSON SCHEMATemplate Subtotal Setting
JSON SCHEMATemplates
JSON SCHEMAtemplates.create-400
JSON SCHEMAtemplates.create-422
JSON SCHEMAtemplates.delete-403
JSON SCHEMAtemplates.get-403
JSON SCHEMAtemplates.update-400
JSON SCHEMAtemplates.update-422
JSON SCHEMAThe 3D Secure Authentication Response
JSON SCHEMAtoken_attributes
JSON SCHEMAToken Request
JSON SCHEMAToken
JSON SCHEMATracker Collection
JSON SCHEMATracker Identifier Collection
JSON SCHEMATracking Identifier
JSON SCHEMATracker Item
JSON SCHEMAOrder Tracker Response.
JSON SCHEMAtracker_status
JSON SCHEMATracking Information
JSON SCHEMATracking Number Type
JSON SCHEMATracking Status
JSON SCHEMATransaction Details
JSON SCHEMATransaction status
JSON SCHEMATransaction Information
JSON SCHEMATransaction Details
JSON SCHEMAList Transactions
JSON SCHEMATrustly payment object
JSON SCHEMATrustly payment object
JSON SCHEMAunit_of_measure
JSON SCHEMAuniversal_product_code
JSON SCHEMAUpdate Pricing Scheme
JSON SCHEMAUpdate Pricing Scheme Request
JSON SCHEMAurl
JSON SCHEMABase Vault Instruction Parameters
JSON SCHEMAvault_id
JSON SCHEMABase vault Instruction parameters
JSON SCHEMAVault Instruction
JSON SCHEMAvault_owner_id
JSON SCHEMAVaulted PayPal Wallet Common Attributes
JSON SCHEMASaved Payment Source Response
JSON SCHEMAVaulted Venmo Wallet Common Attributes
JSON SCHEMAVenmo Request
JSON SCHEMAVenmo Response
JSON SCHEMAVenmo Wallet Attributes Response
JSON SCHEMAVenmo Wallet Attributes
JSON SCHEMAVenmo Wallet Experience Context
JSON SCHEMAVenmo payment request object
JSON SCHEMAVenmo Wallet Response Object
JSON SCHEMAVerify Webhook Signature Response
JSON SCHEMAVerify Webhook Signature
JSON SCHEMAVaulted Digital Wallet Common Attributes
JSON SCHEMAWeb Profile List
JSON SCHEMAWeb Profile
JSON SCHEMAWebhook
JSON SCHEMAWebhook List
JSON SCHEMAWebhook Lookup List
JSON SCHEMAWebhook Lookup
JSON SCHEMAScroll within the panel for all 576 ·
JSON Structure 1
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Paypal Structure
JSON STRUCTUREExamples 31
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Paypal Ordersconfirm Example
EXAMPLEPaypal Orderscreate Example
EXAMPLEPaypal Payoutspost Example
EXAMPLEPaypal Planscreate Example
EXAMPLEPaypal Productspatch Example
EXAMPLEPaypal Webhookspost Example
EXAMPLEScroll within the panel for all 31 ·
Security Posture 4
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Scopes 1
OAuth scopes are the vocabulary of least-privilege access. Profiling them shows exactly what an integration — or an agent acting on a user's behalf — is allowed to do.
OAuth scopes governing access to this provider's APIs.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for PayPal — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 2
Portal, sign-up, and the first successful call
Documentation 1
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 3
Pagination, idempotency, versioning, errors, and events
Build 2
SDKs, sample code, and the tooling you integrate with
Access & Security 6
Authentication, authorization, and security posture
Operate 2
Status, limits, changes, and where to get help
Commercial 3
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/paypal · machine-readable index on apis.io