Order Cancellation Interface

Description

Merchants can cancel orders that have not been remitted through this interface. Please note that cancellations are not applicable for transactions where the currency is CNY.

Interface Endpoint

https://apis.geoswift.com/remittance/cancel

Name Type& Max Description Requirement
merchantId varchar(9) The unique identity of the merchant in Geoswift system. Merchant can log in the merchant operation and management system to check M
requestId varchar(50) The order cancel requestId is generated by the merchant and the requestId must be the only one on the merchant platform. When the order is canceled success or fail,merchant can’t submit request with the same requestId. M
remittanceRequestId varchar(50) The original remittance requestId M
proxyRequestId varchar(50) Extension requestId 1 O
merchantReference varchar(50) Extension requestId 2 O
remark varchar(200) remark O
partnerId varchar(9) The unique identifier of the secondary merchant under the main merchant in the Geoswift system.
Note: this parameter can be omitted if the initiating merchant is the main merchant.
C
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

Sample

{ "merchantId": "G90008001", "remittanceRequestId": "1651117930558", "requestId": "1651118067786", "hmac": "Jdajc8mMqY9p2Syyf5joaBam2S9PLD9InmJP+pLIaCpKn+BA/UNeXK+YhFrYoleS8PwzWUOSiDH7gKen8SHCF5v Ci5WEXdb3t7wThra9Feo1wb3ytg1oNiBcpdUpJDcsE9rfoGSlgc4YkWilB0ki7o0CB0U0/MxBiLrsevE1KiR4N324XaT5akm 381CbIJtNSkvi3x+UCFUh8aN84exgo5z+P38TQLSQd7eZAJ+LpHGWjfvMNOX8Y++CE2LQMXbNxN4OlZlYXmkbZYRb84iz+dzbP DhUfEmjyOghh1ejQPqGEWMIl3nIkVc1N/hSF4KIeGgv3JauqfNCWt9BcwCTEA==" }

Response Parameter Fields

Name Description
merchantId The same as the request parameter
requestId The same as the request parameter
remittanceRequestId The same as the request parameter
proxyRequestId The same as the request parameter
merchantReference The same as the request parameter
status SUCCESS
FAILED
ERROR
cancelStatus INIT
PROCESS
SUCCESS
FAILED
createDateTime The cancel request creation time
completeDateTime The cancel completion time
errorCode Error code,it will be returned when the cancelStatus is FAILED
errorMsg Error message,it will be returned when the cancelStatus is FAILED
remark remark
partnerId The same as the request parameter
hmac The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification"

Sample

{ "cancelStatus": "SUCCESS", "completeDateTime": "2022-04-28 11:54:39", "createDateTime": "2022-04-28 11:54:39", "hmac": "Jdajc8mMqY9p2Syyf5joaBam2S9PLD9InmJP+pLIaCpKn+BA/UNeXK+YhFrYoleS8PwzWUOSiD H7gKen8SHCF5vCi5WEXdb3t7wThra9Feo1wb3ytg1oNiBcpdUpJDcsE9rfoGSlgc4YkWilB0ki7o0CB0U 0/MxBiLrsevE1KiR4N324XaT5akm381CbIJtNSkvi3x+UCFUh8aN84exgo5z+P38TQLSQd7eZAJ+LpHGWjfv MNOX8Y++CE2LQMXbNxN4OlZlYXmkbZYRb84iz+dzbPDhUfEmjyOghh1ejQPqGEWMIl3nIkVc1N/hSF4KIeGg v3JauqfNCWt9BcwCTEA==", "merchantId": "G90008001", "merchantReference": "", "proxyRequestId": "", "remark": "", "remittanceRequestId": "1651117930558", "requestId": "1651118067786", "status": "SUCCESS" }