Skip to content

Refund Application

The payment methods which support to refund refer to [Cashier Payment - Payment Method List] , Transactions are refundable within 180 days from the transaction date. The time user receive the refund money depends on the processing time of banks or institutions.

1. API Parameters

For details, please refer: API

Endpoint:refund 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.SSSXXX2022-01-22T10:00:00.500+08:00
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
「outRefundNoStringM64Merchant refund order id, uniquely identifying a refund application transaction
「refundAmountNumberM(20,4)The amount of the refund, the unit of the amount is Yuan, and it is sent according to the decimal point supported by the currency of each country.
「refundCurrencyStringM3Refund currency (original transaction currency)
「outTradeNoStringM64Original Merchant Order No.
「commentsStringO512Refund Description (Reason for Merchant Refund)
「refundNotifyUrlStringO256Refund callback link, which can be configured in the background of the system,see【Configure the Callback Notification Address】

Response Parameters

ParameterTypeIf RequiredMax. LengthDescriptionExample
codeStringM32returned code,’APPLY_SUCCESS’means success
msgStringM256returned message,'Success.'
+dataObjectM
「outRefundNoStringM64merchant refund order id
「refundTradeNoStringM64PayerMax refund no
「tradeOrderNoStringM64Transaction order id
「statusStringM32[Refund status](/en/doc-center/appendix/collection/refund-status "Refund status")

2. Sample Code

refund application

json
{
    "version": "1.1",
    "keyVersion": "1",
    "requestTime": "2022-01-17T09:20:54.047+00:00",
    "appId": "3b242b56a8b64274bcc37dac281120e3",
    "merchantNo": "020213827212251",
    "data": {
        "outRefundNo": "R1642411016202",
        "refundAmount": 1000,
        "refundCurrency": "IDR",
        "outTradeNo": "P1642410680681",
        "comments": "20220117070423TI408900055079",
        "refundNotifyUrl": "https://www.payermax.com"
    }
}

Refund Request Response

json
{
    "code": "APPLY_SUCCESS",
    "msg": "Success.",
    "data": {
        "outRefundNo": "R1642411016202",
        "tradeOrderNo": "20220117091121TI366100056090",
        "refundTradeNo": "20220117091657TI790000055087",
        "status": "REFUND_PENDING"
    }
}

Was this page helpful?

Thank you for your help in improving PayerMax Product Docs!

Last updated:

Released under the MIT License.