Query Interface

Description

This interface is used for merchants to query the status of the gateway payment of foreign exchange order

Request Endpoint

https://apis.5upay.com/foreignExchange/query

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
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": "1493799454674", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi 9s16uvSRmj07M3ax76JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJEr bgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL7uQ3cTOaLAHOeAQh7Aps3E FJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLTczfe5D OxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq +gz0hvTq1dLw+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExXtSN CevRrAjyyRi4Q==" }

Response Fields

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
totalRefundCount total Refund Count
totalRefundAmount total Refund Amount
orderCurrency Please refer to the section "Currency List"
orderAmount Transaction amount，Unit: Fen
remark Remark information submitted when placing the order via submit interface
payment Please refer to the table "Response Fields（payment）"， Note： this parameter is returned after the successful payment
foreignExchange Please refer to the table "Response Fields（foreignExchange）"， Note： this parameter is returned after the successful paymen
clearingOrg NUCC Clearing institution( Network )
UNION_PAY Clearing institution (UnionPay
paymentModeAlias B2C "Personal Internet Banking
B2B "Enterprise Internet Banking
UNION_SCANCODE_PAY "UnionPay scan code"
EXPRESS_PAY "Express Payment"
CREDIT_EXPRESS_PAY "Credit Card Express payment
DEBIT_EXPRESS_PAY "Debit Card Express payment"
ALI_SCANCODE_PAY "Alipay scan code payment"
WEIXIN_SCANCODE_PAY "Wechat scan code payment"
WEIXIN_OFFICIAL_PAY " WeChat Subscription Payment"
APPLE_PAY "Apple Pay"
ALIPAY_WAP_PAY "Alipay payment on mobile's web page
APP_ALIPAY "Alipay APP payment"
OFFLINE-P2P "Offline bank remittance"
realBankSerialNumber Bank Serial Number
needReview true; false
reviewStatus INIT waiting for uploading
UPLOADED waiting for reviewing
CANCEL Cancel
SUCCESS review passed
REFUSE Rejected after review
reviewRemark Returned when review/audit rejected
subOrders Sub-order, please refer to "Response Fields(subOrders)"
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers"

Response Fields（payment）

Name Description
amount Unit: China Fen, 1yuan =100 fen
currency Please refer to the section "Currency List"
status SUCCESS
FAILED
ERROR
completeDateTime Payment completion time
bindCardId Unique ID of card binding information returned by PayEase

Response Fields（foreignExchange）

Name Description
amount Unit: China Fen, 1yuan =100 fe
currency Please refer to the section "Currecy List"
status SUCCESS
FAILED
ERROR
listprice listprice
deductionAmount Unit: China Fen, 1yuan =100 fe
completeDate Time Completion time of foreign exchange purchase

Response Fields(subOrders)

Parameter Name Description
requestId Sub-order number
orderAmount Sub-order amount, in cents
serialNumber Sub-order Serial Number

Sample

{ "merchantId": "100000050", "requestId": "1487151097417", "serialNumber": "ba3567eef3f743b2a5282c37b6250bb9", "totalRefundCount": "0", "totalRefundAmount": "0", "orderCurrency": "CNY", "orderAmount": "100", "remark": " 备 注 ", "payment": { "amount": "100", "currency": "CNY", "status": "SUCCESS", "completeDateTime": "2018-05-15 17:40:07" }, "foreignExchange": { "amount": "10", "currency": "USD", "status": "SUCCESS", "listprice": "68916", "deductionAmount": "69", "completeDateTime": "2018-05-15 17:59:31" }, "hmac":"UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax 76JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9 J9zkL7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrB Y7OQ7cLTczfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq +gz0hvTq1dLw+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q==" }