3.1 积分商城

3.1.1 获取用户可用积分

第三方应用可以使用此接口获取用户当前可用积分余额

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/service/oauth/app/bonuspoints/getUserBonusPoints?access_token=2019040189580858920907506625723500936366986112&msg_signature=3a7b08bb8e6dbce3c9671d6fdb69d15066227608&timestamp=1403610513&nonce=380320359
请求包体:

{
    "user_id": "7951571222327321975",
    "user_type":"1"
}

参数说明:

参数 是否必须 说明
user_type 用户类型:1-用户,2-客户
user_id 用户唯一ID

返回结果:

{
    "return_code":0,
    "return_msg":"success",
    "return_data":{
        "tenant_id":"6692513571099135446",
        "user_id":"111",
        "user_type":"1",
        "is_freeze":0,
        "bp_amount":83000
    }
}

参数说明:

参数 说明
return_code 响应码
return_msg 对返回码的文本描述内容
tenant_id 企业ID
user_id 用户唯一ID
user_type 用户类型:1-用户,2-客户
is_freeze 账户状态: 0-停用 1-正常
bp_amount 积分可用余额

3.1.2 积分交易

第三方应用可以使用此接口进行积分兑换

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/service/oauth/app/bonuspoints/doUserBpOutTrade?access_token=2019040189580858920907506625723500936366986112&msg_signature=3a7b08bb8e6dbce3c9671d6fdb69d15066227608&timestamp=1403610513&nonce=380320359
请求包体:

{
    "user_id": "7951571222327321975",
    "user_type":"1",
    "source_id":30001,
    "out_flow_id":"X00000000001",
    "biz_id":"1000002",
    "biz_summary":"手机iPhoneXR红色",
    "bp_amount":650
}

参数说明:

参数 是否必须 说明
user_type 用户类型:1-用户,2-客户
user_id 用户唯一ID
source_id 数据来源编码:30001-新福利
out_flow_id 调用方的关联本次交易请求的外部流水号
biz_id 调用方的本次交易的业务id
biz_summary 调用方本次交易业务摘要
bp_amount 交易积分,仅支持2位小数

返回结果:

{
    "return_code":0,
    "return_msg":"success",
    "return_data":{
        "tenant_id":"6692513571099135446",
        "user_id":"7951571222327321975",
        "source_id":30001,
        "biz_id":"1000002",
        "biz_summary":"手机iPhoneXR红色",
        "bp_flow_id":"5366358595610816732",
        "out_flow_id":"X00000000001",
        "bp_amount":650,
        "trade_time":"2018-04-28 14:18:32"
    }
}

参数说明:

参数 说明
return_code 响应码
return_msg 对返回码的文本描述内容
tenant_id 企业ID
user_id 用户唯一ID
source_id 数据来源编码:30001-新福利
biz_id 调用方的本次交易的业务id
biz_summary 调用方本次交易业务摘要
bp_flow_id 返回的外勤365本次交易的流水id
out_flow_id 调用方的关联本次交易请求的外部流水号
bp_amount 本次交易扣除的积分
trade_time 本次交易的时间 格式 2018-04-11 10:13:35

3.1.3 积分交易查询

第三方应用可以使用此接口根据交易流水ID查询积分兑换信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/service/oauth/app/bonuspoints/queryUserBpTrade?access_token=2019040189580858920907506625723500936366986112&msg_signature=3a7b08bb8e6dbce3c9671d6fdb69d15066227608&timestamp=1403610513&nonce=380320359
请求包体:

{
    "source_id":30001,
    "out_flow_id":"X00000000001"
}

参数说明:

参数 是否必须 说明
source_id 数据来源编码:30001-新福利
out_flow_id 调用方的关联本次交易请求的外部流水号

返回结果:

{
    "return_code":0,
    "return_msg":"success",
    "return_data":{
        "tenant_id":"6692513571099135446",
        "user_id":"7951571222327321975",
        "source_id":30001,
        "biz_id":"1000002",
        "biz_summary":"手机iPhoneXR红色",
        "bp_flow_id":"5366358595610816732",
        "out_flow_id":"X00000000001",
        "bp_amount":650,
        "trade_time":"2018-04-28 14:18:32"
    }
}

参数说明:

参数 说明
return_code 响应码
return_msg 对返回码的文本描述内容
tenant_id 企业ID
user_id 用户唯一ID
source_id 数据来源编码:30001-新福利
biz_id 调用方的本次交易的业务id
biz_summary 调用方本次交易业务摘要
bp_flow_id 返回的外勤365本次交易的流水id
out_flow_id 调用方的关联本次交易请求的外部流水号
bp_amount 本次交易扣除的积分
trade_time 本次交易的时间 格式 2018-04-11 10:13:35

3.1.4 积分退款

第三方应用可以使用此接口进行退款交易

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/service/oauth/app/bonuspoints/doUserBpOutRefundTrade?access_token=2019040189580858920907506625723500936366986112&msg_signature=3a7b08bb8e6dbce3c9671d6fdb69d15066227608&timestamp=1403610513&nonce=380320359
请求包体:

{
    "user_type":"1",
    "user_id": "7951571222327321975",
    "source_id":30001,
    "refund_flow_id":"X00000000002",
    "biz_id":"1000002",
    "biz_summary":"手机iPhoneXR红色",
    "ori_out_flow_id": "X00000000001",
    "pay_flow_id":"5366358595610816732",
    "refund_bp_amount":400
}

参数说明:

参数 是否必须 说明
user_type 用户类型:1-用户,2-客户
user_id 用户唯一ID
source_id 数据来源编码:30001-新福利
refund_flow_id 本次退款交易请求的外部流水号
biz_id 调用方的本次交易的业务id
biz_summary 调用方本次交易业务摘要
ori_out_flow_id 原交易请求的外部流水号,
和 pay_flow_id两者必选一个传入,
都传了的话默认使用 pay_flow_id
pay_flow_id 原交易请求返回的外勤365交易流水号,
和ori_out_flow_id两者必选一个传入,
都传了的话默认使用pay_flow_id
refund_bp_amount 积分退还数量,仅支持2位小数

返回结果:

{
    "return_code":0,
    "return_msg":"success",
    "return_data":{
        "tenant_id":"6692513571099135446",
        "user_id":"7951571222327321975",
        "source_id":30001,
        "biz_id":"1000002",
        "biz_summary":"手机iPhoneXR红色",
        "bp_flow_id":"5366358595610816732",
        "refund_out_flow_id":"X00000000002",
        "refund_bp_amount":400,
        "ori_out_flow_id":"X00000000001",
        "ori_pay_flow_id":"5366358595610816732",
        "has_refund_bp_amount":400,
        "total_bp_amount":4020,
        "trade_time":"2018-04-28 14:18:32"
    }
}

参数说明:

参数 说明
return_code 响应码
return_msg 对返回码的文本描述内容
tenant_id 企业ID
user_id 用户唯一ID
source_id 数据来源编码:30001-新福利
biz_id 调用方的本次交易的业务id
biz_summary 调用方本次交易业务摘要
bp_flow_id 返回的外勤365本次退款的流水id
refund_out_flow_id 调用方的关联本次退款请求的外部流水号
refund_bp_amount 本次退款的积分数
ori_out_flow_id 原订单的调用方外部流水号
ori_pay_flow_id 原订单返回的外勤365交易流水id
has_refund_bp_amount 已退款的总积分数(包含本次交易积分)
total_bp_amount 原订单的总积分数
trade_time 本次交易的时间,时间格式 参考 2018-04-11 10:13:35

3.1.5 积分退款查询

第三方应用可以使用此接口根据退款交易流水查询积分退款信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/service/oauth/app/bonuspoints/queryUserBpRefundTrade?access_token=2019040189580858920907506625723500936366986112&msg_signature=3a7b08bb8e6dbce3c9671d6fdb69d15066227608&timestamp=1403610513&nonce=380320359
请求包体:

{
    "source_id":30001,
    "out_flow_id":"X00000000002"
}

参数说明:

参数 是否必须 说明
source_id 数据来源编码:30001-新福利
out_flow_id 调用方的关联本次交易请求的外部流水号

返回结果:

{
    "return_code":0,
    "return_msg":"success",
    "return_data":{
        "tenant_id":"6692513571099135446",
        "user_id":"7951571222327321975",
        "source_id":30001,
        "biz_id":"1000002",
        "biz_summary":"手机iPhoneXR红色",
        "bp_flow_id":"5366358595610816732",
        "ori_out_flow_id":"X00000000001",
        "ori_pay_flow_id":"5366358595610816732",
        "has_refund_bp_amount":400,
        "refund_bp_amount":400,
        "refund_out_flow_id":"X00000000002",
        "total_bp_amount":4020,
        "trade_time":"2018-04-28 14:18:32"
    }
}

参数说明:

参数 说明
return_code 响应码
return_msg 对返回码的文本描述内容
tenant_id 企业ID
user_id 用户唯一ID
source_id
biz_id 调用方的本次交易的业务id
biz_summary 调用方本次交易业务摘要
bp_flow_id 返回的外勤365本次退款的流水id
ori_out_flow_id 原订单的调用方外部流水号
ori_pay_flow_id 原订单返回的外勤365交易流水id
has_refund_bp_amount 已退款的总积分数(包含本次交易易)
refund_bp_amount 本次退款的积分数
refund_out_flow_id 调用方的关联本次退款请求的外部流水号
total_bp_amount 原订单的总积分数
trade_time 本次交易的时间,时间格式 参考 2018-04-11 10:13:35

3.1.6 积分商城业务异常响应码

响应码 异常描述
101002100 非法请求参数!
101002101 积分请求处理中,请勿重复提交!
101002102 积分余额不足!
101002103 用户积分已冻结!
101002104 交易请求不存在!
101002105 退款源单号不存在!
101002106 退款必须退给原来的用户!
101002107 退款流水不存在!
101002108 退款金额超过原订单上限!
101002109 退款流水已存在!
101002113 该交易不支持退款!
101002114 用户不存在!
101002115 当前交易已完成!