Merchant submit refund request through the refund interface. The interface function is the same as existing Geoswift’s merchant background refund application.
https://apis.geoswift.com/cp/refund
| 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 |
| requestId | varchar(50) | The order number is generated by the merchant, the order number must be the unique on the transaction platform. Request/order which had been paid or canceled in Geoswift's platform can’t be submitted with the same request ID. | M |
| refundAmount | varchar(18) | When the refund currency is JPY, KRW or VND, the unit of refundAmount is Yuan, the unit of other currencies is China Fen, 1 Yuan = 100 Fen | M |
| orderId | varchar(32) | The serial number of the original payment order.(After successful payment,the serialNumber parameter returned by the order submit or query interface) | M |
| notifyUrl | varchar(200) | Server notification: After successful refund, 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 successfully after completing refund if the parameter value of notifyUrl wasn’t filled in. | M |
| 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: '" &<>()
| 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 |
| requestId | The order number is generated by the merchant, the order number must be the unique on the transaction platform. Request/order which had been paid or canceled in Geoswift's platform can’t be submitted with the same request ID. |
| serialNumber | Serial Number of the request in Geoswift's platform |
| bankRequestNumber | bank's serial number |
| amount | Refund amount, when the currency is JPY, KRW or VND, the unit of amount is Yuan, the unit of other currencies is China Fen, 1 Yuan = 100 Fen |
| currency | Refund currency; Reference to the currency list table in the appendix |
| status | SUCCESS(This status represents the request has been successfully submitted to Geoswift rather than successful in refund) |
| AILED | |
| ERROR | |
| remark | |
| errorMessage | Error message |
| hmac | The result of parameter signature, generated by Geoswift. For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |
| Name | Description |
|---|---|
| merchantId | The unique identity of the merchant ID in Geoswift system. |
| requestId | The order number is generated by the merchant, the order number must be the unique on the transaction platform. Request/order which had been paid or canceled in Geoswift's platform can’t be submitted with the same request ID. |
| serialNumber | Serial Number of refund in Geoswift's system. |
| bankRequestNumber | Bank serial number |
| status | SUCCESS |
| FAILED | |
| amount | When the currency is JPY, KRW or VND, the unit of amount is Yuan, the unit of other currencies is China Fen, 1 Yuan = 100 Fen |
| currency | Refund currecy; Reference to the currency list table in the appendix |
| completeDateTime | Completion time |
| remark | remark |
| actualRefundAmount | Actual refund amount，when the actualRefundCurrency is JPY, KRW or VND, the unit of actualRefundAmount is Yuan, the unit of other currencies is China Fen, 1 Yuan = 100 Fen |
| actualRefundCurrency | Reference to the currency list table in the appendix |
| refundFeeAmount | The amount of therefund fee, when the refundFeeCurrency is JPY, KRW or VND, the unit of refundFeeAmount is Yuan, the unit of other currencies is China Fen, 1 Yuan = 100 Fen |
| refundFeeCurrency | Reference to the currency list table in the appendix |
| errorMessage | Error message |
| hmac | The result of parameter signature,generated by Geoswift. For the signature verification process, please reference to "Geoswift encryption and decryption process specification" |