Settle dispute

Important: This method is for sandbox use only.

Settles a dispute in either the customer’s or merchant’s favor. Merchants can make this call in the sandbox to complete end-to-end dispute resolution testing, which mimics the dispute resolution that PayPal agents normally complete. To make this call, the dispute status must be UNDER_REVIEW and adjudicate link should be available in the HATEOAS links of the show dispute details response.

POST /v1/customer/disputes/{id}/adjudicate

Settle dispute

cURL

curl --request POST \
  --url https://api-m.sandbox.paypal.com/v1/customer/disputes/{id}/adjudicate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

Authorizations

Oauth2Oauth2

Authorization · string · header · required

Oauth 2.0 authentication

Path Parameters

id · string · required

The ID of the dispute for which to provide the supporting information.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9-]+$

Body

application/jsonmultipart/relatedmultipart/form-datamultipart/mixed

A request to settle a dispute in either the customer's or merchant's favor.

adjudication_outcome · enum<string> · required

The outcome of the adjudication.

Available options: BUYER_FAVOR, SELLER_FAVOR

Required string length: 1 - 255

Pattern: ^[0-9A-Z_]+$

Response

200

application/json

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

The subsequent action.

links · Link Description · object[] · read-only

An array of request-related HATEOAS links.

Required array length: 1 - 10 elements

Show child attributes