Fetch List of Disputes

To fetch the list of disputes by specifying the date range, limit, offset and Status (“ACTION_REQUIRED”, “UNDER_REVIEW”, “WON”, “LOST”).

Environment

Environment	Http Method	API
`Sandbox`	`GET`	https://api-preprod.phonepe.com/apis/pg-sandbox/v1/disputes?from=<epoch-timestamp>&to=<epoch-timestamp>&offset=<integer>&limit=<integer>&status=<statusTobeFetched>
`Production`	`GET`	https://api.phonepe.com/apis/pg/v1/disputes?from=<epoch-timestamp>&to=<epoch-timestamp>&offset=<integer>&limit=<integer>&status=<statusTobeFetched>

Request Headers

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <access_token>

Path Parameters

Path Parameter Name	Type	Description
`from`	Long	Start date period (Epoch timestamp) (in milliseconds) Note : Required Parameter
`to`	Long	End date period (Epoch timestamp) (in milliseconds) Note : Required Parameter
`offset`	Long	The starting point of the records
`limit`	Long	The number of record merchant want to fetch Note: Max value 100
`status`	Enum	Status for which merchant want to fetch the list of disputes Note : Required Parameter

ℹ️ Dispute List API Date Range!

The Dispute List API supports responses for disputes within the specified date range, defined by the from (epoch date) and to (epoch date) parameters.

Response

{
    "disputes": [
        {
            "merchantId": "merchantId",
            "disputeId": "D23456",
            "merchantOrderId": "MO2321",
            "orderId": "OMO241",
            "transactionId": "OM123",
            "transactionCompletedAt": <epoch-timestamp>,
            "transactionAmount": 1000,
            "disputeAmount": 1000,
            "refundAmount": 0,
            "contestAmount": 0,
            "status": "ACTION_REQUIRED",
            "stage": "CHARGEBACK",
            "createdAt": <epoch-timestamp>,
            "updatedAt": <epoch-timestamp>
        },
        {
            "merchantId": "merchantId",
            "disputeId": "D5674",
            "merchantOrderId": "MO2324",
            "orderId": "OMO241",
            "transactionId": "OM456",
            "transactionCompletedAt": <epoch-timestamp>,
            "transactionAmount": 1000,
            "disputeAmount": 1000,
            "refundAmount": 0,
            "contestAmount": 0,
            "status": "ACTION_REQUIRED",
            "stage": "ARBITRATION",
            "createdAt": <epoch-timestamp>,
            "updatedAt": <epoch-timestamp>
        }
    ],
    "nextOffset" : 2,
    "totalCount" :  2
}

Response Parameters

Parameter Name	Type	Description
`disputes`	LIST	List of dispute object
`merchantId`	String	Unique `MerchantID` assigned to the merchant by PhonePe Note: merchantId length will be less than 38 characters.
`disputeId`	String	Unique DisputeId assigned to a dispute
`merchantOrderId`	String	Unique merchant order id generated by merchant
`orderId`	String	PhonePe generated order Id
`transactionId`	String	Unique transaction id generated by phonepe
`transactionCompletedAt`	Long	Epoch timestamp of the transaction completion time (in milliseconds)
`transactionAmount`	Long	Amount of the transaction
`disputeAmount`	Long	Amount for which dispute is raised, will be lesser than or equal to transactionAmount
`refundAmount`	Long	After the status of dispute moved to LOST or WON, The amount that is given back to the customer
`contestAmount`	Long	Amount for which merchant does the contest
`status`	ENUM	Status of the dispute Note: The value could be “ACTION_REQUIRED”, “UNDER_REVIEW”, “WON” or “LOST”
`stage`	ENUM	Stage of the dispute Note: The value could be “CHARGEBACK” or “PRE_ARBITRATION”
`createdAt`	Long	Epoch timestamp, Creation date of the dispute (in milliseconds)
`updatedAt`	Long	Epoch timestamp, Last updated date of a dispute (in milliseconds)
`nextOffset`	Integer	Next offset in the filter list to pick the document
`totalCount`	Integer	Total record under the filter

Error Scenarios

Error Scenario	Response Code	Response
Input invalid limit or offset is negative OR limit > 100 OR offset is greater than total count	400	{ “message”: “Invalid pagination parameters”, “code”: “INVALID_PAGINATION_PARAMS” }
from >= to	400	{ “message”: “Time range Invalid”, “code”: “INVALID_TIME_RANGE” }
from (or) to is null	400	{ “message”: “From or to cannot be null”, “code”: “INVALID_VALUE_OF_FROM_OR_TO” }