Refund Interface

Description

This interface can be used for refund, Payease return refund results by the way of the JSON format

Request Endpoint

https://apis.5upay.com/foreignExchange/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 backend portal to check M
requestId varchar(50) The order number is generated by the merchant and the order number must be unique on the platform transaction. Request/order which had been paid or canceled in Payease's platform can't be submitted with same request ID. M
amount varchar(18) Unit: China Fen, 1yuan =100 f M
orderId varchar(32) Merchant order number; It is the corresponding transaction serial number in PayEase, which is the "serialNumber" after payment completion. M
notifyUrl varchar(200) Server notification：Successful notification will be sent to the address after payment is successful.This address can take parameters，example:“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 made by the merchant on PayEase for the order; It will be returned to the merchant through a refund O
hmac varchar(500) The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers" M

Sample

{ "merchantId": "100000050", "requestId": "1528447216658", "amount": "1", "orderId": "ba3567eef3f743b2a5282c37b6250bb9", "remark": "备注", "notifyUrl": "http://qa.upay.com/sdk/foreignexchange/refundNotify", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07 M3ax76JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPiox LN8Ras9J9zkL7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+Zp gLYDXTULrBY7OQ7cLTczfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV 9NsRsGc0pNXZq+gz0hvTq1dLw+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExX tSNCevRrAjyyRi4Q==" }

Synchronous Returned Field

Name Description
merchantId Same as the request's parameters
requestId Same as the request's parameters
serialNumber Serial Number of the request in Payease's system
status SUCCESS(This "SUCCESS" only indicates that the request is successful but not refund process is "SUCCESS")
FAILED
amount Unit: China Fen, 1yuan =100 fe
currency Please refer to the section "Currecy List"
completeDateTime Refund completion time
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers"

Sample

{ "merchantId": "100000050", "requestId": "1506333222530", "serialNumber": "8a7df26c5e74e383015eb87509ab3b4a", "orderId": "525b756c0800450b9286fbfd297fdb95", "amount": "10", "currency": "CNY", "completeDateTime": "2017-09-25 18:00:03", "status": "SUCCESS", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Z yi9s16uvSRmj07M3ax76JG6STpWc/kyb36mWmg8X8gduvd39NupWK/ zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL7uQ3cTOaLAHOeAQ h7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ 7cLTczfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9 NsRsGc0pNXZq+gz0hvTq1dLw+WygTVH8VPFN01bPVHQjxJd3M041kE 9ABF/vAP1ExXtSNCevRrAjyyRi4Q==" }

Asynchronous Return Fields

Name Description
merchantId Same as the request's parameters
requestId Same as the request's parameters
serialNumber The refund serial number of PayEase system
orderId Original order serial number
status SUCCESS
FAILED
amount Unit: China Fen, 1yuan =100 fe
currency Please refer to the section "Currency List"
completeDateTime Refund completion time
errorCode error Code
errorMessage Error Message
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers"

Sample

{ "merchantId": "100000050", "requestId": "1506333222530", "serialNumber": "8a7df26c5e74e383015eb87509ab3b4a", "orderId": "525b756c0800450b9286fbfd297fdb95", "amount": "10", "currency": "CNY", "completeDateTime": "2017-09-25 18:00:03", "status": "SUCCESS", "hmac": "YYSJXAyOHjV0kMzPruyuwYgebVecsJiG9/90OM1ugT5HKJh m2w5A+qQOCZzcNmk7JKz4nC398B/FrTMcAGX3ECEMpeJiNNxHNoRQkTF zI6etFI7ZuxRhFSBgYMmBNUdwq4Y/o8iOXRQnDuHxqHtNwJvrhM8OuHy zVcGBLeua8afPJlto9mQYjiq4oIfT4JmJPqnWaBZCjr+akJWXOtFG2Tk YAQg/43zdy9mTpaZHl+OjO7hU2tSL0pqZ3SBBYtZBeuIlwUFf17Wxee7 0ldY0cLLg/jhY3crw7HcJOggatH7acFqmfueLW2EqrkDkdQkHbWUmGzt eRxGlsUEMenoHrA== " }