Refund Inquiry

• Endpoint: POST /aggregate-pay/api/gateway/refundQuery
• 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
version	string	Yes		API version. Current value: 1.5
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
requestTime	string	Yes		Request time, compliant with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX The time must be within two minutes of the current time
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
data	object	Yes		Request data body
data.outRefundNo	string	No	maxLength: 64	Original merchant refund order id
data.refundTradeNo	string	No	maxLength: 64	PayerMax refund order id, choose one of the outRefundNo and refundTradeNo

Example

{
  "version": "1.5",
  "keyVersion": "1",
  "requestTime": "2022-01-17T07:01:23.737+00:00",
  "appId": "a0dddd1f622243cb9aa1b676e808b5f8",
  "merchantNo": "02021382719993",
  "data": {
    "outRefundNo": "R1642411016202"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success.It only represents the success of the interface request, not the order status.
msg	string	Yes		Return message, ‘Success.’.It only represents the success of the interface request, not the order status.
data	object	No		Return data body
data.outRefundNo	string	No	maxLength: 64	Merchant refund order id
data.refundTradeNo	string	No	maxLength: 64	PayerMax refund order id
data.refundAmount	number	No		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	No	maxLength: 3	Refund currency (original transaction currency)
data.outTradeNo	string	No	maxLength: 64	Original merchant order id
data.status	string	No	maxLength: 32	the status of refund，Please refer to【Refund status】	REFUND_SUCCESS, REFUND_PENDING , REFUND_FAILED
data.resultMsg	string	No	maxLength: 256	the reason of refund status，it only has a value when it fails
data.refundFinishTime	string	Yes		refund finish time

Response Example

{
  "code": "APPLY_SUCCESS",
  "msg": "",
  "data": {
    "outRefundNo": "R1642411016202",
    "refundTradeNo": "20220117091657TI790000055087",
    "totalAmount": 10000,
    "refundCurrency": "IDR",
    "outTradeNo": "P1642410680681",
    "status": "REFUND_SUCCESS",
    "refundFinishTime": "2023-10-20T03:28:23.092Z",
    "resultMsg": "Success"
  }
}

Enum Reference

data.status

• REFUND_SUCCESS
• REFUND_PENDING
• REFUND_FAILED