Merchant Submitting International Credit Card Interface (merchant to PayEase, required)

Description

This interface is used for merchant to request payment to PayEase assigned URL and receive redirected address to jumping bank page after choosing for international credit card on merchant side through https protocol.

Request Endpoint

https://apis.5upay.com/icc/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
orderAmount decimal(18) UNIT: Yuan. Keep 2 decimal places, for example 10.00 M
orderCurrency varchar(15) CNY is RMB, USD is US dollar, EUR is Euro, GBP is pound, JPY is yen, KRW is Korean dollar, RUB is rouble, CHF is Swiss franc, HKD is Hong Kong dollar, SGD is Singapore dollar, MOP is Macao dollar, CAD is Canadian dollars, NZD is New Zealand dollars, TWD is nt dollars, AUD is Australian dollars M
requestId varchar(50) Format is date(yyyymmdd)-merchant id-merchant flow number e.g.： 20170101-888-12345 The flow number is numeric, not repeated within 24 hours and only be number and “-”. It can be single or multiple. M
language varchar(50) Available values: M
tw Chinese traditional
zh Chinese simplified
es Spanish
en English
de German
fr French
ko Korean
ja Japanese
it Italian
ru Russian
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: “https://www.5upay.com/callback.actio n?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
callbackUrl varchar(200) Page callback: after successful payment, it will jump to this address.for example: “https://www.5upay.com/callback.action?test=test” M
projectId varchar(50) Merchants can distinguish order business types by project ID O
shipInfo Json Please refer to the table "Request Fields (shipinfo)" O
billInfo Json Please refer to the table "Request Fields (billinfo)" (If the 3D Vetification is being used by the merchant, then the"billlnfo" needs to be set as a mandatory field) C
terminalNo varchar(20) A website corresponds to a terminal number, no more than 20 digits M
remark varchar(300) Remarks parameter will return along with payment status. O
hmac varchar(500) The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #. M

Request Fields (shipinfo)

Name Type& Max Description Requirement
shipStreet String (300) the street of shipping address O
shipCity String (300) the city of shipping address O
shipState String (300) the state or province of shipping address(e.g.2 digits code for USA and Canada.The standard can refer to "state code") O
shipPost String (100) the post code of shipping address.It is mandatory for USA with 5 or 9 digits(like NNNNN or NNNNN-NNNN) and Canada with 6 digits(like ANA NAN) O
shipCountry String (20) the code of shipping country,can refer to 《country code》 O
shipPhone String (15) Shipping phone number O
shipEmail String (100) Shipping email O

Request Fields (billinfo)

Name Type& Max Description Requirement
billStreet String (300) the street of bill address C
billCity String (300) the city of bill address C
billState String (300) the state or province of bill address(e.g.2 digits code for USA and Canada.The standard can refer to "state code") C
billPost String (100) the post code of bill address.It is mandatory for USA with 5 or 9 digits(like NNNNN or NNNNN-NNNN) and Canada with 6 digits(like ANA NAN) C
billCountry String (20) the 3 digits code of bill country,can refer to "country code" C
billPhone String (15) bill phone number C
billEmail String (100) bill email C

Sample

{ "merchantId": "888", "orderAmount": "1.00", "orderCurrency": "CNY", "requestId": "20190813-888-123456", "notifyUrl": "http://www.baidu.com", "callbackUrl":" http://www.sina.com ", "terminalNo": "123456", "remark": "test", "hmac": "af291df5d288690d2b7e5d9cf9" }

Returned Fields

Note: you need to parse the parameters returned synchronously and jump redirect Url to the cashier

Name Description
status SUCCESS
ERROR
redirectUrl Status is SUCCESS, which is the address accessed by the user's browser.
merchantId Same as the merchantId of the request parameter
requestId Same as the requestId of the request parameter
hmac The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #.

Sample

{ "status": "SUCCESS", "redirectUrl ": "http://www.baidu.com.cn", "merchantId": "888", "requestId": "20190813-888-123456", "hmac": "af291df5d288690d2b7d7bcd9cf9" }

Synchronous Return Fields

Note: the parameter of this form is the CallbackUrl server return parameter,

Name Description
merchantId Same as the merchantId of the request parameter
requestId Same as the requestId of the request parameter
bankNumber Banck Order ID
serialNumber System transaction serial number
pstatus Payment status: INIT
SUCCESS
FAILED
PROCESSING
statusDescription See the table "payment status code"
orderAmount Same as the order amount of the request parameter
orderCurrency Same as the order currency of the request parameter
submissionTime Format: yyyy-MM-dd HH:mm:ss
completeTime Format: yyyy-MM-dd HH:mm:ss
paymentModeAlias The return value is VISA MASTER AE JCB
remark Same as the remark of the request parameter
hmac The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #.

Sample

{ "serialNumber": "8a8a8f5990d911960190d96a19d900fa", "orderCurrency": "CNY", "pstatus": "FAILED", "completeTime": "2024-07-22 15:50:32", "remark": "备注", "submissionTime": "2024-07-22 15:48:48", "statusDescription": "0008", "orderAmount": "1.00", "merchantId": "890002159", "requestId": "20240722-890002159-1721634527089", "hmac": "NEMt5VymXBNsZFxd/61hqCvSxPlXEYElcPFOPKP2XAQ6Z0ZdbLA==", "paymentModeAlias": "MASTER" }

Asynchronous Return Fields

Note: the parameter of this form is the NotifyUrl server return parameter,

Name Description
merchantId Same as the merchantId of the request parameter
requestId Same as the requestId of the request parameter
bankNumber Bank Order ID
serialNumber Payease System transaction serial number
orderCurrency Same as the order currency of the request parameter
orderAmount Same as the order amount of the request parameter
pstatus Payment status: SUCCESS
FAILED
pstatusDescription See the table "payment status code"
submissionTime Format: yyyy-MM-dd HH:mm:ss
completeTime Format: yyyy-MM-dd HH:mm:ss
paymentModeAlias The return value is VISA MASTER AE JCB
remark Same as the remark of the request parameter
status SUCCESS
ERROR
hmac The method for obtaining hmac is shown in "Developers," The parameter sequence is spliced from A-Z with the initials of key name, and The corresponding key values are separated by #.

Sample

{ "serialNumber": "8a8a8f5990d911960190d96a19d900fa", "orderCurrency": "CNY", "pstatus": "FAILED", "completeTime": "2024-07-22 15:50:32", "remark": "备注", "submissionTime": "2024-07-22 15:48:48", "pstatusDescription": "0008", "orderAmount": "1.00", "merchantId": "890002159", "requestId": "20240722-890002159-1721634527089", "hmac": "Py7KHhB5+6qnB6vtVZDygu0cu51YFGAw==", "paymentModeAlias": "MASTER", "status": "SUCCESS" }