PayEase Refund Application Interface

Description

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.

Request Endpoint

https://apis.5upay.com/icc/refund

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
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 request number and cannot repeat it. M
amount decimal(18) 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 see response mechanism) example: “https://www.5upay.com/callback.action? test=test”. 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) Remarks parameter will return along with payment status. O
hmac varchar(500) The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #. M

Sample

{ "merchantId": "888", "orderRequestId": "20190813-888-12345", "requestId ": "12345", "amount": "1.00", "remark": "备注", "notifyUrl": "http://qa.ehking.com/sdk/onlinepay/refundNotify", "hmac":' af291df5d288690d2b7d7bcff7dc5a74447ce1502c1edcc9293051bb6a517d68 6fbb31de72bfd14938d474fa6dd0afb82a2c222a6a345e41683d456a142e3376 c5c8f07dc5bc92dd5b09af316fa478a003189ed4d4c956d33162de11a8aec8ab 6abcf66b19833302780cffaa25c7e40bb9b2ccc59adc44e3fcb4632bce5d9cf9" }

Returned Fields

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
merchantId Same as the merchantId of the request parameter
orderRequestId Same as the requestId of the request parameter
requestId Same as the refundRequestId of the request parameter
bankNumber Bank Order ID
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, AUD is Australian dollars
refundSubmissionTime Time to submit rather than time to account. Format: yyyy-MM-dd HH:mm:ss
remark Same as the remark of the request parameter
hmac The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #.

Sample

{ "status": " SUCCESS ", "merchantId": "888", " orderRequestId ": "20190813-888-12345", "requestId": "12345", "bankNumber": "1234567", "refundId": "34565", "amount": "1.00", "currency": "CNY", "refundSubmissionTime": "2019-08-13 21:30:02", "remark": "test", "hmac": " af291df5d288690d2b7d7bcff7dc5a74447ce1502c1edcc9293051bb6a517d68 6fbb31de72bfd14938d474fa6dd0afb82a2c222a6a345e41683d456a142e3376 c5c8f07dc5bc92dd5b09af316fa478a003189ed4d4c956d33162de11a8aec8ab 6abcf66b19833302780cffaa25c7e40bb9b2ccc59adc44e3fcb4632bce5d9cf9", }

Asynchronous Return Fields

Note: the parameter of this form is the NotifyUrl server return parameter.

Name Description
merchantId Same as the merchantId of the request parameter
orderRequestId Same as the orderRequestId of the request parameter
requestId Same as 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, AUD is Australian dollars
refundSubmissionTime Format: yyyy-MM-dd HH:mm:ss
refundCompleteTime Format: yyyy-MM-dd HH:mm:ss
remark Same as the remark of the request parameter
hmac The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #.

Sample

{ "merchantId": "888", "orderRequestId": "20190813-888-123456", "requestId": "12345", "refundId": "816290053119947", "bankNumber": "3456789098", "refundStatus": "SUCCESS", "amount": "1.00", "currency": "CNY", "refundSubmissionTime": "2019-08-13 01:12:30", "refundCompleteTime": "2019-08-13 01:12:31", "remark": "test", "hmac": " af291df5d288690d2b7d7bcff7dc5a74447ce1502c1edcc9293051bb6a517d68 6fbb31de72bfd14938d474fa6dd0afb82a2c222a6a345e41683d456a142e3376 c5c8f07dc5bc92dd5b09af316fa478a003189ed4d4c956d33162de11a8aec8ab 6abcf66b19833302780cffaa25c7e40bb9b2ccc59adc44e3fcb4632bce5d9cf9", }