Order submission interface

Description

This interface is used when the merchant end selects the payment method as "International Bank Wire Transfer"; After requesting this interface, the merchant will receive the related order status result and the beneficiary account information for the wire transfer from PayEase system synchronously; The Merchant then need to present the beneficiary account information to the consumer and the guide consumer to complete the bank wire transfer.

Request Endpoint

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

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 background to check M
amount decimal(18) UNIT: China fen，1 Yuan=100 Fen M
currency varchar(3) USD, HKD, JPY, GBP, SGD, CAD, AUD, EUR, SEK, NOK, DKK, MOP, CHF 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
forUse varchar(50) Value: GOODSTRADE 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:“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) Merchant remarks the order; this remark will be returned to the merchant via asynchronized callback. O
paymentModeCode varchar(50) Value: FOREIGN-FOREX-ECITIC-P2P C
productDetails JSON Please refer to the table "Request Fields (productDetails，product details)"; SA maximum of 50 items of product information data can be uploaded M
payer JSON Please refer to the table "Request Fields (payer，payer information)" M
timeout varchar(10) Used to set the timeout period of an order(Unit: hour; Maximum:168) E.g. fill in 24: the order is due at 24 hours. O
hmac - The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to "Geoswift encryption and decryption process specification" M

Request Fields (productDetails，product details)

Name Type & Max Description Requirement
requestId varchar(50) The transaction number, which will be reported to the State Administration of Foreign Exchange. M
name varchar(200) Porduct Name M
quantity long Porduct quantity M
amount long Porduct amount; Unit: Cent, E.g. 1 dollor = 100 cents M
receiver varchar(200) Payee name (if it is empty, the system will automatically take the merchant's registered name on PayEase M
idType varchar(2) 01: Identity card C
02: Social credit unified code
idNum varchar(18) The payee's ID number C
phoneNum varchar(20) The payee's phone number C
bankCardNum varchar(20) The payee's bank card number C
areaCode varchar(6) Please refer to the section of the "Area Code List" C
attrCode varchar(3) Please refer to the section of the "Economy Type" O
logisticsNumber varchar(120) Logistics tracking number O
logisticsCompany varchar(200) Logistics company O
invoiceNumber varchar(35) invoiceNumber O
contractNumber varchar(20) contract Number O
platformName varchar(50) Platform Name M
tradeTime varchar(50) format: YYYY-MM-DD HH:MM:SS M

Request Fields (payer，payer information)

Name Type & Max Description Requirement
name varchar(100) Payer name M
bankName varchar(100) The payer's bank name O
bankCardNum varchar(32) The payer's bank account number of the wire transfer or bank card number O
nationality varchar(3) Please refer to the section "Country Code" M

Sample

{ "merchantId":"896667346", "amount":10000, "currency":"USD", "requestId":"1621307590890", "forUse":"GOODSTRADE", "notifyUrl":"https://qa-sdk.5upay.com/foreignpayExchangesettlement/v3/foreignpayExchangesettl ement/v3/notify", "remark":"remark", "paymentModeCode":"FOREIGN-FOREX-ECITIC-P2P", "productDetails":[{ "requestId":"1621307590908", "name":"苹果", "quantity":1, "amount":10000, "receiver":"张**", "idType":"01", "idNum":"132***287X", "phoneNum":"158***2988", "bankCardNum":"623***8472", "areaCode":"310101", "attrCode":"175", "logisticsNumber":"100001", "logisticsCompany":"邮政", "invoiceNumber":"100011", "contractNumber":"100011", "platformName":"XXX平台", "tradeTime":"2022-01-01 00:00:00" }], "payer":{ "bankCardNum":"621***9992", "bankName":"平安银行", "name":"付款一", "nationality":"840"}, "timeout":168, "hmac":"lmPWwKtxbVTHFNS008tibpPAQFZD5wbd7wGXdAiC/5Y+tmu/S7Zyzf3kmD+aPyqXwCof5wyzY/QKWBCgUB1lyg64 sqHqnvgjdOxigMY69l3UuwFa/elq8g0OmFQzMJBH9DHlQ3xr4aFPeA2pyVS6QavVq1hiw6AK+vAR9SVaQ5cKLws3aTBjd5tR nnzN63U03+gNiicF8Z+6D0Mce/YHmFGCe+o5pgdBryiW0wtzkIvN7E7arjnYl9JerlttUhKt9oup2Wv7Hiw0Ve4Pa81Xku03 /HYO0M6bCOEXud7SlnvmTMRyp5lLQKPis3Svne+mxFX8es8Ne72CMmoxuD0bqA==" }

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 background 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"
FAILED
ERROR
errorMessage The cause of the error
payee The beneficiary account info of the international bank wire transfer; Please refer to the table "Response Fields (payee，The beneficiary account info of the international bank wire transfer)"
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to "Geoswift encryption and decryption process specification"

Response Fields (payee，The beneficiary account info of the international bank wire transfer)

Name Description
payeeAccountNumber PayEase excess reserve account; Accounts are different in different currencies
payeeName PayEase excess reserve account name; E.g. PAYEASE(BEIJING)TECHNOLOGY LTD.
payeeCountry Recipient's resident country (region)
payeeAddr Recipient's address
payeeCurrency The currency of the receiving account
payeeBankName Recipient's bank
payeeBankSwift Recipient's bank swift code
payeeBankAddr Recipient's bank address
postscript PayEase generates a unique number according to the order. When the buyer makes the offline bank wire transfer, the buyer needs to fill in this number in the bank remittance postscript

Sample

{ "merchantId":"896667346", "requestId":"1621307590890", "status":"SUCCESS", "payee":{ "payeeAccountNumber":"8110714014301310205", "payeeAddr":"Room 601-604,620-626,Foreign Trade Building,22 Fuchengmenwai RD., Xicheng District,Beijing 100037", "payeeBankAddr":"NO.27 FINANCIAL STREET,XICHENG DISTRICT,BEIJING,CHINA", "payeeBankName":"China CITIC Bank H.O. General Banking,Beijing,China", "payeeBankSwift":"CIBKCNBJ100", "payeeCountry":"China", "payeeCurrency":"USD", "payeeName":"PAYEASE(BEIJING)TECHNOLOGY LTD.", "postscript":"2105181118274418" }, "hmac":"CfFsb10d9/gaOGsi8B9OY0hkFHZBgKoKg6X++7+PBO/WMqlREPUY3cXSsg QgwUBe535RtBnpEac2oCUds0ao9cEnO2fL9U5YJaOEdxECZiY6W7hFgfgRMW8rvP9d KJDbksiHRWuzkcTHyO0Eo0WptYyBeExr4P5ar5iR9jygK13+7UuLHG+U6s6WBYE2tQV EZq0c2Qf/G5qJ3nxRExNfjdLamX/8eGZld8NhstZ6ILADIoBo200dGyXBo2mpZsFSsd4t/Rl EgBB4z4FtVZzJwCbfUqsSon8aGFzXfQOX+436PUwPI2qbZRo+t7D3wrlT3BFJeENeQD s+wnXp8JJzaw==" }

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
remark Merchant remarks the order; this remark will be returned to the merchant via asynchronized callback.
foreignExchange Please refer to the table "Response fields（foexignExchangeResponse，Return parameter of foreign exchange purchase）"
paymentModeAlias Value: FOREIGN-FOREX-ECITIC-P2P
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to "Geoswift encryption and decryption process specification"

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

Name Description
amount UNIT: Cent，1 dollar =100 cents
currency Default: CNY
status SUCCESS
FAILED
ERROR
listprice list price
completeDateTime The completion time of foreign exchange purchase

Sample

{ "merchantId":"896667346", "requestId":"1621231101606", "serialNumber":"2c998071796f8e6c017978e7ab7d0027", "currency":"USD", "amount":"1000311", "remark":"remark", "foreignExchange":{ "amount":"6926453", "completeDateTime":"2021-05-17 14:01:22", "currency":"CNY", "listprice":"692.430000", "status":"SUCCESS" }, "paymentModeAlias":"FOREIGN-FOREX-ECITIC-P2P", "hmac":"M+OG5ePfsvfcn4LCm8K12BZ1FqvAT3y2V36sv99AqPiOGPIzVN8QTryyB9ok mcjnHfyZYk+AYhcItQsDHNwhUg3EGc7MgJS0F7aOOPHShF0aW3/l/299PD6V1zBm2Pz /Y1BrrL6ohR1fURVdvKw40m5HOT9xPU8LmnOepJSJ4+8AVzifa2YTmphQZ/n7Mw2+Z6 ASz7JiXoJ5Zl49bJfXTkB5DUdw12YNAk7r8HepxTnvL4TphIpsyXk8pZc+jXuFTNDhjS65n 8fN+v6T+mrscoqPhfJN9+r5MELmz/mzWDOEljDVonffqS/ytI4c26h9S9nujgsywvryoqmv2f xyJQ==" }