企业主账号从企业子账号回收优惠券-ReclaimSubEnterpriseAmount

功能介绍

企业主账号在自建平台回收给企业子账号的拨款优惠券。

仅支持华为发放的测试类、商务类、活动类代金券。

接口约束

该接口只允许使用企业主账号AK/SK或者Token调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见策略授权参考。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
描述
访问级别
资源类型（*为必须）
条件键
别名
businessUnitCenter:businessUnitFinance:update
授予修改企业组织财务信息的权限
write
-
-
-

授权项	描述	访问级别	资源类型（*为必须）	条件键	别名
businessUnitCenter:businessUnitFinance:update	授予修改企业组织财务信息的权限	write	-	-	-

URI

POST /v2/enterprises/multi-accounts/retrieve-coupon

请求消息

请求参数

参数	是否必选	参数类型	取值范围	描述
customer_id	是	String	[1-64]	企业子账号的客户ID。您可以调用查询企业子账号列表接口，获取响应参数“id”的返回值。
coupon_id	是	String	[1-64]	优惠券ID。您可以调用查询企业子账号可回收优惠券列表接口，获取响应参数“coupon_id”的返回值。
sub_coupon_id	是	String	[1-64]	子优惠券ID。您可以调用查询企业子账号可回收优惠券列表接口，获取响应参数“sub_coupon_id”的返回值。
trans_id	否	String	[0-32]	交易序列号，用于防止重复提交。如果接口调用方不传，则企业管理微服务后台生成如果接口调用方传入，则请采用UUID保证全局唯一此参数不携带或携带值为null或携带值为空串时，由系统自动生成。

请求示例

POST https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/retrieve-coupon HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
  "customer_id": "e8a*****b9c",
  "coupon_id": "CP19092406014086E2",
  "sub_coupon_id": "CP19092406014086E1",
  "trans_id": "333333"
}

响应消息

响应参数

状态码：200

参数	参数类型	取值范围	描述
real_retrieve_amout	String	最大长度：20	实际回收金额。单位为元。

状态码：400

参数	参数类型	取值范围	描述
error_code	String	最大长度：16	状态码。具体请参考状态码。只有失败才会返回这个参数。
error_msg	String	最大长度：1024	错误描述信息。只有失败才会返回这个参数。
fail_check_items	List<String>	-	不满足的业务规则检查项。当错误码为CBC.99007004时返回。具体检查项参见”表1”。

参数

参数类型

取值范围

描述

error_code

String

最大长度：16

状态码。具体请参考状态码。只有失败才会返回这个参数。

error_msg

String

最大长度：1024

错误描述信息。只有失败才会返回这个参数。

fail_check_items

List<String>

不满足的业务规则检查项。

当错误码为CBC.99007004时返回。
具体检查项参见”表1”。

表1 企业主账号从企业子账号回收优惠券检查项
检查项ID	检查项名称
ONLY_CASH_COUPON_CAN_TRANSFER	只有代金券支持在企业主子账号间划拨和回收
COUPON_STATUS_CAN_NOT_OPERATE	优惠券当前不允许操作：状态为不可用、已过期或被冻结
COUPON_NOT_EXIST_OR_NOT_SUB	待回收的子优惠券不存在或不属于企业子账号
NOT_PRI_TRANSFER_COUPON	不是企业主账号划拨的优惠券不能回收
SOURCE_COUPON_NOT_EXIST_OR_NOT_PRI	源优惠券不存在或不属于企业主账号
SOURCE_COUPON_RECALL_BY_ADMIN	源优惠券已被管理员回收，无法从从子优惠券回收余额
COUPON_BALANCE_IS_ZERO	优惠券可回收金额为0，不能回收
MUST_BE_SAME_SIGNING_ENTITY	关联的子账号签约主体与您的账号签约主体不一致，无法操作。
NO_RETRIEVE_FOR_FC_SUBACCOUNT	不能从财务托管企业子回收。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "real_retrieve_amout": "1.0"
}

状态码

状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。

HTTP状态码	错误码	错误描述
400	CBC.0100	参数错误。
400	CBC.99000043	企业主账号向企业子账号拨款/回收失败。
400	CBC.99007004	发起的业务操作存在不满足的业务检查项。
400	CBC.99007009	交易事务ID重复。
400	CBC.99000087	抱歉，当前操作出现异常，请稍后再试。
403	CBC.0151	访问拒绝。
403	CBC.0155	不允许执行当前请求。
500	CBC.0999	其他错误。