Refund Notification

• Endpoint: POST /RefundResultNotifyUrl
• Tags: Collection Service

Parameters

Field	In	Type	Required	Constraints	Description
Content-Type	header	string	Yes
sign	header	string	Yes		签名信息请参考技术文档

Parameter Examples

• Content-Type: "application/json"
• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
code	string	Yes	maxLength: 32	Returned code，’APPLY_SUCCESS’means success
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
appId	string	Yes		Merchant AppId，The unique identifier assigned to the merchant app by PayerMax
merchantNo	string	No	maxLength: 32	Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax
msg	string	Yes	maxLength: 256	Returned message，’Success.’
notifyTime	string	Yes	maxLength: 32	Request time, compliant with rfc3339 specification, format: yyyy-MM-dd’T’HH:mm:ss.SSSXXX
notifyType	string	Yes	maxLength: 16	notify type: REFUND	REFUND
data	object	Yes		Notify data body
data.outRefundNo	string	Yes	maxLength: 64	merchant refund order id
data.refundTradeNo	string	Yes	maxLength: 64	PayerMax refund order id.
data.outTradeNo	string	Yes	maxLength: 64	original merchant order id.
data.refundAmount	number	Yes		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.
data.refundCurrency	string	Yes	maxLength: 3	refund currency
data.status	string	Yes	maxLength: 32	Refund status：REFUND_SUCCESS, REFUND_FAILED	REFUND_SUCCESS, REFUND_FAILED
data.refundFinishTime	string	Yes		refund finish time

Example

{
  "code": "APPLY_SUCCESS",
  "msg": "Success.",
  "keyVersion": "1",
  "appId": "3b242b56a8b64274bcc37dac281120e3",
  "merchantNo": "020213827212251",
  "notifyTime": "2022-01-17T09:33:54.540+00:00",
  "notifyType": "REFUND",
  "data": {
    "outRefundNo": "R1642411016202",
    "refundTradeNo": "20220117091657TI790000055087",
    "outTradeNo": "P1642410680681",
    "refundAmount": 10000,
    "refundCurrency": "IDR",
    "refundFinishTime": "2023-10-20T03:28:23.092Z",
    "status": "REFUND_SUCCESS"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes	maxLength: 32	response ‘SUCCESS’
msg	string	No	maxLength: 256	response ‘Success’

Response Example

{
  "code": "SUCCESS",
  "msg": "Success"
}

Enum Reference

notifyType

• REFUND

data.status

• REFUND_SUCCESS
• REFUND_FAILED