Dispute Inquiry

Request URL

https://{{gateway_domain}}/pg/v2/dispute/query

Request Parameters

HTTP Method

POST

HTTP Header

Field	Data Type	Length Limit	Required	Description
Content-Type	String	N/A	YES	This field value only supports application/json.
Accept	String	N/A	YES	This field value only supports application/json.
Authorization	String		YES	Authorization: {type} {credentials}, refer to the Signature specification

HTTP Body

Field	Data Type	Length Limit	Required	Description
merchantTradeNo	String	50	Choose one of disputeNo, paymentNo, merchantTradeNo	Merchant order number
disputeNo	String	32	Choose one of disputeNo, paymentNo, merchantTradeNo	Dispute number
paymentNo	String	32	Choose one of disputeNo, paymentNo, merchantTradeNo	Payment number

Response Data

HTTP Header

Field	Data Type	Required	Description
Content-Type	String	YES	This field value only supports application/json.
Authorization	String	YES	Authorization: {type} {credentials}, refer to the Signature specification

HTTP Body

Field	Data Type	Required	Description
code	String	YES	Refer to the response codes
errorMessage	String	NO	Error message
data	JSON Object	NO

Description of data field

Field	Data Type	Required	Description
disputeNo	String	YES	Dispute number generated by the payment platform
paymentNo	String	YES	Payment number
merchantTradeNo	String	YES	Merchant order number
status	String	YES	See Dispute Status
type	String	NO	Dispute type
rrn	String	NO	Channel retrieval reference number, depends on channel
deadline	String	NO	Dispute deadline
paymentAmount	String	YES	Order amount
disputeAmount	String	YES	Dispute amount
currency	String	YES	Currency
disputeReason	String	YES	Dispute reason
createdTime	String	YES	Dispute creation time (local time, with timezone)

Examples

Request

curl https://{{gateway_domain}}/pg/v2/dispute/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "merchantTradeNo": "MTOU-0211"
}'

Response

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
      "disputeNo": "1234567890",
      "paymentNo": "1234567890",
      "merchantTradeNo": "MTOU-0211",
      "status": "OPEN",
      "type": "FRAUD",
      "rrn": "123456789",
      "paymentAmount": "1.00",
      "disputeAmount": "1.00",
      "currency": "INR",
      "disputeReason": "FRAUD",
      "createdTime": "2024-04-23T22:10:45+08:00",
      "deadline": "2024-04-23T22:10:45+08:00"
    }
}

Dispute Status

Status	Description
OPEN	Dispute created
UNDER_REVIEW	Under review
WON	Won
LOST	Lost
CLOSED	Closed

Dispute Type

Type	Description
FRAUD	Fraud
RETRIEVAL	Retrieval
BO_RBI_COMPLAINT	RBI complaint
ARBITRATION_RAISE	Arbitration raise
PRE_ARBITRATION_RAISE	Pre-arbitration raise
DIFFERED_CHARGEBACK_RAISE	Differed chargeback raise
CHARGEBACK_RAISE	Chargeback raise
CHARGEBACK	Chargeback
CYBER_CRIME_CASE	Cyber crime case
USER_COMPLAINT	User complaint
UNKNOWN	Unknown