Remittance submission interface

Description

The function of this interface is to directly initiate cross-border remittance through API without the merchant backend portal involved. Merchants can integrate this interface into their own operation platform so that the operation personnel can directly initiate each remittance.

Request Endpoint

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

Name Type & Max Description Requirement
merchantId varchar(20) Merchant Id M
requestId varchar(50) The requestId is an ID generated by the merchant. This ID is unique for each merchant and can be used for ensuring the uniqueness of the request；For paid or cancelled orders in the PayEase payment system, the merchant side cannot submit them again. M
amount decimal(18) UNIT: Cent，for CNY: 1 Yuan=100 Fen M
currency varchar(15) CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD M
creditedCurrency varchar(15) Currency expected to be received: CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD M
transferMode varchar Mode includes "DETAIL" M
DETAIL Remittance details
transferBusinessType Fixed value STUDYABROAD M
GOODSTRADE
PLANETICKET
HOTELACCOMMODATION
SOFTWARE
TRAVEL
LOGISTICS
OTHER
singleReceiveAccount varchar Values: true/false M
isMerger varchar Whether merge receiving accounts; Values: true/false M
detailPath varchar(200) Path used to upload the files for remittance detail; For the file template, see "Transaction detail template.xlsx. The file needs to be uploaded to ftp M
listpriceToken varchar(32) See the filed “serialNumber” on the Price Lock Interface. If no value is passed to this field, the system automatically obtains the real-time price O
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
payee JSON Please refer to the table "Request Fields (payee，Remittance Information)" C
validateId varchar(200) This is the parameter returned by calling the "Data validation interface", which is used when initiating a large volume (500 +) detail remittance 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

Request Fields (payee，Remittance Information)

Note: If it is a single account reittance, it is needed to fill in "accountNumber"

Name Type & Max Description Requirement
recName varchar(50) Receiver Name M
accountNumber varchar(50) Receiver account M
recAddress varchar(200) Receiver Address C
countryCode varchar(3) Country Code M
ibanCode varchar IBAN O
bankName varchar Receiving bank name M
swiftCode varchar The receiving bank SWIFT code; The receiving bank SWIFT and the receiving bank address cannot be empty mutually C
routingCode varchar Routing Number O
bsbCode varchar BSB Number O
bankAddress varchar The receiving bank address; The receiving bank SWIFT and the receiving bank address cannot be empty mutually C
postScript varchar(140) Remittance Information O
proxyBankAccountNumber varchar The receiving bank's account number in the agent bank O
proxyBankName varchar Proxy Bank Name O
proxySwiftCode varchar Proxy Swift Code O
proxyBankAddress varchar Proxy BankAddress O

Sample

{ "amount": "100", "isMerger": "false", "contractPath": "", "creditedCurrency": "USD", "currency": "CNY", "detailPath": "test00001_20180311.xls", "listPriceToken": "", "merchantId": "120141994", "notifyUrl": "notify", "payee": { "recName": "name", "accountNumber": "1234567890", "recAddress": "123", "countryCode": "156" "bankName": "中国工商银行", "swiftCode": "12345678" }, "requestId": "1528438523950", "singleReceiveAccount": "true", "transferMode": "DETAIL", "hmac": null }

Synchronous Returned Field

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 backend portal to check
requestId The requestId is an ID generated by the merchant. This ID is unique for each merchant and can be used for ensuring the uniqueness of the request；For paid or cancelled orders in the PayEase payment system, the merchant side cannot submit them again.
status SUCCESS, "The request was received"
FAILE
ERROR
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac, please refer to the section "Developers"

Sample

{ "merchantId": "120141994", "requestId": "1527746602492", "hmac": "959e138ad2e290328e8d59fd124c618f", "status": "SUCCESS" }

Asynchronous Return Fields

Name Description
merchantId merchantId
requestId The requestId is an ID generated by the merchant. This ID is unique for each merchant and can be used for ensuring the uniqueness of the request；For paid or cancelled orders in the PayEase payment system, the merchant side cannot submit them again
serialNumber PayEase system transaction serial number
currency CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD
amount UNIT: Cent，for CNY: 1 Yuan=100 Fen
status SUCCESS
CANCEL
completeDataTime Remittance completion time
foexignExchangeResponse Please refer to the table "Response fields（foexignExchangeResponse，Return parameter of foreign exchange purchase）"
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac, please refer to the section "Developers"

Response fields（foexignExchangeResponse，Return parameter of foreign exchange purchase）

Name ype & Max Description
amount decimal(18) UNIT: Cent，for CNY: 1 Yuan=100 Fen
currency varchar(15) CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD
status varchar(10) SUCCESS
CANCEL
listprice varchar(32) listprice
deductionAmount decimal(18) The CNY amount deducted from foreign exchange purchases
completeDataTime varchar(20) The completion time of foreign exchange purchase

Sample

{ "merchantId": "120141994", "requestId": "1493799454674", "serialNumber": "2ae9fe97b3fb4f5ab85effb7ba4461ca", "currency": "CNY", "amount": "70", "completeDateTime": "2018-05-04 14:11:23", "foexignExchangeResponse": { "amount": 10, "currency": "USD", "status": "INIT", "deductionAmount": 65, "completeDataTime": "2018-05-05 10:56:32" }, "status": "SUCCESS", "hmac": null }