Disputes

Get Dispute

Use this endpoint to fetch information from a single dispute, based on a Dispute ID

get/v1/disputes/{disputeId}

Request

Base URL
https://api.sandbox.eu.ppro.com
URL
https://api.sandbox.eu.ppro.com/v1/disputes/{disputeId}
Auth
none declared

Path parameters

disputeIdstring required

Dispute ID starting with 'dispute_' followed by 21 alpha-numeric characters.

Headers

Request-Referencestring

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

Response

Success

idstring required

The unique dispute identifier.

merchantPaymentChargeReferencestring required

A merchant-defined identifier that represents a payment charge.

paymentChargeIdstring required

The payment charge identifier.

paymentSource'GAPI' | 'SAPI' | 'ACI'

Payment source for the payment

paymentMethodstring

Payment method used for the disputed payment.

merchantIdstring required

The merchant ID for the payment.

pspIdstring

The payment service provider (PSP) the merchant belongs to, if any.

phase'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION' required

Current phase of the dispute.

Current status of the dispute

closingReasonstring nullable

Reason provided by the provider for closing the dispute (e.g., accepted by merchant, closed by consumer)

closingNotestring nullable

A note provided while closing the dispute.

openedAtstring date-time

Date and time when the dispute was created by the consumer.

createdAtstring date-time

Date and time when the dispute was created in PPRO.

updatedAtstring date-time

Date and time when the dispute was last updated.

openingNotestring nullable

A note provided when opening the dispute by the consumer.

_linksLinks

Example response

{
  "id": "dispute_20240619XYZabcdefghij",
  "amount": {
    "value": 5000,
    "currency": "EUR"
  },
  "merchantPaymentChargeReference": "merchant_order_12345",
  "paymentChargeId": "charge_7s8FcBoJxMwVkWFR3B41p",
  "paymentSource": "GAPI",
  "paymentMethod": "CARD",
  "merchantId": "merch_1234567890",
  "pspId": "PSP_A",
  "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",
  "merchantActions": [
    {
      "id": "action_20240619XYZabcdefghij",
      "type": "ACCEPT",
      "resolution": "FULL",
      "message": "We accept this dispute and will refund the customer.",
      "amount": {
        "value": 5000,
        "currency": "EUR"
      },
      "createdAt": "2025-06-19T12:34:56.789Z"
    }
  ],
  "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",
      "amount": {
        "value": 5000,
        "currency": "EUR"
      },
      "createdAt": "2025-06-19T12:34:56.789Z",
      "updatedAt": "2025-06-19T12:34:56.789Z"
    }
  ],
  "chargebackReversals": [
    {
      "id": "cb_20240619XYZabcdefghij or cr_20240619XYZabcdefghij",
      "amount": {
        "value": 5000,
        "currency": "EUR"
      },
      "createdAt": "2025-06-19T12:34:56.789Z",
      "updatedAt": "2025-06-19T12:34:56.789Z"
    }
  ]
}

Changes

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