# 2. Order refund

# Brief Description

  • After Merchant confirms the refund, needs to send a refund request for the order to SwiMove. SwiMove will then set the payment status of the corresponding order to 'Refunded' and push the instruction to print the refund receipt to the connected printer.

# HTTP Request Information

# Request URL

  • {domain}/open-api/order/jt/refund

# Request Method

  • POST

# Request Header

Parameter Name Required Type Description
Content-Type Yes string application/json

# Request Body Parameters

Parameter Name Required Type Length Limit Example Description
appId Yes string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 App id (provided by SwiMove)
storeKey Yes string 100 CVIEIYUNHTS0 Store key (provided by SwiMove)
param Yes string - - Request param content string
sign Yes string - RSA sign of param

# Param Parameters

Parameter Name Required Type Length Limit Example Description
orderNo Yes string - TB****32345 SwiMove order no
refundRemark No string - Refund remark

# Request body example

{
  "appId": "45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892",
  "storeKey": "CVIEIYUNHTS0",
  "sign": "abcdef",
  "param": "{\"orderNo\":\"TB****32345\",\"refundRemark\":\"test refund\"}"
}

# Response Example

# Code Refer to this list

# Response Parameters

Parameter Name Type Example Description
code int 10000 Status Code Refer to List
message string success Status Code Information
data object - Successful Or Not

# Data Info Param

Parameter Name Type Example Description
refundOrderSi string 00000001 refund order si
{
  "code": 10000,
  "message": "success",
  "data": "{\"refundOrderSi\":\"00000001\"}"
}

# Failed Response Example

{
    "code":21000,
    "message":"Service error, please contact administrator",
    "data":null
}