How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 related to a dispute.Settle a dispute.Appeal a dispute.Cancel a dispute.Change the reason for a dispute.Deny an offer to resolve dispute.Escalate a dispute to a claim.Make an offer to resolve a dispute.Make an offer to resolve a dispute.Provide evidence for a dispute.Provide supporting information for dispute.In the sandbox, update the dispute status.Send a message about a dispute to the other party in the dispute.

PayPal Disputes-Actions API is one of 37 APIs that PayPal publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Disputes-Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 12 operations across 12 paths, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version 1.6.

Requests are made against 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com.

12 operations 12 paths 16 schemas 12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.6
Servers
https://api-m.sandbox.paypal.com
https://api-m.paypal.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

PayPal Disputes-Actions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Oauth2) using the clientCredentials flow, exposing 1 scope.

  • Oauth2 — Oauth 2.0 authentication

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 12 POST. Each is listed below with its method, path, parameters, and response codes.

Disputes-Actions 12

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 related to a dispute. Settle…

POST
/v1/customer/disputes/{id}/provide-evidence
Paypal Provide evidence
disputes.provide-evidence 1 param body → 200400default
POST
/v1/customer/disputes/{id}/appeal
Paypal Appeal dispute
disputes.appeal 1 param body → 200400default
POST
/v1/customer/disputes/{id}/accept-claim
Paypal Accept claim
disputes.accept-claim 1 param body → 200400default
POST
/v1/customer/disputes/{id}/adjudicate
Paypal Settle dispute
disputes.adjudicate 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/require-evidence
Paypal Update dispute status
disputes.require-evidence 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/escalate
Paypal Escalate dispute to claim
disputes.escalate 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/send-message
Paypal Send message about dispute to other party
disputes.send-message 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/make-offer
Paypal Make offer to resolve dispute
disputes.make-offer 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/accept-offer
Paypal Accept offer to resolve dispute
disputes.accept-offer 1 param body → 200202400422500default
POST
/v1/customer/disputes/{id}/deny-offer
Paypal Deny offer to resolve dispute
disputes.deny-offer 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/acknowledge-return-item
Paypal Acknowledge returned item
disputes.acknowledge-return-item 1 param body → 200400422500default
POST
/v1/customer/disputes/{id}/provide-supporting-info
Paypal Provide supporting information for dispute
disputes.provide-supporting-info 1 param body → 200400404422500default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are address_portable (10 properties), error (6 properties), make_offer (5 properties), error_details-2 (5 properties). Each schema is shown below with its type and property counts.

offer_type
string
The merchant-proposed offer type for the dispute.
accept_offer
object
A customer request to accept the offer made by the merchant.
1 property
buyer_escalation_reason
escalate
object
A merchant request to escalate a dispute, by ID, to a PayPal claim.
2 properties 1 required
address_portable
object
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) an…
10 properties 1 required
country_code
string
The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region. Note: The country code for Great Britain is GB a…
adjudicate
object
A request to settle a dispute in either the customer's or merchant's favor.
1 property 1 required
error
object
The error details.
6 properties 3 required
make_offer
object
A merchant request to make an offer to resolve a dispute.
5 properties 2 required
subsequent_action
object
The subsequent action.
1 property
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties 2 required
require_evidence
object
Sandbox only. Updates the state of a dispute, by ID, to either WAITINGFORBUYERRESPONSE or WAITINGFORSELLERRESPONSE . This state change enables either the custo…
1 property 1 required
currency_code
string
The [three-character ISO-4217 currency code](/docs/api/reference/currency-codes/) that identifies the currency.
deny_offer
object
A customer request to deny the offer made by the merchant.
1 property 1 required
money
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties 2 required
error_details-2
object
The error details. Required for client-side 4XX errors.
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-disputes-actions-api-openapi.yml Raw ↑

Other APIs PayPal publishes across the network.

PayPal Activate API
PayPal Authorizations API
PayPal Balances API
PayPal Billing API
PayPal Cancel API
PayPal Capture API
PayPal Captures API
PayPal Deactivate API
PayPal Disputes API
PayPal Invoices API
PayPal Orders API
PayPal Partner-Referrals API
Where this information came from

This is an independent, third-party profile of PayPal Disputes-Actions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.