disputes-actions

Make offer to resolve dispute

Makes an offer to the other party to resolve a dispute, by ID. To make this call, the stage in the dispute lifecycle must be INQUIRY. If the customer accepts the offer, PayPal automatically makes a refund. Allowed offer_type values for the request is available in dispute details <a href="/docs/api/customer-disputes/v1/#definition-allowed_response_options">allowed response options</a> object.

post/v1/customer/disputes/{id}/make-offer

Request

Base URL
https://api-m.paypal.com
Auth
- OAuth 2
  Client credentials
  Token URL/v1/oauth2/token
  Scopeshttps://uri.paypal.com/services/disputes/update-seller
- or OAuth 2
  Client credentials
  Token URL/v1/oauth2/token
  Scopeshttps://uri.paypal.com/services/disputes/update-buyer
TypeScript
https://skmtc.dev/paypal/apis/payments/docs/v1/customer/disputes/:id/make-offer/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

ID of the setup token.

Request body

notestring required

The merchant's notes about the offer.

invoice_idstring

The merchant-provided ID of the invoice for the refund. This optional value maps the refund to an invoice ID in the merchant's system.

offer_type'REFUND' | 'REFUND_WITH_RETURN' | 'REFUND_WITH_REPLACEMENT' | 'REPLACEMENT_WITHOUT_REFUND' required

The merchant-proposed offer type for the dispute.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that includes a link to the dispute.

Changes

No recorded changes to this operation across all 1 revision of this API.