核查提交接口
功能概述
商户通过汇元通杰易收核查提交接口主动提交核查订单信息,核查终态(核查通过、核查不通过)后,异步通知商户核查结果。
接口地址
https://apis.geoswift.com/overseas/inspect/inspect
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| merchantId |
商户编号 |
varchar(9) |
商户编号 |
M |
| partnerId |
服务商 ID |
varchar(9) |
服务商编号 |
C |
| serialNumber |
原交易流水号 |
varchar(32) |
商户订单号在汇元通所对应的订单流水标识(支付完成后的 serialnumber) |
M |
| inspectDetails |
凭证信息 |
Json |
见凭证信息表 |
M |
| notifyUrl |
通知地址 |
varchar(200) |
服务器通知:核查结束后会向该地址发送核查结果通知,该地址可以带参数,如: “https://www.geoswift.com/callback.action?test=test”. 注意:如不填 notifyUrl 的参数值核查结束后您的服务器将得不到核查结果的通知 |
M |
| refundUrl |
核查拒绝退款的异步通知地址 |
varchar(200) |
服务器通知:核查拒绝退款后会向该地址发送结果通知,该地址可以带参数(发送机制见应答机制),如: “https://www.geoswift.com/callback.action?test=test”.注意:如不传refundUrl的值核查拒绝退款后您的服务器将得不到结果通知。 |
C |
| remark |
备注 |
varchar(300) |
商户在汇元通为订单进行备注,通过支付结果返回商户 |
O |
| hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
M |
以上参数值中不能包含以下特殊字符’”&<>()
请求参数(inspectDetails,凭证信息)
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| type |
凭证类型 |
固定值 |
P 付款人证件(身份证、护照等) |
M |
| S 学生证件(身份证、护照等) |
| T 发票、录取通知书、缴费通知单、机票等 |
| O 其他 |
| proofMessage |
凭证路径 |
varchar(50) |
/xxx/xxxx/xxx.jpg需要将凭证上传至 sftp,上传核查凭证需要在/report/cp/inspect目录下 |
M |
凭证说明:
格式:JPG、JPEG、PDF、PNG、DOC(非支付宝留学)、DOCX(非支付宝留学)最多10个,每个10MB以内。
支付宝留学必须上传的凭证类型为 P、S、T。
参数示例
{
"inspectDetails": [{
"proofMessage": "/inspect/overseas/1.png",
"type": "P"
}],
"merchantId": "G90008005",
"notifyUrl": "https://qa-sdk-v2.geoswift.com/inspect/notify",
"remark": "123",
"serialNumber": "2c9980727a2c6c68017a2dcb60c90082",
"hmac": "dvA96S8r89F3TtfC9N2UoD7Ruy0kwleF2p140NpD5DENHF6qquedqLvdXVi7Z69eL/mY
HLS0F9XaUc8NVAndl+VkewhCIjrIR7XfqWff76UnAC8fOJFeeMOrjMMhxy3UDjiaIOBED+gwYRy8I
Nlr1FJ0JAltvyLnhlJW5igH/rZdTtyWlJRdBbu0feWjwuj8s+naNzAXlFK1yaj636wg9/laMzHW/p
wekhsifaklX0xFS8+LQFEAe4N0Y4ze8MBqRMTCeM+tYgjhyNEsDudXpN/fjbQmnKZ6sx61b2rhSHL
jzBZ0t+enh6OkdievG4R1n04pv74Y4egq6JgM5jrxqg=="
}
核查提交请求同步返回参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
商户在汇元通系统的唯一身份标识,商户完成汇元通系统注册后可登录商户后台商户服务查看。 |
| partnerId |
服务商ID |
服务商编号 |
| serialNumber |
原交易流水号 |
汇元通系统交易流水号 |
| status |
请求状态 |
SUCCESS 成功 |
| FAILED 失败 |
| hmac |
参数签名 |
汇元通生成的参数签名结果,验签过程请参考解密流程 |
示例
{
"merchantId": "G90008005",
"serialNumber": "2c9980727a2e129e017a319cbfb20025",
"status": "SUCCESS",
"hmac": "jotr2gDb/Ih33gFNYaHsRkUZvKqGX8oKYo8K667kcnRg6CKSE1wwVUv8k1b/jeegikY2F
Zn1VAgyuLyj3smGgMlsHW+cbf7qNyPM+Xpq267Me5rKai271lhKHca4eBOztd0RJxrfBYjbLoyN5Cq
pg/Rw01z9w4q33j1WqcwGKEkpMKxTKlYukW65qvJtUoKrFtYUd1Z+PtloPPNUdV2L5+IfLyuJBdYvR
GFI2Ylq3ojt0wuAcWCmnkig7GmHGaYbUK6eBUvAp/YPwyguy727yqqZqs5zgGzkELqFqNsYjpz4Z/P
ib2lzo9c/vWKvWnzgEwPSm/C/JWZ9RDvJ8svl5w=="
}
核查提交异步返回参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
商户编号 |
| serialNumber |
原交易流水号 |
原交易流水号 |
| inspectStatus |
核查结果 |
SUCCESS 核查通过 |
| REFUSE 核查不通过 |
| inspectRemark |
核查结果说明 |
核查不通过才会返回 |
| isRefund |
核查退款 |
true 是 |
| false 否 |
| 核查不通过才会返回 |
| uploadTime |
完成时间 |
完成时间 |
| remark |
备注 |
备注 |
| hmac |
参数签名 |
汇元通生成的参数签名结果,验签过程请参考解密流程 |
示例
{
"inspectStatus": "SUCCESS",
"merchantId": "G90008005",
"serialNumber": "2c9980727a2e129e017a319cbfb20025",
"status": "SUCCESS",
"uploadTime": "2021-06-22 10:49:19",
"hmac": "suawPxpRfd60f4aUdbDvUSQ15mh1UG5ftGA7CAJu5/PGOgRjJcdpavnuH4cG5sqa9VZ6dI
ALbuQHkrVGia41wF6mppqvJM450PqXzMKyiid9jPpiCCvhegeSIehN1toKvVAS3alZXeWjIHVqEPmkF
sDfdn5RrUS4t0IhUGuv66R4SUoLKG01LowoaFXCoLBAfmwOj8qPnQMqDoFszgJMtAMI9ML8fES/c6mS
gLlrEC9AdW/z1Oa/XgM6XScOaaN0KHxm+embvWGQ/eUY+QnF/DcsWNqp3ysvuQ9ZrooBl/MxHavAPMu
xr4tAfejHaFY//iIt7tlzo+pBn1rS5FPuJw=="
}