Skip to content

Refund Inquiry

1. API Parameters

For details, please refer: API

Endpoint:refundQuery Sign rule:[Rule](https://docs.shareitpay.in/#/30?page_id=647 "Rule") >Request Parameters
ParameterTypeIf RequiredMax. LengthDescriptionExample
versionStringM8API version. Current value: 1.11.1
keyVersionStringM8Signature Algorithm Version, Current value: 1
requestTimeStringM32Request time, compliant with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
appIdStringM64Merchant App Id, the unique identifier assigned to the merchant app by PayerMax46153e2b787241ae8b01857bb087d1bd
merchantNoStringO15Merchant ID, the unique identifier generated when the merchant signs the contract with PayerMax010229810189301
+dataObjectMrequest data body
「outRefundNoStringO64Original merchant refund order id
「refundTradeNoStringO64PayerMax refund order id, choose one of the outRefundNo and refundTradeNo

Response Parameters

ParameterTypeIf RequiredMax. LengthDescriptionExample
codeStringM32Return code, 'APPLY_SUCCESS' means success
msgStringM256Response description,'Success.'
+dataObjectC
「outRefundNoStringC64Merchant refund order id
「refundTradeNoStringC64PayerMax refund order id
「refundAmountNumberC(20,4)The amount of the refund, the unit of the amount is yuan, and it will be returned according to the decimal point supported by the currency of each country.
「refundCurrencyStringC3Refund currency (original transaction currency)
「outTradeNoStringC64Original merchant order id
「statusStringC32the status of refund,Please refer to[【Refund status】](/en/doc-center/appendix/collection/refund-status)
「resultMsgStringC256the reason of refund status,it only has a value when it fails
# 2. Sample Code >Refund inquiry request
json
{
    "version": "1.1",
    "keyVersion": "1",
    "requestTime": "2022-01-17T07:01:23.737+00:00",
    "appId": "a0dddd1f622243cb9aa1b676e808b5f8",
    "merchantNo": "02021382719993",
    "data": {
        "outRefundNo": "R1642411016202"
    }
}

Refund Inquiry Response

json
{
  "code": "APPLY_SUCCESS",
  "msg": "Success.",
  "data": {
    "outRefundNo": "R1642411016202",
    "refundTradeNo": "20220117091657TI790000055087",
    "refundAmount": 10000,
    "refundCurrency": "IDR",
    "outTradeNo": "P1642410680681",
    "status": "REFUND_SUCCESS"
  }
}

Released under the MIT License.