{
  "opencollection": "1.0.0",
  "info": {
    "name": "Paypal Subscriptions Authorizations Disputes-Actions API",
    "version": "1.6"
  },
  "items": [
    {
      "info": {
        "name": "Disputes-Actions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Paypal Provide evidence",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/provide-evidence",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "evidence-file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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 documen"
        },
        {
          "info": {
            "name": "Paypal Appeal dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/appeal",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "evidence-file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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 "
        },
        {
          "info": {
            "name": "Paypal Accept claim",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/accept-claim",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "accept-claim-document",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Paypal Settle dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/adjudicate",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "<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-dis"
        },
        {
          "info": {
            "name": "Paypal Update dispute status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/require-evidence",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "<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  sho"
        },
        {
          "info": {
            "name": "Paypal Escalate dispute to claim",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/escalate",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Escalates the dispute, by ID, to a PayPal claim. To make this call, the stage in the dispute lifecycle must be `INQUIRY`."
        },
        {
          "info": {
            "name": "Paypal Send message about dispute to other party",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/send-message",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "message_document",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Paypal Make offer to resolve dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/make-offer",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Paypal Accept offer to resolve dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/accept-offer",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "The customer accepts the offer from merchant to resolve a dispute, by ID. PayPal automatically refunds the amount proposed by merchant to the customer."
        },
        {
          "info": {
            "name": "Paypal Deny offer to resolve dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/deny-offer",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Denies an offer that the merchant proposes for a dispute, by ID."
        },
        {
          "info": {
            "name": "Paypal Acknowledge returned item",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/acknowledge-return-item",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "acknowledgement_document",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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/#docu"
        },
        {
          "info": {
            "name": "Paypal Provide supporting information for dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-m.sandbox.paypal.com/v1/customer/disputes/:id/provide-supporting-info",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which to provide the supporting information."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "supporting document",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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 s"
        }
      ]
    }
  ],
  "bundled": true
}