Refund Inquiry

Request URL

https://{{gateway_domain}}/pg/v2/refund/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
merchantRefundNo	String	50	NO	Merchant refund order number. Choose one with refundNo, both cannot be null
refundNo	String	32	NO	Refund transaction number. Choose one with merchantRefundNo

Parameter notes

merchantRefundNo and refundNo cannot both be empty. Provide at least one to query the refund info.

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	Response status code
errorMessage	String	NO	Error message
data	JSON Object	NO	Response data

Description of data field

Field	Data Type	Required	Description
refundNo	String	YES	Refund platform transaction number
disputeNo	String	NO	Dispute number if it is a dispute refund
paymentNo	String	YES	Payment platform transaction number
merchantRefundNo	String	YES	Merchant refund order number
bankRefundNo	String	NO	Bank refund number
rrn	String	NO	Channel retrieval reference number
status	String	YES	Refund status
refundSource	String	YES	Refund source
refundAmount	String	YES	Refund amount
currency	String	YES	Refund currency
createdTime	String	YES	Refund creation time

Examples

Request example 1: Query by merchant refund order number

curl https://{{gateway_domain}}/pg/v2/refund/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 '{
  "merchantRefundNo": "REFUND-001"
}'

Request example 2: Query by platform refund transaction number

curl https://{{gateway_domain}}/pg/v2/refund/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 '{
  "refundNo": "20240423220624300800001097000004"
}'

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": {
        "refundNo": "20240423220624300800001097000005",
        "disputeNo": null,
        "paymentNo": "20240423220624300800001097000004",
        "merchantRefundNo": "REFUND-001",
        "bankRefundNo": "BK20240423001",
        "rrn": "123456789012",
        "status": "REFUNDING",
        "refundSource": "DEFAULT",
        "refundAmount": "50.00",
        "currency": "INR",
        "createdTime": "2024-04-23T22:10:45+08:00"
    }
}

Refund Status

Status	Description
REFUNDING	Refunding
SUCCEED	Refund succeeded
FAILED	Refund failed
CANCELLED	Refund cancelled
REVERSED	Refund reversed/adjusted

Refund Source

Source	Description
DEFAULT	Default refund
DISPUTE	Dispute refund
MERCHANT	Merchant refund
PLATFORM	Platform refund