Payment Review Submit Interface
Description
The merchant actively submits the review order information through Geoswift aggregate payment review submit interface, and informs the merchant of the review result asynchronously after the final status of review(success or refuse).
Request Endpoint
https://apis.geoswift.com/overseas/inspect/inspect
| Name |
Type& Max |
Description |
Requirement |
| merchantId |
varchar(9) |
The unique identity of the merchant ID in Geoswift system. |
M |
| partnerId |
varchar(9) |
The unique ID of the service provider in the Geoswift system |
C |
| serialNumber |
varchar(32) |
Relevant order mark refers to Merchant order ID.(the serial number generated after payment) |
M |
| inspectDetails |
Json |
Please refer to the table "Request Parameter Fields（inspectDetails，inspect details）" |
M |
| notifyUrl |
varchar(200) |
Server notification: After successful review, there would be a notification sent to the address which could be parameterized(the send mechanism reference to "Interface Rules"). Example: “https://www.geoswift.com/callback. action?test=test ” Note: Your server would not receive the notification of review result after submitting review if the parameter value of notifyUrl wasn’t filled in. |
M |
| refundUrl |
varchar(200) |
Server notification: When the review was refused and after successfully refunding, there would be a notification sent to the address which could be parameterized(the send mechanism reference to "Interface Rules"). Example: “https://www.geoswift.com/callback. action?test=test ” Note: Your server would not receive the notification of refund result after review was refused if the parameter value of refundUrl wasn’t filled in. |
C |
| remark |
varchar(300) |
Remarks parameter will return along with payment status. |
O |
| hmac |
varchar(500) |
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 |
The preceding parameter values cannot contain the following special characters: '" &<>()
Request Parameter Fields（inspectDetails，inspect details）
| Name |
Type& Max |
Description |
Requirement |
| type |
Fixed value |
P: Payer's ID(ID card, passport, etc.) |
M |
| S: Student ID(ID card, passport, etc.) |
| T: Invoice, admission letter, payment notice, air ticket, etc |
| O: Others |
| proofMessage |
varchar(50) |
/xxx/xxxx/xxx.JPG The path of the proof. The proof needs to be uploaded to SFTP in the directory of /report /cp/inspect.See "SFTP Connection Guide" for specific connection method. |
M |
Proof description:
Format：JPG, JPEG, PDF, PNG, DOC (except for overseas study paid by Alipay), DOCX (except for overseas study paid by Alipay) up to 10,each within 10MB.
The type of proof that studying abroad paid by Alipay must be P, S or T
Sample
<![CDATA[
{
"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=="
}
]]>
Synchronously Returned Parameter Fields Of Review Submitting
| Name |
Description |
| merchantId |
The unique identity of the merchant ID in Geoswift system. |
| partnerId |
The unique ID of the service provider in the Geoswift system |
| serialNumber |
Serial Number of the request in Geoswift's platform |
| status |
SUCCESS |
| FAILED |
| hmac |
The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |
Sample
<![CDATA[
{
"merchantId": "G90008005",
"serialNumber": "2c9980727a2e129e017a319cbfb20025",
"status": "SUCCESS",
"hmac": "jotr2gDb/Ih33gFNYaHsRkUZvKqGX8oKYo8K667kcnRg6CKSE1wwVUv8k1b/jeegikY2F
Zn1VAgyuLyj3smGgMlsHW+cbf7qNyPM+Xpq267Me5rKai271lhKHca4eBOztd0RJxrfBYjbLoyN5Cq
pg/Rw01z9w4q33j1WqcwGKEkpMKxTKlYukW65qvJtUoKrFtYUd1Z+PtloPPNUdV2L5+IfLyuJBdYvR
GFI2Ylq3ojt0wuAcWCmnkig7GmHGaYbUK6eBUvAp/YPwyguy727yqqZqs5zgGzkELqFqNsYjpz4Z/P
ib2lzo9c/vWKvWnzgEwPSm/C/JWZ9RDvJ8svl5w=="
}
]]>
Asynchronously Returned Parameter Fields Of Review Submitting
| Name |
Description |
| merchantId |
The unique identity of the merchant ID in Geoswift system |
| serialNumber |
The serial number of the original order in Geoswift's system. |
| inspectStatus |
SUCCESS |
| REFUSE |
| inspectRemark |
It will be returned only when the inspectStatus is REFUSE |
| isRefund |
true |
| false |
| It will be returned only when the inspectStatus is REFUSE |
| uploadTime |
Completion time |
| remark |
remark |
| hmac |
The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |
Sample
<![CDATA[
{
"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=="
}
]]>
Asynchronously Returned Parameter Fields Of Review Refund
| Name |
Description |
| merchantId |
The unique identity of the merchant ID in Geoswift system. |
| serialNumber |
The serial number of the original order in Geoswift's system |
| inspectStatus |
SUCCESS |
| REFUSE |
| inspectRemark |
It will be returned only when the inspectStatus is REFUSE |
| isRefund |
true |
| false |
| It will be returned only when the inspectStatus is REFUSE |
| uploadTime |
Completion time |
| remark |
remark |
| refundBankRequestNumber |
It is equal to the bankRequestNumber parameter returned by refund interface synchronously / asynchronously. Based on the product configuration, this parameter will be returned when the isRefund is true. |
| refundCompleteTime |
Refund completion time. Based on the product configuration, this parameter will be returned when the isRefund is true. |
| inspectRefundStatus |
COMPLETED |
| INCOMPLETE |
| NOT_NEED |
| hmac |
The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |