v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB

Disputes

Internal

Get Disputes

Endpoint to fetch information of all the disputes corresponding to a PPRO Payment Charge ID. Only authenticated users can call this endpoint via Global API (GAPI).

get/v1/disputes

Query parameters

paymentChargeIdstring required

Payment Charge starting with 'charge_' followed by 21 characters.

Headers

Request-Referencestring

Optional Reference for the request. This is used to identify the request in debugging.

Response

Success

Example response

{
  "data": [
    {
      "id": "dispute_20240619XYZabcdefghij",
      "merchantPaymentChargeReference": "merchant_order_12345",
      "paymentChargeId": "charge_7s8FcBoJxMwVkWFR3B41p",
      "paymentSource": "GAPI",
      "merchantId": "merch_1234567890",
      "status": "OPEN",
      "allowedActions": [
        {
          "dueBy": "2025-06-19T12:34:56.789Z",
          "dueByInDays": 7,
          "resolutions": [
            "full-refund",
            "partial-refund",
            "replacement"
          ]
        }
      ],
      "allowedCapabilities": [
        {
          "minLength": 1,
          "maxLength": 2000
        }
      ],
      "files": [
        {
          "id": "file_17574868",
          "name": "some_policy_document.pdf",
          "createdAt": "2025-06-19T12:34:56.789Z",
          "_links": {
            "self": {
              "href": "/v1/disputes/dispute_20240619XYZabcdefghij/files/file_17574868"
            }
          }
        }
      ],
      "reason": {
        "code": "PDSP_PROD_001",
        "message": "Product not as described"
      },
      "openedAt": "2025-06-19T12:34:56.789Z",
      "createdAt": "2025-06-19T12:34:56.789Z",
      "updatedAt": "2025-06-19T12:34:56.789Z",
      "openingNote": "Customer claims product never arrived",
      "messages": [
        {
          "content": "We have reviewed your claim and require additional documentation",
          "createdAt": "2025-06-19T12:34:56.789Z"
        }
      ],
      "chargebacks": [
        {
          "id": "cb_20240619XYZabcdefghij or cr_20240619XYZabcdefghij",
          "paymentChargeId": "charge_7s8FcBoJxMwVkWFR3B41p",
          "disputeId": "dispute_20240619XYZabcdefghij",
          "createdAt": "2025-06-19T12:34:56.789Z",
          "updatedAt": "2025-06-19T12:34:56.789Z"
        }
      ],
      "chargebackReversals": [
        {
          "id": "cb_20240619XYZabcdefghij or cr_20240619XYZabcdefghij",
          "paymentChargeId": "charge_7s8FcBoJxMwVkWFR3B41p",
          "disputeId": "dispute_20240619XYZabcdefghij",
          "createdAt": "2025-06-19T12:34:56.789Z",
          "updatedAt": "2025-06-19T12:34:56.789Z"
        }
      ]
    }
  ]
}