# 1.7 Repayment verification API
# Request URL (defined by merchant)
/xxx
# request method
- POST
# request params
parameter name | Is it mandatory | type of data | description |
---|---|---|---|
eventName | mandatory | string | Event name ( payment.verification ) |
mchOrderId | mandatory | string | Merchant Bill Payment Account mchOrderId |
referenceNumber | mandatory | string | Customer contract number |
amount | mandatory | int | Amount |
mobile | mandatory | string | Repayer's mobile phone number |
createTime | mandatory | string | Format yyyy-MM-dd HH:mm:ss, callback create time |
sign | mandatory | string | Sign |
# sign process refer to sign process (opens new window)
# request example
// Payment Collection Confirmation Callback
{
"eventName:"payment.verification",
"mchOrderId":"CCVA1653350151938813",
"referenceNumber":"PCLAC1000000001",
"amount":503700,
"mobile":"0912345678",
"createTime":"2022-05-31 09:38:06",
"sign": "xxxxxxxxxxxxx"
}
# success response example. (mean the repayment can be collected by PayCools)
{
"code": 2000,
"msg":"Success"
}
# failed response example. (mean the repayment can not be collected by PayCools)
general failed code 1000
{
"code": 1000,
"msg":"Failed"
}
param error failed code 1001, the field "msg" can be any string content.
{
"code": 1001,
"msg":"The reference number do not exist"
}
amount exceed limit failed code 1002
{
"code": 1002,
"msg":"The amount exceed limit"
}