Skip to content

Query Refund Detail

Query refund detail by merchant refund SN.

Endpoint

GET /cashin/pix/check-refund-detail

Authentication

Merchant Credential. See Authentication.

Request headers

NameInTypeRequiredDescriptionExample
X-NonceheaderstringYesa9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-IdheaderstringYes2492265300
X-TimestampheaderstringYes1638123456
DigestheaderstringYesSHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
AuthorizationheaderstringYesSignature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Query parameters

NameInTypeRequiredDescriptionExample
refundSnquerystringYesMerchant refund SNE2909301

Response

HTTP 200 — Success

FieldTypeRequiredDescription
statusintegerYes
msgnullYes
dataobjectYes

data fields

FieldTypeRequiredDescription
mchOrderNostringYes
platOrderNostringYes
orderStatusstringYesOrder status
amountintegerYes
payAmountintegerYes
msgstringYes
payTimeintegerYes
e2eIdstringYes
payerNamestringYes
payerDocumentstringYes
refundAmountnumberYes
refundTotalAmountnumberYes
refundSnstringYes
originE2eIdstringYes
refundIdstringYes
statusstringYesRefund status (enum=PENDING, SUCCESS, FAILED)

Response example

json
{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "SP_260625D1VaP1Wuo53TjX13IpCt",
    "platOrderNo": "P_260625c5mNa7GfzICaFlVSwzsi",
    "orderStatus": "REFUND",
    "status": "SUCCESS",
    "amount": 10,
    "payAmount": 10,
    "msg": "",
    "payTime": 1782402606,
    "e2eId": "",
    "payerName": "",
    "payerDocument": "",
    "refundAmount": 1.01,
    "refundTotalAmount": 1.01,
    "refundSn": "E2909301",
    "originE2eId": "E2909301939883298131adj33",
    "refundId": "302"
  }
}