PayEase Gateway Payment of Foreign Exchange Remittance Interface

Description

This interface is used for the merchant to make batch remit, in which multi-orders can be combined at once

Request Endpoint

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

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
originalRequestIds Array Original Request ID of foreign exchange purchase M
payee JSON Please refer to the table "Request Fields（payee）" 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
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

Request Fields（payee）

Name Type & Max Description Requirement
recName varchar(200) Receiver’s name M
accountNumber varchar(100) Receiver’s account number M
recAddress varchar(200) Receiver’s address O
countryCode varchar(3) Please refer to the section "Country List" M
ibanCode varchar(40) IBAN O
bankName varchar(200) Name of receiving bank M
swiftCode varchar(20) Receiving bank's SWIFT O
routingCode varchar(20) Routing Number O
bsbCode varchar(20) BSB Number O
bankAddress varchar(200) Receiving bank address O
postScript varchar(140) Remittance postScript O
proxyBankAccountNumber varchar(100) Bank Account Number on its agent bank O
proxyBankName varchar(200) Agent bank name of the receiving bank O
proxySwiftCode varchar(20) Agent bank's SWIFT of the receiving bank O
proxyBank Address varchar(200) Agent bank's address of the receiving bank O

Sample

{ "merchantId": "100000050", "requestId": "1528687520838", "originalRequestIds": ["1524555046860", "1524555046861"], "payee": { "recName": "name", "accountNumber": "1234567890", "recAddress": "123", "countryCode": "156", "ibanCode": "", "bankName": "中国工商银行", "swiftCode": "12345678", "routingCode": "", "bsbCode": "", "bankAddress": "", "postScript": "", "proxyBankAccountNumber": "", "proxyBankName": "", "proxySwiftCode": "", "proxyBankAddress": "" }, "notifyUrl": "notify", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax76 JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL 7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLT czfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq+gz0hvTq1dL w+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q==" }

Synchronous Returned Field

Name Description
merchantId Same as the request's parameters
requestId Same as the request's parameters
status SUCCESS (API request is successful)
ERROR
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": "1528687520838", "status": "SUCCESS", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax76 JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL 7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLT czfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq+gz0hvTq1dL w+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q==" }

Asynchronous Return Fields

Name Description
merchantId Same as the request's parameters
requestId Same as the request's parameters
serialNumber The order serial number of PayEase system
status SUCCESS
FAILED
amount Unit: China Fen, 1yuan =100 fe
currency Please refer to the section "Currency List"
completeDataTime Remittance 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", "amount": "10", "currency": "CNY", "completeDateTime": "2018-05-25 18:00:03", "status": "SUCCESS", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax76JG6ST pWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL7uQ3cTOaLA HOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLTczfe5DOxJHLGSMp inHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq+gz0hvTq1dLw+WygTVH8VPFN01bPVHQ jxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q==" }