View as Markdown
API Spec (JSON)
API Spec (YAML)
Compact modeHides field descriptions and other prose for a more compact, scannable view of the API reference.Note: The fields that appear in the response depend on the access. For example, if the merchant requests shows dispute details, the customer's email ID does not appear.
Oauth 2.0 authentication
In: header
Scope: https://uri.paypal.com/services/disputes/read-buyer
application/json
application/json
application/json
curl -X GET "https://example.com/v1/customer/disputes/string"{ "dispute_id": "string", "create_time": "stringstringstringst", "update_time": "stringstringstringst", "disputed_transactions": [ { "buyer_transaction_id": "string", "seller_transaction_id": "string", "reference_id": "string", "create_time": "stringstringstringst", "transaction_status": "COMPLETED", "gross_amount": { "currency_code": "str", "value": "string" }, "gross_asset": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 }, "invoice_number": "string", "custom": "string", "buyer": { "name": "string" }, "seller": { "email": "string", "merchant_id": "string", "name": "string" }, "items": [ { "item_id": "string", "item_name": "string", "item_description": "string", "item_quantity": "string", "partner_transaction_id": "string", "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "dispute_amount": { "currency_code": "str", "value": "string" }, "notes": "string", "item_type": "PRODUCT", "product_details": null, "service_details": null, "booking_details": null, "digital_download_details": null, "cancellation_details": null, "agreed_refund_details": null } ], "payment_processor": null } ], "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "status": "OPEN", "dispute_amount": { "currency_code": "str", "value": "string" }, "dispute_asset": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 }, "fee_policy": {}, "external_reason_code": "string", "dispute_outcome": { "outcome_code": "RESOLVED_BUYER_FAVOUR", "outcome_reason": "AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES", "amount_refunded": { "currency_code": "str", "value": "string" }, "asset_refunded": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 } }, "adjudications": [ { "type": "DENY_BUYER", "adjudication_time": "stringstringstringst", "reason": "AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES", "dispute_life_cycle_stage": "INQUIRY" } ], "money_movements": [ { "affected_party": "SELLER", "amount": { "currency_code": "str", "value": "string" }, "asset": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 }, "initiated_time": "stringstringstringst", "type": "DEBIT", "reason": "DISPUTE_SETTLEMENT_FEE" } ], "fund_movements": [ { "party": "SELLER", "amount": { "currency_code": "str", "value": "string" }, "asset": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 }, "initiated_time": "stringstringstringst", "type": "DEBIT", "reason": "REVERSED_TRANSACTION_FEE" } ], "dispute_life_cycle_stage": "INQUIRY", "dispute_channel": "INTERNAL", "messages": [ { "posted_by": "BUYER", "time_posted": "stringstringstringst", "content": "string", "documents": [ { "name": "string", "url": "http://example.com" } ] } ], "extensions": { "merchant_contacted": true, "merchant_contacted_outcome": "NO_RESPONSE", "merchant_contacted_time": "stringstringstringst", "merchant_contacted_mode": "WEBSITE", "buyer_contacted_time": "stringstringstringst", "buyer_contacted_channel": "string", "billing_dispute_properties": { "duplicate_transaction": { "received_duplicate": true, "original_transaction": { "buyer_transaction_id": "string", "seller_transaction_id": "string", "reference_id": "string", "create_time": "stringstringstringst", "transaction_status": "COMPLETED", "gross_amount": { "currency_code": "str", "value": "string" }, "gross_asset": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 }, "invoice_number": "string", "custom": "string", "buyer": { "name": "string" }, "seller": { "email": "string", "merchant_id": "string", "name": "string" }, "items": [ { "item_id": "string", "item_name": "string", "item_description": "string", "item_quantity": "string", "partner_transaction_id": "string", "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "dispute_amount": { "currency_code": "str", "value": "string" }, "notes": "string", "item_type": "PRODUCT", "product_details": null, "service_details": null, "booking_details": null, "digital_download_details": null, "cancellation_details": null, "agreed_refund_details": null } ], "payment_processor": null } }, "incorrect_transaction_amount": { "correct_transaction_amount": { "currency_code": "str", "value": "string" }, "correct_transaction_asset": { "asset_symbol": "BTC", "quantity": "string", "quantity_in_subunits": "string", "decimals": 0 }, "correct_transaction_time": "stringstringstringst" }, "payment_by_other_means": { "charge_different_from_original": true, "received_duplicate": true, "payment_method": "CASH", "payment_instrument_suffix": "stri" }, "credit_not_processed": { "issue_type": "PRODUCT", "expected_refund": { "currency_code": "str", "value": "string" }, "cancellation_details": { "cancellation_date": "stringstringstringst", "cancellation_number": "string", "cancelled": true, "cancellation_mode": "CANCELLED_PAYPAL_BILLING_AGREEMENT" }, "product_details": { "description": "string", "product_received": "YES", "product_received_time": "stringstringstringst", "expected_delivery_date": "stringstringstringst", "sub_reasons": [ "DAMAGED" ], "purchase_url": "http://example.com", "return_details": { "return_time": "stringstringstringst", "mode": "SHIPPED", "receipt": true, "return_confirmation_number": "string", "returned": true } }, "service_details": { "description": "string", "service_started": "YES", "note": "string", "sub_reasons": [ "DAMAGED" ], "purchase_url": "http://example.com" }, "agreed_refund_details": { "merchant_agreed_refund": true, "merchant_agreed_refund_time": "stringstringstringst" } }, "canceled_recurring_billing": { "expected_refund": { "currency_code": "str", "value": "string" }, "cancellation_details": { "cancellation_date": "stringstringstringst", "cancellation_number": "string", "cancelled": true, "cancellation_mode": "CANCELLED_PAYPAL_BILLING_AGREEMENT" } } }, "merchandize_dispute_properties": { "issue_type": "PRODUCT", "product_details": { "description": "string", "product_received": "YES", "product_received_time": "stringstringstringst", "expected_delivery_date": "stringstringstringst", "sub_reasons": [ "DAMAGED" ], "purchase_url": "http://example.com", "return_details": { "return_time": "stringstringstringst", "mode": "SHIPPED", "receipt": true, "return_confirmation_number": "string", "returned": true } }, "service_details": { "description": "string", "service_started": "YES", "note": "string", "sub_reasons": [ "DAMAGED" ], "purchase_url": "http://example.com" }, "cancellation_details": { "cancellation_date": "stringstringstringst", "cancellation_number": "string", "cancelled": true, "cancellation_mode": "CANCELLED_PAYPAL_BILLING_AGREEMENT" }, "return_shipping_address": { "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "admin_area_4": "string", "admin_area_3": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st", "address_details": { "street_number": "string", "street_name": "string", "street_type": "string", "delivery_service": "string", "building_name": "string", "sub_building": "string" } } }, "reported_source": "EMAIL" }, "evidences": [ { "evidence_type": "PROOF_OF_FULFILLMENT", "evidence_info": { "tracking_info": [ { "carrier_name": "UPS", "carrier_name_other": "string", "tracking_url": "http://example.com", "tracking_number": "string" } ], "refund_ids": [ "string" ] }, "documents": [ { "name": "string", "url": "http://example.com" } ], "notes": "string", "source": "REQUESTED_FROM_BUYER", "date": "stringstringstringst", "item_id": "string", "item_type": "PRODUCT", "action_info": { "action": "ACKNOWLEDGE_RETURN_ITEM", "response_option": "string", "mandatory": true }, "dispute_life_cycle_stage": "INQUIRY" } ], "buyer_response_due_date": "stringstringstringst", "seller_response_due_date": "stringstringstringst", "offer": { "buyer_requested_amount": { "currency_code": "str", "value": "string" }, "seller_offered_amount": { "currency_code": "str", "value": "string" }, "offer_type": "REFUND", "history": [ { "offer_time": "stringstringstringst", "actor": "BUYER", "event_type": "PROPOSED", "offer_type": "REFUND", "offer_amount": { "currency_code": "str", "value": "string" }, "notes": "string", "dispute_life_cycle_stage": "INQUIRY" } ] }, "refund_details": { "allowed_refund_amount": { "currency_code": "str", "value": "string" }, "transactions": [ { "id": "string", "gross_amount": { "currency_code": "str", "value": "string" }, "create_time": "stringstringstringst" } ] }, "communication_details": { "email": "string", "note": "string", "time_posted": "stringstringstringst" }, "supporting_info": [ { "notes": "string", "documents": [ { "name": "string", "url": "http://example.com" } ], "source": "SUBMITTED_BY_BUYER", "provided_time": "stringstringstringst", "dispute_life_cycle_stage": "INQUIRY" } ], "allowed_response_options": { "acknowledge_return_item": { "acknowledgement_types": [ "ITEM_RECEIVED" ] }, "accept_claim": { "accept_claim_types": [ "REFUND" ] }, "make_offer": { "offer_types": [ "REFUND" ] } }, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": {}, "dependencies": {}, "items": {}, "patternProperties": {}, "properties": {}, "allOf": [ {} ], "anyOf": [ {} ], "oneOf": [ {} ], "not": {}, "links": [ {} ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": {}, "dependencies": {}, "items": {}, "patternProperties": {}, "properties": {}, "allOf": [ {} ], "anyOf": [ {} ], "oneOf": [ {} ], "not": {}, "links": [ {} ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ]}