--- title: "Get Disputes" method: GET path: "/v1/disputes" tags: ["Disputes", "Internal"] --- # Get Disputes `GET /v1/disputes` ## Request - Base URL: `https://api.sandbox.eu.ppro.com` - URL: `https://api.sandbox.eu.ppro.com/v1/disputes` - Auth: none declared 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). ## Query parameters - `paymentChargeId` string, required ## Headers - `Request-Reference` string ## Response `200` Success - DisputeListResponse: Response containing a list of disputes - `data` DisputeResponse[], required: List of disputes - `id` string, required: The unique dispute identifier. - `amount` Amount, required: Amount in ISO 4217 format - `value` integer, required: The monetary value to be charged or processed, expressed in the smallest currency unit (e.g., cents for EUR). - `currency` string, required: The three-letter ISO 4217 currency code representing the currency in which the amount is denominated. - `merchantPaymentChargeReference` string, required: A merchant-defined identifier that represents a payment charge. - `paymentChargeId` string, required: The payment charge identifier. - `paymentSource` 'GAPI' | 'SAPI' | 'ACI': Payment source for the payment - `paymentMethod` string: Payment method used for the disputed payment. - `merchantId` string, required: The merchant ID for the payment. - `pspId` string: The payment service provider (PSP) the merchant belongs to, if any. - `phase` 'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION', required: Current phase of the dispute. - `status` 'OPEN' | 'ACCEPT_PROCESSING' | 'CHALLENGE_PROCESSING' | 'OFFER_PROCESSING' | 'UNDER_REVIEW' | 'LOST' | 'WON' | 'OFFER_ACCEPTED' | 'OFFER_REJECTED', required: Current status of the dispute - `allowedActions` union[]: Actions available to the merchant - union - AcceptActionDto: Defines parameters for the ACCEPT action, used when the merchant chooses to accept a dispute. - `dueBy` string, date-time: Date and time by which this action must be completed. - `messageConfig` MessageConfigDto: Message configuration details - `required` boolean, required: Defines the message requirement - `minLength` integer, required: Minimal length of the message - `maxLength` integer, required: Maximal length of the message - `type` 'ACCEPT', required: Accept action type - `dueByInDays` integer: Number of days by when this action is due. Deprecated: use dueBy instead. - `resolutions` string[]: The resolution options available for the action. If none are specified, no resolution options are required. - ChallengeActionDto: Challenge action configuration - `dueBy` string, date-time: Date and time by which this action must be completed. - `messageConfig` MessageConfigDto: Message configuration details - `required` boolean, required: Defines the message requirement - `minLength` integer, required: Minimal length of the message - `maxLength` integer, required: Maximal length of the message - `type` 'CHALLENGE', required: Challenge action type - `dueByInDays` integer: Number of days by when this action is due. Deprecated: use dueBy instead. - `filesRequired` boolean: Are files required for the challenge? if yes, file upload capability config should also be provided. - `amountRequired` boolean: Is the amount required for the challenge. If not specified, the full disputed amount will be challenged. - OfferActionDto: Defines parameters for the OFFER action, used when the merchant chooses to make an offer on a dispute. - `dueBy` string, date-time: Date and time by which this action must be completed. - `messageConfig` MessageConfigDto: Message configuration details - `required` boolean, required: Defines the message requirement - `minLength` integer, required: Minimal length of the message - `maxLength` integer, required: Maximal length of the message - `type` 'OFFER', required: Offer action type - `dueByInDays` integer: Number of days by when this action is due. Deprecated: use dueBy instead. - `allowedCapabilities` union[]: Additional capabilities available to the merchant - union - FileUploadCapabilityDto: File upload operation configuration - `statusAllowedIn` string[]: The status in which this capability is allowed - `url` string: URL to perform this capability - `type` 'UPLOAD_FILE', required: File upload operation type. - `allowedFileTypes` string: File types allowed for upload as comma separated values - `maxFileSizeInMb` number: Maximum individual file size allowed (in Mb) - `maxNumberOfFiles` integer: Total number of files allowed - PostMessageCapabilityDto: Post messages operation configuration - `statusAllowedIn` string[]: The status in which this capability is allowed - `url` string: URL to perform this capability - `type` 'POST_MESSAGES', required: Post messages operation type - `minLength` integer: Minimum length of the message content - `maxLength` integer: Maximum length of the message content - `files` FileResponse[]: Files associated with the dispute - `id` string: The unique file identifier starting with file_. - `name` string: Name of the file. - `createdAt` string, date-time: Date and time when the file was created. - `phase` 'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION', required: Phase when the file was added. - `sender` 'MERCHANT' | 'PROVIDER', required: Sender of the file. - `status` 'PENDING' | 'FAILED' | 'AVAILABLE' | 'SYNCED_WITH_PROVIDER': Status of the file. - `_links` Links - `reason` DisputeReason - `code` string, required: Reason code for the dispute - `message` string: Reason description for the dispute - `closingReason` string, nullable: Reason provided by the provider for closing the dispute (e.g., accepted by merchant, closed by consumer) - `closingNote` string, nullable: A note provided while closing the dispute. - `openedAt` string, date-time: Date and time when the dispute was created by the consumer. - `createdAt` string, date-time: Date and time when the dispute was created in PPRO. - `updatedAt` string, date-time: Date and time when the dispute was last updated. - `openingNote` string, nullable: A note provided when opening the dispute by the consumer. - `merchantActions` MerchantActionDto[]: List of merchant actions taken on the dispute (ACCEPT, CHALLENGE, OFFER) including resolution, message, and amount. - `id` string: Unique identifier for this merchant action - `phase` 'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION': Phase of the dispute when this action was taken - `type` 'ACCEPT' | 'CHALLENGE' | 'OFFER': Type of action taken by the merchant - `resolution` string, nullable: Resolution chosen for this action (e.g., FULL, PARTIAL) - `message` string, nullable: Message provided by the merchant with this action - `amount` Amount: Amount in ISO 4217 format - `value` integer, required: The monetary value to be charged or processed, expressed in the smallest currency unit (e.g., cents for EUR). - `currency` string, required: The three-letter ISO 4217 currency code representing the currency in which the amount is denominated. - `createdAt` string, date-time: Date and time when this action was created - `messages` MessageDto[]: Messages added by consumers or merchants for this dispute. - `content` string, required: The message content - `sender` 'MERCHANT' | 'PROVIDER': Sender of the message - `phase` 'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION': Phase of the dispute when message was created - `createdAt` string, date-time, required: Date and time when the message was created - `chargebacks` ChargebackDetails[]: Chargebacks associated with this dispute. - `id` string: The unique identifier. - `amount` Amount: Amount in ISO 4217 format - `value` integer, required: The monetary value to be charged or processed, expressed in the smallest currency unit (e.g., cents for EUR). - `currency` string, required: The three-letter ISO 4217 currency code representing the currency in which the amount is denominated. - `reason` 'PDSP_AUTH_001' | 'PDSP_AUTH_002' | 'PDSP_AUTH_003' | 'PDSP_AUTH_004' | 'PDSP_PROD_001' | 'PDSP_PROD_002' | 'PDSP_PROD_003' | 'PDSP_PROD_004' | 'PDSP_PROD_005' | 'PDSP_CANC_001' | 'PDSP_CANC_002' | 'PDSP_CANC_003' | 'PDSP_CANC_004' | 'PDSP_SUBS_001' | 'PDSP_SUBS_002' | 'PDSP_SUBS_003' | 'PDSP_SUBS_004' | 'PDSP_GEN_001' | 'PDSP_GEN_002' | 'PDSP_GEN_003': Defines the reason. - `createdAt` string, date-time: Date and time when the entity was created in PPRO. - `updatedAt` string, date-time: Date and Time when the entity was last updated. - `_links` object - `chargebackReversals` ChargebackDetails[]: Chargeback reversals associated with this dispute. - `id` string: The unique identifier. - `amount` Amount: Amount in ISO 4217 format - `value` integer, required: The monetary value to be charged or processed, expressed in the smallest currency unit (e.g., cents for EUR). - `currency` string, required: The three-letter ISO 4217 currency code representing the currency in which the amount is denominated. - `reason` 'PDSP_AUTH_001' | 'PDSP_AUTH_002' | 'PDSP_AUTH_003' | 'PDSP_AUTH_004' | 'PDSP_PROD_001' | 'PDSP_PROD_002' | 'PDSP_PROD_003' | 'PDSP_PROD_004' | 'PDSP_PROD_005' | 'PDSP_CANC_001' | 'PDSP_CANC_002' | 'PDSP_CANC_003' | 'PDSP_CANC_004' | 'PDSP_SUBS_001' | 'PDSP_SUBS_002' | 'PDSP_SUBS_003' | 'PDSP_SUBS_004' | 'PDSP_GEN_001' | 'PDSP_GEN_002' | 'PDSP_GEN_003': Defines the reason. - `createdAt` string, date-time: Date and time when the entity was created in PPRO. - `updatedAt` string, date-time: Date and Time when the entity was last updated. - `_links` object - `_links` Links ## Other responses - `400`: Bad Request - `404`: Not found - `409`: Target event could not be reset due to a concurrent update. - `500`: Internal Server Error --- [API](https://skmtc.dev/ppro/apis/risk-management.md) - [All operations](https://skmtc.dev/ppro/apis/risk-management/llms.txt) - [OpenAPI document](https://skmtc.dev/ppro/apis/risk-management/revisions/13f03e5db959?raw)