PayPal Disputes 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
3 operations
across 2 paths,
and defines 75 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.
The identity and technical contract details declared by the specification.
merchant_contacted_mode
string
The method used to contact the merchant.
dispute_reason
string
The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons…
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties
2 required
transaction_info
object
The information about the disputed transaction.
13 properties
offer
object
The merchant-proposed offer for a dispute.
4 properties
seller
object
The details for the merchant who receives the funds and fulfills the order. For example, merchant ID, and contact email address.
3 properties
item_info
object
The information for a purchased item in a disputed transaction.
15 properties
agreed_refund_details
object
Details of Agreed Refund between customer and merchant.
2 properties
dispute_lifecycle_stage
string
The stage in the dispute lifecycle.
cancellation_details
object
The cancellation details.
4 properties
subsequent_action
object
The subsequent action.
1 property
email_address
string
The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accep…
date_time
string
The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). Seconds are required while fractional seconds are option…
item_agreed_refund_details
adjudication_type
string
The type of adjudication.
credit_not_processed
object
The credit not processed details.
6 properties
message
object
A customer- or merchant-posted message for the dispute.
4 properties
item_digital_download_details
status
string
The overall status of the dispute, constant for all the parties involved at anytime during the dispute lifecycle.
canceled_recurring_billing
object
The recurring billing canceled details.
2 properties
supporting_info
object
A merchant- or customer-submitted supporting information.
5 properties
adjudication_reason
string
The reason for the adjudication type.
money_movement
object
The Money movement details with party.
6 properties
merchant_contacted_outcome
string
The outcome when the customer has contacted the merchant.
acknowledgement_type
string
The type of acknowledgement allowed for the merchant after the customer has returned the item. The merchant can update whether the item was received and is as…
tracking_info
object
The tracking information.
4 properties
2 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…
buyer
object
The details for the customer who funds the payment. For example, the customer's first name, last name, and email address.
1 property
return_details
object
The return details for the product.
5 properties
fee_policy
object
Policy that determines whether the fee needs to be charged, retained or returned while moving the money as part of dispute process.
item_type
string
The type of the item which has the issue.
evidence
object
A merchant- or customer-submitted evidence document. evidenceinfo is expected for PROOFOFFULFILLMENT,PROOFOFREFUND and PROOFOFRETURN evidence types. documents…
10 properties
item_cancellation_details
dispute
object
The dispute details.
26 properties
dispute_search
object
An array of disputes. Includes links that enable you to navigate through the response.
2 properties
offer_type
string
The merchant-proposed offer type for the dispute.
cryptocurrency_symbol
string
The Cryptocurrency ticker symbol / code as assigned by liquidity providers (exchanges).
dispute_channel
string
The channel where the customer created the dispute.
incorrect_transaction_amount
object
The incorrect transaction amount details.
3 properties
extensions
object
The extended properties for the dispute. Includes additional information for a dispute category, such as billing disputes, the original transaction ID, and the…
8 properties
merchandize_dispute_properties
object
The customer-provided merchandise issue details for the dispute.
5 properties
currency_code
string
The [three-character ISO-4217 currency code](/docs/api/reference/currency-codes/) that identifies the currency.
accept_claim_response_options
object
The allowed response options when the merchant is accepting the claim.
1 property
allowed_response_options
object
The allowed response options for the buyer/seller update actions.
3 properties
offer_history
object
The offer history.
7 properties
document
object
An uploaded document as a binary object that supports a dispute.
2 properties
refund_details
object
The refund details.
1 property
dispute_outcome
object
The outcome of a dispute.
3 properties
dispute_state
string
The user specific state of the dispute, could vary between parties during the dispute lifecycle.
money_movement_reason
string
The reason for the money movement.
cryptocurrency
object
Representation of a specific amount of Cryptocurrency, denoted by its symbol and quantity.
2 properties
2 required
communication_details
object
The contact details that a merchant provides to the customer to use to share their evidence documents.
3 properties
patch
object
The JSON patch object to apply partial updates to resources.
4 properties
1 required
cryptocurrency_quantity
string
Quantity of a cryptocurrency asset. This is a decimal number with scale defined for each Cryptocurrency by the founders. For example, Bitcoin(BTC) has 8 as sca…
accept_claim_type
string
The refund type proposed by the merchant for the dispute.
duplicate_transaction
object
The duplicate transaction details.
2 properties
evidence_info
object
The evidence-related information.
2 properties
patch_request
array
An array of JSON patch objects to apply partial updates to resources.
money
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties
2 required
acknowledge_return_item_response_options
object
The allowed response options when the seller acknowledges that the buyer has returned an item for the dispute.
1 property
address_portable
object
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) an…
10 properties
1 required
action_info
object
The extended properties for a evidence. Includes additional information such as the action for which the evidence was requested/submitted, and whether the evid…
3 properties
billing_disputes_properties
object
The billing issue details.
5 properties
error
object
The error details.
6 properties
3 required
payment_by_other_means
object
The payment by other means details.
4 properties
service_details
object
The service details.
5 properties
error_details-2
object
The error details. Required for client-side 4XX errors.
5 properties
1 required
make_offer_response_options
object
The allowed response options when the merchant makes offer to the customer.
1 property
dispute_info
object
The dispute summary information.
13 properties
adjudication
object
The Adjudication details for the dispute.
4 properties
2 required
product_details
object
The product information.
7 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PayPal publishes across the network.
