On this page
No Headings
An array of disputes. Includes links that enable you to navigate through the response.
objectitemsarrayAn array of disputes that match the filter criteria. Sorted in latest to earliest creation time order.
itemsobjectThe dispute summary information.
dispute_idstring^[A-Za-z0-9-]+$The ID of the dispute.
create_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the dispute was created, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
update_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the dispute was last updated, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
reasonstring"MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED", "UNAUTHORISED", "CREDIT_NOT_PROCESSED", "DUPLICATE_TRANSACTION", "INCORRECT_AMOUNT", "PAYMENT_BY_OTHER_MEANS", "CANCELED_RECURRING_BILLING", "PROBLEM_WITH_REMITTANCE", "OTHER"^[0-9A-Z_]+$The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons.
statusstring"OPEN", "WAITING_FOR_BUYER_RESPONSE", "WAITING_FOR_SELLER_RESPONSE", "UNDER_REVIEW", "RESOLVED", "OTHER"^[0-9A-Z_]+$The overall status of the dispute, constant for all the parties involved at anytime during the dispute lifecycle.
dispute_statestring"OPEN_INQUIRIES", "REQUIRED_ACTION", "REQUIRED_OTHER_PARTY_ACTION", "UNDER_PAYPAL_REVIEW", "APPEALABLE", "RESOLVED"^[0-9A-Z_]+$The user specific state of the dispute, could vary between parties during the dispute lifecycle.
dispute_amountobjectThe amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or net amount of the original transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.dispute_assetobjectThe asset in the transaction that the customer disputed.
asset_symbolrequiredstring"BTC", "ETH", "BCH", "LTC", "PYUSD", "LINK", "SOL", "MATIC"^[0-9A-Za-z]{1,10}$The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
quantityrequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The quantity of a cryptocurrency asset. This is a decimal number with a scale defined for each cryptocurrency by its founders. For example, Bitcoin (BTC) has 8 as its scale, Ethereum (ETH) has 18 as its scale. The PayPal Cryptocurrency platform handles the scale to 8 digits for Bitcoin. including its forks or offshoots, as well as Ethereum.
quantity_in_subunitsstring^-?[0-9]+$The quantity of a cryptocurrency asset in the currency's sub units.
Amount is an integer in a string format.
Floating point should be avoided to avoid precision errors. For example:
decimalsintegerThe number of decimal digits supported by this cryptocurrency. For example, for Bitcoin this value is 8 because there are 10^8 satoshis in one Bitcoin and for Ethereum it's 18 since there are 10^18 wei in one Ether.
dispute_life_cycle_stagestring"INQUIRY", "CHARGEBACK", "PRE_ARBITRATION", "ARBITRATION"^[0-9A-Z_]+$The stage in the dispute lifecycle.
dispute_channelstring"INTERNAL", "EXTERNAL", "ALERT"^[A-Z0-9_]+$The channel where the customer created the dispute.
buyer_response_due_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time by when the customer must respond to the dispute, in Internet date and time format. If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
seller_response_due_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time by when the merchant must respond to the dispute, in Internet date and time format. If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^[\S\s]*$The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstring^[\S\s]*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"^[\S\s]*$The HTTP method required to make the related call.
titlestring^[\S\s]*$The link title.
mediaTypestring^[\S\s]*$The media type, as defined by RFC 2046. Describes the link target.
encTypestring^[\S\s]*$"application/json"The media type in which to submit the request data.
schemaobjectThe schema that describes the request data.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
targetSchemaobjectThe schema that describes the link target.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^[\S\s]*$The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstring^[\S\s]*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"^[\S\s]*$The HTTP method required to make the related call.
titlestring^[\S\s]*$The link title.
mediaTypestring^[\S\s]*$The media type, as defined by RFC 2046. Describes the link target.
encTypestring^[\S\s]*$"application/json"The media type in which to submit the request data.
schemaobjectThe schema that describes the request data.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
targetSchemaobjectThe schema that describes the link target.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.