Submitting the refund application interface for merchant terminal through the application interface program, to achieve the business process to submit the refund application, payease platform through JSON format return refund application submitted by the results of response. The operation function and existing payease merchant management platform to enter the refund application function of the same.
https://apis.5upay.com/icc/refund
| Name | Type& Max | Description | Requirement |
|---|---|---|---|
| merchantId | varchar(9) | The unique identity of the merchant ID in Payease system, After the merchant completes Payease system registration, the merchant can log in the merchant background to check | M |
| orderRequestId | varchar(80) | Format is date(yyyymmdd)-merchant id-merchant flow number e.g.： 20170101-888-12345 The flow number is numeric, not repeated within 24 hours and only be number and “-”. It can be single or multiple. | M |
| requestId | varchar(50) | the merchant can customize the refund request number and cannot repeat it. | M |
| amount | decimal(18) | The refund amount | M |
| notifyUrl | varchar(200) | Server notification： Successful notification will be sent to the address after payment is successful. This address can take parameters(Send mechanism Refer to response mechanism) example: “www.5upay.com/callback.action?test=te st”. Note: if the parameter value of notifyUrl is not filled, your server will not receive the notice of successful payment after payment is successful. | M |
| remark | varchar(300) | remark | O |
| hmac | varchar(500) | For the method of obtaining hmac, please refer to "Encrytion/Decryption Specification"，The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #. | M |
Note: Only when the response processing is normal, the status parameter value is SUCCESS, the message includes merchant number, order number and other information.
| Name | Description |
|---|---|
| status | SUCCESS |
| ERROR Refer to error list | |
| merchantId | The unique identity of the merchant ID in Payease system, After the merchant completes Payease system registration, the merchant can log in the merchant background to check |
| orderRequestId | Refer to the orderRequestId of the request parameter |
| requestId | Refer to the requestId of the request parameter |
| bankNumber | Refund bank number |
| refundId | Refund ID |
| amount | Refund amount |
| currency | CNY is RMB, USD is US dollar, EUR is Euro, GBP is pound, JPY is yen, KRW is Korean dollar, RUB is rouble, CHF is Swiss franc, HKD is Hong Kong dollar, SGD is Singapore dollar, MOP is Macao dollar, CAD is Canadian dollars, NZD is New Zealand dollars, TWD is nt dollars |
| refundSubmissionTime | Format: yyyy-MM-dd HH:mm:ss |
| remark | remark |
| hmac | For the method of obtaining hmac, please refer to "Encrytion/Decryption Specification"，The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by # . |
Note: the parameter of this form is the NotifyUrl server return parameter
| Name | Description |
|---|---|
| merchantId | The unique identity of the merchant ID in Payease system, After the merchant completes Payease system registration, the merchant can log in the merchant background to check |
| orderRequestId | Refer to the orderRequestId of the request parameter |
| requestId | Refer to the requestId of the request parameter |
| refundId | Refund Id |
| bankNumber | Refund bank number |
| refundStatus | SUCCESS |
| FAILED | |
| amount | Refund amount |
| currency | CNY is RMB, USD is US dollar, EUR is Euro, GBP is pound, JPY is yen, KRW is Korean dollar, RUB is rouble, CHF is Swiss franc, HKD is Hong Kong dollar, SGD is Singapore dollar, MOP is Macao dollar, CAD is Canadian dollars, NZD is New Zealand dollars, TWD is nt dollars |
| refundSubmissionTime | Format: yyyy-MM-dd HH:mm:ss |
| refundCompleteTime | Format: yyyy-MM-dd HH:mm:ss |
| remark | remark |
| hmac | For the method of obtaining hmac, please refer to "Encrytion/Decryption Specification"，The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by # . |