Data Validation Interface

Description

This interface is used when calling remittance submission interface times out due to the large request data(5000+) , then it can be used to validate the documents for the remittance details in advance

Request Endpoint

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

Name Type & Max Description Requirement
merchantId varchar(9) Merchant ID M
detailPath varchar(200) The path used to upload remittance detail; The ftp relative path does not contain ‘/’ 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 M
creditedCurrency varchar(15) CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD M
singleReceiveAccount varchar true M
false
notifyUrl varchar(200) Once the verification is complete, PayEas will send two success notifications to the address the merchant sets via "notifyUrl", 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 refere to the section "Developers" M

Sample

{ "merchantId": "120141994", "requestId": "1528441526973", "detailPath": "test00001_20150311.xls", "creditedCurrency": "USD", "singleReceiveAccount": "true", "notifyUrl": "validateNotify", "hmac":null }

Synchronous Returned Field

Name Description
merchantId Merchant ID
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
serialNumber PayEase transaction serial number
creditedCurrency CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD
singleReceiveAccount true
false
status SUCCESS
FAIL
validateId The validation number returned by the "Data Validation Interface"; Used to request the "Remittance Submission Interface."
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac, please refer to the section "Developers"

Sample

{ "creditedCurrency": "USD", "validateId": "8a0be93c633eec9c0163b55bb2d42d73", "merchantId": "120140257", "requestId": "1527756058867", "hmac": "d9c980e5967cc81ccc6478392c7dfabc", "singleReceiveAccount": "True", "status": "SUCCESS" }

Asynchronous Return Fields

Name Description
merchantId Merchant ID
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
creditedCurrency CNY, USD, JPY, EUR, CHF, GBP, CAD, AUD, HKD
singleReceiveAccount true
false
status SUCCESS
FAIL
validateId The validation number returned by the "Data Validation Interface"; Used to request the "Remittance Submission Interface."
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac, please refer to the section "Developers"

If the remittance detail data validation completes and have the invalid remittance, PayEasy system will generate a file with the unqualified remittance details and put in FTP, file directory is "/transfer/details/errorfile /"; The file naming rule is "fail_ merchants upload file name. XLSX"; In the file, there will be a new column with the error cause being added to the last field of the file.

Sample

{ "creditedCurrency": "USD", "validateId": "8a0be93c633eec9c0163b55bb2d42d73", "merchantId": "120140257", "requestId": "1527756058867", "hmac": "d9c980e5967cc81ccc6478392c7dfabc", "singleReceiveAccount": "True", "status": "SUCCESS" }