Payment Inquiry

Request URL

https://{{gateway_domain}}/pg/v2/payment/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 specifications section for details.

HTTP Body

Field	Data Type	Length Limit	Required	Description
merchantTradeNo	String	50	Choose one between merchantTradeNo and paymentNo	Merchant order number
paymentNo	String	32	Choose one between merchantTradeNo and paymentNo

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 specifications section for details.

HTTP Body

Field	Data Type	Required	Description
code	String	YES
errorMessage
data	JSON Object

The description of data field

Field	Data Type	Required	Description
paymentNo	String	YES	The payment number generated by the payment platform.
merchantTradeNo	String	YES	The order number generated by the merchant.
amount	String	YES	The amount of the order.
currency	String	YES	The currency of the order.
status	String	YES	See order status for details.
refundStatus	String	YES	See order refund status for details.
rrn	String	NO	The channel retrieves the reference number and returns it depending on the channel.
merchantAttach	String	NO	When using this field in a payment request, it will be returned exactly as is during order inquiry.
createdTime	String	YES	The time when the order was created.
paidTime	String	YES	Payment success time. Null is returned if the payment is not successful.
errorCode	String	NO	Payment failed code, e.g. Payment.Common.Rejected.
errorInfo	String	NO	Payment failed message

Examples

Request

curl https://{{gateway_domain}}/pg/v2/payment/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": "MTU-1162"
}'

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": {
        "paymentNo": "20240423221044300800001096000005",
        "merchantTradeNo": "MTU-1162",
        "amount": "1.00",
        "currency": "INR",
        "status": "PENDING",
        "refundStatus": "NO_REFUND",
        "rrn": "123456789",
        "merchantAttach": null,
        "createdTime": "2024-04-23T22:10:45+08:00",
        "paidTime": null,
        "errorCode": "Payment.Common.Rejected",
        "errorInfo": ""
    }
}

Payment Status

Status	Description
PENDING	To be paid
PROCESSING	The payment is in Progress
PAID	The payment was successful
FAILURE	The payment failed

Payment Refund Status

Status	Description
NO_REFUND	No refunds
REFUNDING	Refund in Progress
REFUNDED	Full refund
PARTIAL_REFUNDED	Partial refund