search

POSTDispute Status API

Use Case

This API allows the merchant to get the status of a particular dispute by Dispute ID. It consumes and produces application/json.

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimestamp
string(16)
mandatory

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

clientId
string(32)
optional

Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

Example: C11

tokenType
Enum
optional

Authorization method for this request.

Possible Values: Checksum 

signature
string(128)
mandatory

Authorization string corresponding to the tokenType used. For CHECKSUM it's value to be sent should be the checksum string created by using https://developer.paytm.com/docs/checksum/.
 

Note: Checksum generation logic is the same as used in other Native APIs. The checksum will be generated by a string where the string contains JSON stringify value of body object. For more info see https://developer.paytm.com/docs/checksum/#java, check the example for JSON Request.

Example: TXBw50YPUKIgJd8gR8RpZuOMZ+csvCT7i0/YXmG//J8+BpFdY5goPBiLAkCzKlCkOvAQip/Op5aD6Vs+cNUTjFmC55JBxvp7WunZ45Ke2q0=

Body

AttributeDescription
mid
string(32)
mandatory

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.

Example: INTEGR7769XXXXXX9383

disputeId
string(64)
mandatory

Dispute Id for which merchant is uploading proofs/documents

Example: 20191218111221000100168001200816663

Response Attributes

Content Type : JSON

Head

AttributeDescription
version
string(2)

Version of the API passed in the request.
Example: v1

responseTimestamp
string(16)

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

clientId
string(32)

Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

signature
string(128)

Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

Body

AttributeDescription
resultInfo
object

This parameter gives the information about the result of the API response

ResultInfo
+
AttributeDescription
resultStatus
string(1)

This parameter indicates the status of API call.

Possible Values: S,F,U,A

resultCodeId
string(4)

This is the resultCode corresponding to a particular message and is returned to the merchant. 

Example: 1003

resultMsg
string(256)

This parameter is the result message which contains information about the result.

Example: AUDIT_SUCCESS

resultCode
string(64)

Result Code of the response

Example: AUDIT_SUCCESS

mid
string(32)

Merchant Id

Example: INTEGR7769XXXXXX9383

disputeId
string(128)

Dispute Id

Example: 20191218111221000100168001200816663

transactionId
string(64)

Transaction Id

Example: 200912811545796652

transactionDateTime
string(32)

Transaction creation Date and Time

Example: 2020-09-12 13:03:36

orderId
string(64)

Order Id

Example: 21271212121221212212

transactionAmount
string

Transaction Amount

Example: 3836.00

disputeAmount
string

Dispute Amount

Example: 3836.00

debitAmount
string

Debit Amount

Example: 3836.00

bankReferenceNo
string(128)

Bank Reference Number

Example: 777001749889327

custId
string(64)

Customer Id

Example: Cust001

extSerialNo
string(128)

External Serial Number

Example: 90210223000484267946

disputeStatus
string(32)

Dispute Status

Example: Accept

disputeType
string(128)

Dispute Type

Possible Values: Successful Order, Service/product delivered

disputeDueDate
string(32)

Dispute Due Date and Time

Example: 2020-10-23 23:59:59

disputeLostReason
string(128)

Dispute Lost Reason

Example: Failed to respond

comment
string(246)

Comment/Remark in case of POD Rejected

Example: Provided proofs are invalid

disputeUtr
string(64)

Dispute UTR corresponding to amount deducted from merchant account, in case of Dispute is Lost

Example: 12345123451234

disputeCreateDateTime
string(32)

Dispute create Date and Time

Example: 2020-10-23 00:23:46

disputeUpdateDateTime
string(32)

Dispute update Date and Time

Example: 2020-10-23 00:23:46

Response Codes & Messages

resultCodeId resultStatus resultCode resultMsg
1001 S SUCCESS Success
4001 F
INVALID_SIGNATURE
Provided signature is invalid
4002 F
MANDATORY_PARAM_MISSING
Dispute Id is required
4003 F
REQUEST_PARAMS_INVALID
Invalid Request Params
4004 F
DISPUTE_ID_NOT_FOUND
Dispute id not found
5001 U SYSTEM_ERROR System Error
Staging
Production
https://securegw-stage.paytm.in/api/v1/dispute/statuscopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
DOTNET
PHP
PYTHON
curl --location --request POST 'https://securegw.paytm.in/api/v1/dispute/status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "head": {
        "requestTimestamp": "1588402269",
        "signature": "tBA/wKjZY9LYtKEWzaLf3WgunHBUxzsnujUGUcaI6YeQlkEZyg/ME9UrOX9midYY1rfKWxrIv3VIWNvu5IblBFVTXcrfzv/siHjyn9qSPHk="
    },
    "body": {
        "mid": "ethics90962220263187",
        "disputeId": "20201118111221000100168000300212600"
    }
}'
copy icon