The date and time when the dispute was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

update_timestring<date_time>Optional

The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

reasonenum<dispute_reason>Optional

The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"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"

statusenum<status>Optional

The overall status of the dispute, constant for all the parties involved at anytime during the dispute lifecycle.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"OPEN"
"WAITING_FOR_BUYER_RESPONSE"
"WAITING_FOR_SELLER_RESPONSE"
"UNDER_REVIEW"
"RESOLVED"
"OTHER"

dispute_stateenum<dispute_state>Optional

The user specific state of the dispute, could vary between parties during the dispute lifecycle.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"OPEN_INQUIRIES"
"REQUIRED_ACTION"
"REQUIRED_OTHER_PARTY_ACTION"
"UNDER_PAYPAL_REVIEW"
"APPEALABLE"
"RESOLVED"

dispute_amountobject<money>Optional

The 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.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

dispute_assetobject<cryptocurrency>Optional

The asset in the transaction that the customer disputed.

cryptocurrency properties

4 properties

asset_symbolenum<cryptocurrency_symbol>Required

The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.

Match^[0-9A-Za-z]{1,10}$Length1 <= length <= 10

Allowed values

"BTC"
"ETH"
"BCH"
"LTC"
"PYUSD"
"LINK"
"SOL"
"MATIC"

quantitystring<cryptocurrency_quantity>Required

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.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length1 <= length <= 40

quantity_in_subunitsstring<cryptocurrency_subunits_quantity>Optional

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:

Bitcoin(BTC) has 8 decimals,

so 1 BTC will be represented as 100000000 (1 followed by 8 zeroes).

Ethereum(ETH) has 18 decimals,

so 1 ETH will be represented as 1000000000000000000 (1 followed by 18 zeroes).

Match^-?[0-9]+$Length1 <= length <= 81

decimalsinteger<cryptocurrency_decimals>Optional

The 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.

Range0 <= value <= 40

dispute_life_cycle_stageenum<dispute_lifecycle_stage>Optional

The stage in the dispute lifecycle.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"INQUIRY"
"CHARGEBACK"
"PRE_ARBITRATION"
"ARBITRATION"

dispute_channelenum<dispute_channel>Optional

The channel where the customer created the dispute.

Match^[A-Z0-9_]+$Length1 <= length <= 255

Allowed values

"INTERNAL"
"EXTERNAL"
"ALERT"

buyer_response_due_datestring<date_time>Optional

The date and time by when the customer must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

seller_response_due_datestring<date_time>Optional

The date and time by when the merchant must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Match^[\S\s]*$Length0 <= length <= 2147483647

Allowed values

"GET"
"POST"
"PUT"
"DELETE"
"HEAD"
"CONNECT"
"OPTIONS"
"PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestringOptional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestringOptional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The schema that describes the request data.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The schema that describes the link target.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Match^[\S\s]*$Length0 <= length <= 2147483647

Allowed values

"GET"
"POST"
"PUT"
"DELETE"
"HEAD"
"CONNECT"
"OPTIONS"
"PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestringOptional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestringOptional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The schema that describes the request data.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The schema that describes the link target.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

Back to top

Dispute Search Response

An array of disputes. Includes links that enable you to navigate through the response.

itemsobject<dispute_info>[]Optional

An array of disputes that match the filter criteria. Sorted in latest to earliest creation time order.

Items1 <= length <= 100

dispute_info properties

13 properties

dispute_idstringOptional

The ID of the dispute.

Match^[A-Za-z0-9-]+$Length1 <= length <= 255

create_timestring<date_time>Optional

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

update_timestring<date_time>Optional

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

reasonenum<dispute_reason>Optional

The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"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"

statusenum<status>Optional

The overall status of the dispute, constant for all the parties involved at anytime during the dispute lifecycle.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"OPEN"
"WAITING_FOR_BUYER_RESPONSE"
"WAITING_FOR_SELLER_RESPONSE"
"UNDER_REVIEW"
"RESOLVED"
"OTHER"

dispute_stateenum<dispute_state>Optional

The user specific state of the dispute, could vary between parties during the dispute lifecycle.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"OPEN_INQUIRIES"
"REQUIRED_ACTION"
"REQUIRED_OTHER_PARTY_ACTION"
"UNDER_PAYPAL_REVIEW"
"APPEALABLE"
"RESOLVED"

dispute_amountobject<money>Optional

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

dispute_assetobject<cryptocurrency>Optional

The asset in the transaction that the customer disputed.

cryptocurrency properties

4 properties

asset_symbolenum<cryptocurrency_symbol>Required

The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.

Match^[0-9A-Za-z]{1,10}$Length1 <= length <= 10

Allowed values

"BTC"
"ETH"
"BCH"
"LTC"
"PYUSD"
"LINK"
"SOL"
"MATIC"

quantitystring<cryptocurrency_quantity>Required

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length1 <= length <= 40

quantity_in_subunitsstring<cryptocurrency_subunits_quantity>Optional

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:

Bitcoin(BTC) has 8 decimals,

so 1 BTC will be represented as 100000000 (1 followed by 8 zeroes).

Ethereum(ETH) has 18 decimals,

so 1 ETH will be represented as 1000000000000000000 (1 followed by 18 zeroes).

Match^-?[0-9]+$Length1 <= length <= 81

decimalsinteger<cryptocurrency_decimals>Optional

Range0 <= value <= 40

dispute_life_cycle_stageenum<dispute_lifecycle_stage>Optional

The stage in the dispute lifecycle.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"INQUIRY"
"CHARGEBACK"
"PRE_ARBITRATION"
"ARBITRATION"

dispute_channelenum<dispute_channel>Optional

The channel where the customer created the dispute.

Match^[A-Z0-9_]+$Length1 <= length <= 255

Allowed values

"INTERNAL"
"EXTERNAL"
"ALERT"

buyer_response_due_datestring<date_time>Optional

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

seller_response_due_datestring<date_time>Optional

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Match^[\S\s]*$Length0 <= length <= 2147483647

Allowed values

"GET"
"POST"
"PUT"
"DELETE"
"HEAD"
"CONNECT"
"OPTIONS"
"PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestringOptional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestringOptional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The schema that describes the request data.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The schema that describes the link target.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Match^[\S\s]*$Length0 <= length <= 2147483647

Allowed values

"GET"
"POST"
"PUT"
"DELETE"
"HEAD"
"CONNECT"
"OPTIONS"
"PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestringOptional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestringOptional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The schema that describes the request data.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The schema that describes the link target.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

Dispute Search Response

dispute_info properties

money properties

cryptocurrency properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page

On this page

Dispute Search Response

dispute_info properties

money properties

cryptocurrency properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page

Dispute Search Response

dispute_info properties

money properties

cryptocurrency properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Dispute Search Response

dispute_info properties

money properties

cryptocurrency properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page