Dispute Details

The dispute details.

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

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"

messagesobject<message>[]Optional

An array of customer- or merchant-posted messages for the dispute.

Items1 <= length <= 1000

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

communication_detailsobject<communication_details>Optional

The contact details that a merchant provides to the customer to use to share their evidence documents.

supporting_infoobject<supporting_info>[]Optional

An array of all the supporting information that are associated to this dispute.

Items1 <= length <= 100

supporting_info properties

5 properties

documentsobject<document>[]Optional

An array of metadata for the documents which were uploaded as supporting information for the dispute.

Items1 <= length <= 100

dispute_life_cycle_stageenum<dispute_lifecycle_stage>Optional

The dispute life cycle stage for the supporting info.

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

Allowed values

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

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

transaction_info properties

money properties

cryptocurrency properties

buyer properties

seller properties

item_info properties

money properties

money properties

cryptocurrency properties

dispute_outcome properties

money properties

cryptocurrency properties

adjudication properties

money_movement properties

money properties

cryptocurrency properties

fund_movement properties

money properties

cryptocurrency properties

message properties

document properties

extensions properties

billing_disputes_properties properties

duplicate_transaction properties

transaction_info properties

money properties

cryptocurrency properties

buyer properties

seller properties

item_info properties

money properties

incorrect_transaction_amount properties

money properties

cryptocurrency properties

payment_by_other_means properties

credit_not_processed properties

money properties

cancellation_details properties

product_details properties

return_details properties

service_details properties

agreed_refund_details properties

canceled_recurring_billing properties

money properties

cancellation_details properties

merchandize_dispute_properties properties

product_details properties

return_details properties

service_details properties

cancellation_details properties

address_portable properties

address_details properties

evidence properties

evidence_info properties

tracking_info properties

document properties

action_info properties

offer properties

money properties

money properties

offer_history properties

money properties

refund_details properties

money properties

refund_transaction properties

money properties

communication_details properties

supporting_info properties

document properties

allowed_response_options properties

acknowledge_return_item_response_options properties

accept_claim_response_options properties

make_offer_response_options properties

link_description properties

link_schema properties

media properties

link_schema properties