Skip to main content

码作废（退款）接口

接口用途

  • 当需要作废码时，取码方调用此接口

接口说明

  • 码表中以掩码为分表位，每查询某个码时必须有明确的码号。
  • 已撤销(作废)/使用的码不能转换为其他状态。
  • 冻结和解冻操作是相对的。

action

  • CodeStatusUpdate

请求参数，CHANNEL===>WHALE

字段类型是否必填字段意义备注
requestIdString是请求流水号32个字符，用于标识唯一一笔交易
codeString是码号小于22个字符
optTagString(2)是操作分类01：作废

请求报文举例

{
    "requestId": "20181019112535100000000000000008",
    "code": "1021242013780905000",
    "optTag":"01"
}

返回参数，WHALE===>CHANNEL

字段类型是否必填字段意义备注
returnCodeString是请求返回码
returnMsgString是请求返回信息
dataObject<statusUpdateData>否码状态更新返回数据

返回报文举例

{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "updateDate": "20241224",
        "codeSecret": "10032891673449546316",
        "codeValidEnd": "20250323235959",
        "statusDesc": "已作废",
        "data": {},
        "tradeNo": "0601f61bf54a46b8a01899b444d47a38",
        "codeValidStart": "20241224000000",
        "currentStatus": "05",
        "updateTime": "20241224093435",
        "ticketId": 1000030006397
    }
}

失败返回报文举例

{
    "returnCode": "32",
    "returnMsg": "流水号重复，请调用查询接口",
    "data": {}
}
{
    "returnCode": "91",
    "returnMsg": "该码已使用不能更新状态[100***8707]",
    "data": {}
}
{
    "returnCode": "91",
    "returnMsg": "该码已作废不能更新状态[100***6316]",
    "data": {}
}

 

券状态枚举

字段字段意义备注
91更新码状态不支持当前操作更新码状态不支持当前操作
10券码不存在
02本操作不支持，流水号长度不正确
Back to top