文档中心 > API类目 > 酒店官网信用住API

taobao.xhotel.order.official.precheck (官网信用住用户资格预校验接口)

官网信用住用户资格预校验接口是在订单创建之前,根据入住人身份信息对其做预先校验是否具有信用住资格。可以优化用户预定体验,对于无资格的用户在预定前即不可进行信用住的选择。减少在提交预定后预定失败体验。该接口为可选对接接口,商家可根据实际情况自行决定是否对接。 接口使用场景 提交订单前的预定人信用住资格预先校验,卖家可决定是否在搜索,预订页,补全身份信息时进行调用,以便决定信用住是否提供给用户

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
id_number String 必须 111111111111 证件号, 如果加密方式设置为1, 传入加密后的证件号(建议明文传递)
total_fee Number 必须 5000 总的收费金额,单位为分
hotel_code String 必须 H00094 参数必填,发布到阿里旅行的酒店编码
encrypt_type Number 可选 0
  • 默认值:0
  • 加密方式, 默认0: 不加密, 信息会通过淘宝开放平台传输, 阿里旅行可以获取到具体信息; 1: SHA-1不可逆加密, 阿里旅行方面无法解析到具体信息, 只用于做信息匹配.注意加密后生成40字节长度的字符串(目前不建议加密)
    id_type Number 可选 0
  • 默认值:0
  • 证件类型, 默认0:身份证; 1: 护照; 2:警官证; 3:士兵证; 4: 回乡证(目前仅仅支持身份证)
    type Number 可选 0
  • 默认值:0
  • 验证类型.可以不设置. 默认0-下单前资格校验;1-已经创建的信用住订单,入住人在checkIn时的资格复审(无特殊要求不填写)
    vendor String 可选 tb 请咨酒店对接负责人, 用于和outHid共同定位一个酒店
    guest_name String 必须 张三 入住人姓名
    mobile_no String 必须 13601083188 客人手机号

    响应参数

    名称 类型 示例值 描述
    match_condition Boolean true 是否符合信用住条件
    reason String 该用户尚未签约信用住, 请先签约 当match_condition=false时该字段有意义,用于说明用户不符合信用住条件的原因。以下两种情况,请不要读取此字段值(1、match_condition=true;2、当match_condition=false并且action=1时候(action=1表示用户未签约信用住))
    id_number String 110000198211111111 入参信息回传, 用于校验的证件号码
    action Number 0 当match_condition=false时该字段有意义,用于标示当用户不符合条件时,应该进行的下一步动作. 0或者空: 用户没有资格使用信用住。可以读取reson字段查看原因。 1: 表示用户符合资格,但是未签约信用住。可以提示用户进行签约后重试。

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    XhotelOrderOfficialPrecheckRequest req = new XhotelOrderOfficialPrecheckRequest();
    req.setIdNumber("111111111111");
    req.setTotalFee(5000L);
    req.setHotelCode("H00094");
    req.setEncryptType(0L);
    req.setIdType(0L);
    req.setType(0L);
    req.setVendor("tb");
    req.setGuestName("张三");
    req.setMobileNo("13601083188");
    XhotelOrderOfficialPrecheckResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <xhotel_order_official_precheck_response>
        <match_condition>true</match_condition>
        <reason>该用户尚未签约信用住, 请先签约</reason>
        <id_number>110000198211111111</id_number>
        <action>0</action>
    </xhotel_order_official_precheck_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isv.invalid-parameter:ERROR_NAME_ERROR name错误 修正那么
    isp.system-error 系统错误 请联系技术支持

    API工具

    如何获得此API

    FAQ

    返回
    顶部