Official vendor OpenAPI document · agent-readyPaymentsBilling Subscriptionsoauth215 EndpointsREST
For Agents
Programmatically list disputes, show dispute details. Covers 15 operations with oauth2 authentication.
Use for: I need to disputes, I want to show dispute details, Search for partially update dispute, Find all provide evidence
Not supported: Does not handle communications, crm, or developer tools - use for payments only.
Occasionally, something goes wrong with a customer's order. To dispute a charge, a customer can create a dispute with PayPal. PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage customer disputes.<blockquote><strong>Note:</strong> In the live environment, merchants cannot create disputes but can only respond to customer-created disputes. However, merchants. The API exposes 15 endpoints secured with oauth2 authentication.
Install Jentic One Beta
Connect the Disputes to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Disputes, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpaypal.com%2Fdisputes" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpaypal.com%2Fdisputes" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Disputes API.
List disputes
Show dispute details
Partially update dispute
Provide evidence
Appeal dispute
Accept claim
Settle dispute
Use Cases
Patterns agents use Disputes API for, with concrete tasks.
★ Payments Operations
Use the Disputes to perform payments operations programmatically. The API provides 15 endpoints covering core functionality including list disputes, show dispute details, partially update dispute.
Call GET /v1/customer/disputes to list disputes
Automated disputes Management
Automate disputes operations by combining multiple Disputes endpoints. Agents can show dispute details and then partially update dispute in a single workflow.
Call GET /v1/customer/disputes/{id} to show dispute details, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Disputes endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.
Search Jentic for 'list disputes', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
15 endpoints — occasionally, something goes wrong with a customer's order.
METHOD
PATH
DESCRIPTION
GET
/v1/customer/disputes
List disputes
GET
/v1/customer/disputes/{id}
Show dispute details
PATCH
/v1/customer/disputes/{id}
Partially update dispute
POST
/v1/customer/disputes/{id}/provide-evidence
Provide evidence
POST
/v1/customer/disputes/{id}/appeal
Appeal dispute
POST
/v1/customer/disputes/{id}/accept-claim
Accept claim
POST
/v1/customer/disputes/{id}/adjudicate
Settle dispute
POST
/v1/customer/disputes/{id}/require-evidence
Update dispute status
GET
/v1/customer/disputes
List disputes
GET
/v1/customer/disputes/{id}
Show dispute details
PATCH
/v1/customer/disputes/{id}
Partially update dispute
POST
/v1/customer/disputes/{id}/provide-evidence
Provide evidence
POST
/v1/customer/disputes/{id}/appeal
Appeal dispute
POST
/v1/customer/disputes/{id}/accept-claim
Accept claim
POST
/v1/customer/disputes/{id}/adjudicate
Settle dispute
POST
/v1/customer/disputes/{id}/require-evidence
Update dispute status
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
D
Disputes
- Foundational (C)57/100
61
Foundational Compliance64
Developer Experience & Jentic Compatibility31
AI-Readiness & Agent Experience94
Agent Usability85
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
61
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: B-Signals: 4
69%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
64
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
2%
Example Density
How richly the API is illustrated with examples.
62%
Example Validity
Percentage of examples that conform to their schemas.
92%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
31
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
82%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
43%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
85
Security
Trust, risk posture, and security compliance.
Grade: ASignals: 1
85%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring PayPal Disputes by hand means running its OAuth 2.0 flow, refreshing Bearer tokens, and choosing the right sandbox or live host before you can list disputes or provide evidence. Through Jentic you install once, import Disputes from the API Directory, store the client credentials once, and your agent calls it.
Permission scoping
Disputes puts the dispute id in the URL path (/v1/customer/disputes/{id}), so a rule can pin your agent to reading one dispute. You choose the operations it may call, so accepting a claim, adjudicating, or appealing is not included unless you add them.
Credential isolation
Your PayPal OAuth client id and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time, with token refresh handled for you. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list disputes' or 'provide evidence for a dispute', and Jentic returns the matching Disputes operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Alternative payments API
Choose Stripe when you need a different approach to payments operations
FAQs
Specific to using Disputes API through Jentic.
What authentication does the Disputes use?
The Disputes uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I list disputes with the Disputes?
Yes. Use the GET /v1/customer/disputes endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Disputes?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I list disputes through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list disputes'. Jentic returns the matching Disputes operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Disputes have?
The Disputes exposes 15 endpoints covering disputes, disputes-actions, referred-disputes operations.
Can I limit what my agent is allowed to do with the PayPal Disputes API?
Yes. Jentic One is self-hosted by you, so your own rules decide which Disputes operations and credentials the agent may use. Because the dispute id sits in the URL path (/v1/customer/disputes/{id}), you can pin the agent to reading a single dispute, or allow only read operations like listing disputes and showing dispute details. Higher-impact actions such as accepting a claim, adjudicating, or appealing are not included unless you explicitly add them.
GET STARTED