文档中心 > API类目 > 酒店线下信用住API

taobao.xhotel.order.alipayface.check (线下信用住买家资格校验接口)

接口用于校验买家是否具有使用酒店信用住的资格

公共参数

请求参数

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

    响应参数

    名称 类型 示例值 描述
    match_condition Boolean true 是否符合信用住条件
    reason String 该用户尚未签约线下信用住, 请先扫码签约 当match_condition=false时该字段有意义,用于说明用户不符合信用住条件的原因, 主要有如下几种返回:1. 该用户尚未签约线下信用住, 请先扫码签约; 2.该用户尚未签约, 暂不支持使用线下信用住, 请使用现金或其他方式结账; 3. 该用户支付宝账号存在风险, 暂不支持使用线下信用住, 请使用现金或其他方式结账; 4.该用户当前信用额度不足, 无法支付此房费, 请使用现金或其他方式结账
    id_number String 110000198211111111 入参信息回传, 用于校验的证件号码
    action Number 1 当match_condition=false时该字段有意义,用于标示当用户不符合条件时,应该进行的下一步动作. 0或者空: 代表没有下一步动作, 接入方此时可以直接不提示用户走任何线下信用住的流程和文案等; 1: 提示用户进行扫码签约,此时可以把reason字段展示到前台,或者自己定义提示文案
    exist_alipay_order Boolean true existAlipayOrder

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    XhotelOrderAlipayfaceCheckRequest req = new XhotelOrderAlipayfaceCheckRequest();
    req.setIdNumber("110000198211111111");
    req.setTotalFee(12300L);
    req.setHotelCode("H123");
    req.setEncryptType(1L);
    req.setIdType(1L);
    req.setType(0L);
    req.setVendor("taobao");
    req.setGuestName("张三");
    req.setMobileNo("13601083188");
    XhotelOrderAlipayfaceCheckResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <xhotel_order_alipayface_check_response>
        <match_condition>true</match_condition>
        <reason>该用户尚未签约线下信用住, 请先扫码签约</reason>
        <id_number>110000198211111111</id_number>
        <action>1</action>
        <exist_alipay_order>true</exist_alipay_order>
    </xhotel_order_alipayface_check_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:FORMAT_ERROR 参数格式不正确 参考api文档检查入参
    isv.invalid-parameter:LENGTH_OVERRANGE 参数长度不能超过规定值 参考api文档检查入参
    isv.invalid-parameter:NOTNULL 参数不能为空 参考api文档检查入参
    isv.invalid-parameter:NUM 参数应该是数字 参考api文档检查入参
    isv.invalid-parameter:STRING 参数应该是字符串 参考api文档检查入参
    isv.permission-error:NO_PERMISSIONS_ERROR 权限不够、非法访问 检查订单id是否输入有误
    isp.system-error 系统错误 联系技术支持跟进
    isv.invalid-parameter 参数错误 检查入参
    isv.biz-error 业务错误 反馈业务方
    isv.invalid-parameter:ERROR_NAME_ERROR 名字错误 输入正确的名字

    API工具

    如何获得此API

    FAQ

    返回
    顶部