PayPal Disputes-Actions API

Use the `/disputes` resource with a dispute ID and an action to:Accept a claim.Accept an offer to resolve a dispute.Acknowledge the return of an item related to a dispute.Settle a dispute.Appeal a dispute.Cancel a dispute.Change the reason for a dispute.Deny an offer to resolve dispute.Escalate a dispute to a claim.Make an offer to resolve a dispute.Make an offer to resolve a dispute.Provide evidence for a dispute.Provide supporting information for dispute.In the sandbox, update the dispute status.Send a message about a dispute to the other party in the dispute.

OpenAPI Specification

paypal-disputes-actions-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Paypal Subscriptions Authorizations Disputes-Actions API
  description: You can use billing plans and subscriptions to create subscriptions that process recurring PayPal payments for physical or digital goods, or services. A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased. For more information, see <a href="/docs/subscriptions/">Subscriptions Overview</a>.
  version: '1.6'
  contact: {}
servers:
- url: https://api-m.sandbox.paypal.com
  description: PayPal Sandbox Environment
- url: https://api-m.paypal.com
  description: PayPal Live Environment
tags:
- name: Disputes-Actions
  description: Use the `/disputes` resource with a dispute ID and an action to:<ul><li>Accept a claim.</li><li>Accept an offer to resolve a dispute.</li><li>Acknowledge the return of an item related to a dispute.</li><li>Settle a dispute.</li><li>Appeal a dispute.</li><li>Cancel a dispute.</li><li>Change the reason for a dispute.</li><li>Deny an offer to resolve dispute.</li><li>Escalate a dispute to a claim.</li><li>Make an offer to resolve a dispute.</li><li>Make an offer to resolve a dispute.</li><li>Provide evidence for a dispute.</li><li>Provide supporting information for dispute.</li><li>In the sandbox, update the dispute status.</li><li>Send a message about a dispute to the other party in the dispute.</li><ul>
paths:
  /v1/customer/disputes/{id}/provide-evidence:
    post:
      summary: Paypal Provide evidence
      description: Provides evidence for a dispute, by ID. A merchant can provide evidence for disputes with the <code>WAITING_FOR_SELLER_RESPONSE</code> status while customers can provide evidence for disputes with the <code>WAITING_FOR_BUYER_RESPONSE</code> status. Evidence can be a proof of delivery or proof of refund document or notes, which can include logs. A proof of delivery document includes a tracking number while a proof of refund document includes a refund ID. For other evidence type, notes and documents can be given. Evidences requested from you can be found by checking the type of evidence for the corresponding source under the evidence section of the <a href="/docs/api/customer-disputes/v1/#disputes_get">show dispute details</a> response. The source will be <code>REQUESTED_FROM_SELLER</code> for evidences requested from the merchant while it will be <code>REQUESTED_FROM_BUYER</code> for evidences requested from the customer. For constraints and rules regarding documents, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#documents">documents</a>.<br/>To make this request, specify the evidence in the JSON request body and use the <code>provide-evidence</code> link in the <a href="/docs/api/reference/api-responses/#hateoas-links/">HATEOAS links</a> of the <a href="/docs/api/customer-disputes/v1/#disputes_get">show dispute details</a> response. In case the link is not present in the response, you can't provide evidence for the dispute. For information about dispute reasons, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#dispute-reasons">dispute reasons</a>.
      operationId: disputes.provide-evidence
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        $ref: '#/components/requestBodies/evidences'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-partner
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/appeal:
    post:
      summary: Paypal Appeal dispute
      description: Appeals a dispute, by ID. To appeal a dispute, use the <code>appeal</code> link in the <a href="/docs/api/reference/api-responses/#hateoas-links/">HATEOAS links</a> from the show dispute details response. If this link does not appear, you cannot appeal the dispute. Submit new evidence as a document or notes in the JSON request body. For constraints and rules regarding documents, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#documents">documents</a>.<br/>To make this request, specify the dispute ID in the URI and specify the evidence in the JSON request body. For information about dispute reasons, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#dispute-reasons">dispute reasons</a>.
      operationId: disputes.appeal
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        $ref: '#/components/requestBodies/evidences'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/accept-claim:
    post:
      summary: Paypal Accept claim
      description: Accepts liability for a claim, by ID. When you accept liability for a claim, the dispute closes in the customer’s favor and PayPal automatically refunds money to the customer from the merchant's account. Allowed accept_claim_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.
      operationId: disputes.accept-claim
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                accept-claim-document:
                  description: A file with evidence.
                  type: string
                  format: binary
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/adjudicate:
    post:
      summary: Paypal Settle dispute
      description: <blockquote><strong>Important:</strong> This method is for sandbox use only.</blockquote> 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 <code>status</code> must be <code>UNDER_REVIEW</code> and <code>adjudicate</code> link  should be available in the <a href="/docs/api/customer-disputes/v1/#disputes_get!c=200&path=links&t=response/">HATEOAS links</a> of the <a href="/docs/api/customer-disputes/v1/#disputes_get">show dispute details</a> response.
      operationId: disputes.adjudicate
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/adjudicate'
            examples:
              adjudicate:
                value:
                  adjudication_outcome: BUYER_FAVOR
          multipart/related:
            schema:
              $ref: '#/components/schemas/adjudicate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/adjudicate'
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/adjudicate'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/require-evidence:
    post:
      summary: Paypal Update dispute status
      description: <blockquote><strong>Important:</strong> This method is for sandbox use only.</blockquote> Updates the status of a dispute, by ID, from <code>UNDER_REVIEW</code> to either:<ul><li><code>WAITING_FOR_BUYER_RESPONSE</code></li><li><code>WAITING_FOR_SELLER_RESPONSE</code></li></ul>This status change enables either the customer or merchant to submit evidence for the dispute. To make this call, the dispute <code>status</code> must be <code>UNDER_REVIEW</code> and <code>require-evidence</code> link  should be available in the <a href="/docs/api/customer-disputes/v1/#disputes_get!c=200&path=links&t=response/">HATEOAS links</a> of the <a href="/docs/api/customer-disputes/v1/#disputes_get">show dispute details</a> response. Specify an <code>action</code> value in the JSON request body to indicate whether the status change enables the customer or merchant to submit evidence:<table><thead><tr align="left"><th>If <code>action</code> is</th><th>The <code>status</code> updates to</th></tr></thead><tbody><tr><td><code>BUYER_EVIDENCE</code></td><td> <code>WAITING_FOR_BUYER_RESPONSE</code></td></tr><tr><td><code>SELLER_EVIDENCE</code></td><td> <code>WAITING_FOR_SELLER_RESPONSE</code></td></tr></tbody></table>.
      operationId: disputes.require-evidence
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/require_evidence'
            examples:
              escalate:
                value:
                  note: Escalating to PayPal claim for resolution.
          multipart/related:
            schema:
              $ref: '#/components/schemas/require_evidence'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/require_evidence'
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/require_evidence'
        required: true
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/escalate:
    post:
      summary: Paypal Escalate dispute to claim
      description: Escalates the dispute, by ID, to a PayPal claim. To make this call, the stage in the dispute lifecycle must be `INQUIRY`.
      operationId: disputes.escalate
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/escalate'
            examples:
              require_evidence:
                value:
                  action: BUYER_EVIDENCE
          multipart/related:
            schema:
              $ref: '#/components/schemas/escalate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/escalate'
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/escalate'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/send-message:
    post:
      summary: Paypal Send message about dispute to other party
      description: Sends a message about a dispute, by ID, to the other party in the dispute. Merchants and customers can only send messages if the `dispute_life_cycle_stage` value is `INQUIRY`. For constraints and rules regarding documents that can be attached as part of the message, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#documents">documents</a>. To send a message, use the <code>send-message</code> link in the <a href="/docs/api/reference/api-responses/#hateoas-links/">HATEOAS links</a> of the <a href="/docs/api/customer-disputes/v1/#disputes_get">show dispute details</a> response and specify the message in the JSON request body. In case the link is not present in the response you can't send a message on the dispute.
      operationId: disputes.send-message
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                message_document:
                  description: A file that contains any additional info about the message posted.
                  type: string
                  format: binary
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/make-offer:
    post:
      summary: Paypal Make offer to resolve dispute
      description: 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.
      operationId: disputes.make-offer
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/make_offer'
            examples:
              make_offer:
                value:
                  note: Offer refund with replacement item.
                  offer_amount:
                    currency_code: USD
                    value: '23'
                  offer_type: REFUND_WITH_REPLACEMENT
          multipart/related:
            schema:
              $ref: '#/components/schemas/make_offer'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/make_offer'
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/make_offer'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/accept-offer:
    post:
      summary: Paypal Accept offer to resolve dispute
      description: The customer accepts the offer from merchant to resolve a dispute, by ID. PayPal automatically refunds the amount proposed by merchant to the customer.
      operationId: disputes.accept-offer
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '202':
          description: A successfully accepted request returns the HTTP `202 Accepted` status code and a JSON response body that includes a [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links) to the ID of the request. The request returns `202 Accepted` status in case money movement for the offer is delayed due to some internal reasons.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accept_offer'
            examples:
              accept_offer:
                value:
                  note: I am ok with the refund offered.
          multipart/related:
            schema:
              $ref: '#/components/schemas/accept_offer'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/accept_offer'
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/accept_offer'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/deny-offer:
    post:
      summary: Paypal Deny offer to resolve dispute
      description: Denies an offer that the merchant proposes for a dispute, by ID.
      operationId: disputes.deny-offer
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deny_offer'
            examples:
              deny_offer:
                value:
                  note: refund offer is very low.
          multipart/related:
            schema:
              $ref: '#/components/schemas/deny_offer'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/deny_offer'
          multipart/mixed:
            schema:
              $ref: '#/components/schemas/deny_offer'
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-buyer
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/acknowledge-return-item:
    post:
      summary: Paypal Acknowledge returned item
      description: Acknowledges that the customer returned an item for a dispute, by ID. A merchant can make this request for disputes with the `MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` reason. Allowed acknowledgement_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. For constraints and rules regarding documents, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#documents">documents</a>.
      operationId: disputes.acknowledge-return-item
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                acknowledgement_document:
                  description: A file with evidence.
                  type: string
                  format: binary
      security:
      - Oauth2:
        - https://uri.paypal.com/services/disputes/update-seller
      tags:
      - Disputes-Actions
  /v1/customer/disputes/{id}/provide-supporting-info:
    post:
      summary: Paypal Provide supporting information for dispute
      description: Provides supporting information for a dispute, by ID. A merchant or buyer can make this request for disputes if they find the `provide-supporting-info` link in the HATEOAS links in the list disputes response. The party can provide the supporting information to PayPal to defend themselves only when the `dispute_life_cycle_stage` is `CHARGEBACK`, `PRE_ARBITRATION`, or `ARBITRATION`. They can provide a note that describes their part with details or upload any supporting documents to support their side. For constraints and rules regarding documents, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#documents">documents</a>.<br/>To make this request, specify the dispute ID in the URI and specify the notes in the JSON request body. This method differs from the provide evidence method which supports only multipart request, where PayPal asks the concerned party for evidence.
      operationId: disputes.provide-supporting-info
      responses:
        '200':
          description: A successful request returns the HTTP `200 OK` status code and a JSON response body that includes a link to the dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subsequent_action'
        '400':
          description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: The request failed due to the dispute is not available. The request returns the HTTP `404 Not Found` status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code.
          content:
   

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/paypal/refs/heads/main/openapi/paypal-disputes-actions-api-openapi.yml