沙箱环境是支付宝开放平台为开发者提供的与生产环境完全隔离的联调测试环境，开发者在沙箱环境中完成的接口调用不会对生产环境中的数据造成任何影响。

沙箱为开放的产品提供有限功能范围的支持（覆盖的功能范围可查看以下的业务用例），可以覆盖产品的绝大部分核心链路和对接逻辑，便于开发者快速学习/尝试/开发/调试，推荐开发者遵循业务用例来使用沙箱。

沙箱环境会自动完成或忽略一些场景的业务门槛，例如：开发者无需等待产品开通，即可直接在沙箱环境调用接口，使得开发集成工作可以与商务流程并行，从而提高项目整体的交付效率。

注意：

由于沙箱环境并非 100% 与生产环境一致，接口的实际响应逻辑请以生产环境为准，沙箱环境开发调试完成后，仍然需要在生产环境进行测试验收。

沙箱环境拥有完全独立的数据体系，沙箱环境下返回的数据（例如用户 ID 等）在生产环境中都是不存在的，开发者不可将沙箱环境返回的数据与生产环境中的数据混淆。

本文仅说明如何在沙箱环境中调试支付有礼，非沙箱环境调试通用说明。

更多沙箱介绍和沙箱控制台使用说明请可查看沙箱环境。

支付有礼沙箱调试说明

沙箱通过业务用例定义支持的功能范围。业务用例描述了典型业务场景下，开发者可通过先后对接哪些接口来实现业务目标，每个业务用例会为开发者提供接口调用时序与参数示例值。

推荐开发者遵循业务用例来使用沙箱。

注意：示例参数值中与沙箱当前账号、应用上下文相关的参数，需开发者自行参照接入指南调用配套接口获取。

业务用例

指定支付成功页推广商家券

创建推广计划

调用 OpenAPI： alipay.marketing.activity.delivery.create（创建推广计划）

入参示例值：

{
 "delivery_booth_code": "PAYMENT_RESULT",
 "delivery_base_info": {
 "delivery_end_time": "2022-10-28 16:00:11",
 "delivery_name": "支付有礼指定支付成功页推广券",
 "delivery_begin_time": "2022-08-29 16:00:11"
 },
 "delivery_play_config": {
 "delivery_full_send_config": {
 "delivery_floor_amount": "1.00",
 "delivery_content_info": {
 "delivery_content_type": "ACTIVITY",
 "delivery_activity_content": {
 "activity_id": "2022092800826004586300207814"
 }
 }
 }
 },
 "delivery_target_rule": {
 "delivery_merchant_rule": {
 "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
 "delivery_merchant_infos": [{
 "merchant_id_type": "PID",
 "merchant_id": "2088102175963583"
 }]
 },
 "delivery_city_code_rule": {
 "city_codes": ["431200"]
 }
 },
 "merchant_access_mode": "SELF_MODE",
 "out_biz_no": "202209285906888968"
}

出参示例值：

{
 "alipay_marketing_activity_delivery_create_response": {
 "msg": "Success",
 "code": "10000",
 "delivery_id": "2022092800826029586300081225"
 }
}

接收推广计划审核通过通知

接收 MsgAPI 消息： alipay.marketing.activity.delivery.changed（推广计划状态变更消息）

消息业务参数示例值：

{
 "delivery_id": "2022092800826029586300081225",
 "out_biz_no": "202209285906888968",
 "delivery_booth_code": "PAYMENT_RESULT",
 "delivery_status": "ACTIVE",
 "event_time": "1664352012121"
}

查询推广计划详情

调用 OpenAPI： alipay.marketing.activity.delivery.query（查询推广计划）

入参示例值：

{
 "merchant_access_mode": "SELF_MODE",
 "delivery_id": "2022092800826029586300081225"
}

出参示例值：

{
 "alipay_marketing_activity_delivery_query_response": {
  "msg": "Success",
  "delivery_base_info": {
   "delivery_end_time": "2022-10-28 16:00:11",
   "delivery_name": "支付有礼指定支付成功页推广券",
   "delivery_begin_time": "2022-08-29 16:00:11"
  },
  "code": "10000",
  "delivery_id": "2022092800826029586300081225",
  "delivery_play_config": {
   "delivery_full_send_config": {
    "delivery_floor_amount": "1.00",
    "delivery_content_info": {
     "delivery_content_type": "ACTIVITY",
     "delivery_activity_content": {
      "activity_id": "2022092800826004586300207814"
     }
    }
   }
  },
  "delivery_booth_code": "PAYMENT_RESULT",
  "delivery_target_rule": {
   "delivery_city_code_rule": {
    "city_codes": [
     "431200"
    ]
   },
   "delivery_merchant_infos": [{
    "merchant_id_type": "PID",
    "merchant_id": "2088102175963583"
   }],
   "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
   "delivery_available_scope": {
    "delivery_available_city_code": {
     "city_codes": [
      "431200"
     ]
    },
    "delivery_available_scope_type": "CITY_CODE"
   },
   "delivery_merchant_rule": {
    "delivery_merchant_infos": [{
     "merchant_id_type": "PID",
     "merchant_id": "2088102175963583"
    }],
    "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
    "brand_id_list": [
     "2088102175963583"
    ]
   },
   "brand_id_list": [
    "2088102175963583"
   ]
  },
  "delivery_status": "ACTIVE"
 }
}

停止推广计划

调用 OpenAPI： alipay.marketing.activity.delivery.stop（停止推广计划）

入参示例值：

{
 "merchant_access_mode": "SELF_MODE",
 "delivery_id": "2022092800826029586300081225",
 "out_biz_no": "202209285906888968"
}

出参示例值：

{
 "alipay_marketing_activity_delivery_stop_response": {
 "msg": "Success",
 "code": "10000",
 "delivery_id": "2022092800826029586300081225"
 }
}

指定订单推广商家券

创建推广计划

调用 OpenAPI： alipay.marketing.activity.delivery.create（创建推广计划）

入参示例值：

{
 "delivery_booth_code": "PAYMENT_RESULT",
 "delivery_base_info": {
 "delivery_end_time": "2022-10-28 16:00:11",
 "delivery_name": "支付有礼指定订单推广商家券测试",
 "delivery_begin_time": "2022-08-29 16:00:11"
 },
 "delivery_play_config": {
 "delivery_single_send_config": {
 "delivery_content_info": {
 "delivery_content_type": "ACTIVITY",
 "delivery_activity_content": {
 "activity_id": "2022092800826004586300207814"
 }
 }
 }
 },
 "delivery_target_rule": {
 "delivery_merchant_rule": {
 "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
 "delivery_merchant_infos": [{
 "merchant_id_type": "PID",
 "merchant_id": "2088102175963583"
 }]
 },
 "delivery_city_code_rule": {
 "city_codes": ["100100"],
 "all_city": ""
 },
 "delivery_promo_tags": "memberLevel1,memberLevel2"
 },
 "merchant_access_mode": "SELF_MODE",
 "out_biz_no": "202209288561898390"
}

出参示例值：

{
 "alipay_marketing_activity_delivery_create_response": {
 "msg": "Success",
 "code": "10000",
 "delivery_id": "2022092800826029586300081226"
 }
}

接收推广计划审核通过通知

接收 MsgAPI 消息： alipay.marketing.activity.delivery.changed（推广计划状态变更消息）

消息业务参数示例值：

{
 "delivery_id": "2022092800826029586300081226",
 "out_biz_no": "202209288561898390",
 "delivery_booth_code": "PAYMENT_RESULT",
 "delivery_status": "ACTIVE",
 "event_time": "1664352013125"
}

查询推广计划详情

调用 OpenAPI： alipay.marketing.activity.delivery.query（查询推广计划）

入参示例值：

{
 "merchant_access_mode": "SELF_MODE",
 "delivery_id": "2022092800826029586300081226"
}

出参示例值：

{
 "alipay_marketing_activity_delivery_query_response": {
 "msg": "Success",
 "delivery_base_info": {
 "delivery_end_time": "2022-10-28 16:00:11",
 "delivery_name": "支付有礼指定订单推广商家券测试",
 "delivery_begin_time": "2022-08-29 16:00:11"
 },
 "code": "10000",
 "delivery_id": "2022092800826029586300081226",
 "delivery_play_config": {
 "delivery_single_send_config": {
 "delivery_content_config": {
 "delivery_send_guide": {
 "delivery_guide_url": "alipays://platformapi/startapp?appId=2017052601000815&page=/index/path/path&query=12%3d21"
 }
 },
 "delivery_content_info": {
 "delivery_content_type": "ACTIVITY",
 "delivery_activity_content": {
 "activity_id": "2022092800826004586300207814"
 }
 }
 }
 },
 "delivery_booth_code": "PAYMENT_RESULT",
 "delivery_target_rule": {
 "delivery_city_code_rule": {
 "city_codes": [
 "100100"
 ]
 },
 "delivery_merchant_infos": [{
 "merchant_id_type": "PID",
 "merchant_id": "2088102175963583"
 }],
 "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
 "delivery_available_scope": {
 "delivery_available_city_code": {
 "city_codes": [
 "100100"
 ]
 },
 "delivery_available_scope_type": "CITY_CODE"
 },
 "delivery_merchant_rule": {
 "delivery_merchant_infos": [{
 "merchant_id_type": "PID",
 "merchant_id": "2088102175963583"
 }],
 "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
 "brand_id_list": [
 "2088102175963583"
 ]
 },
 "brand_id_list": [
 "2088102175963583"
 ],
 "delivery_promo_tags": "memberLevel1,memberLevel2"
 },
 "delivery_status": "ACTIVE"
 }
}

停止推广计划

调用 OpenAPI： alipay.marketing.activity.delivery.stop（停止推广计划）

入参示例值：

{
 "merchant_access_mode": "SELF_MODE",
 "delivery_id": "2022092800826029586300081226",
 "out_biz_no": "202209288561898390"
}

出参示例值：

{
 "alipay_marketing_activity_delivery_stop_response": {
 "msg": "Success",
 "code": "10000",
 "delivery_id": "2022092800826029586300081226"
 }
}

沙箱调试

支付有礼沙箱调试说明#

业务用例#

指定支付成功页推广商家券#

创建推广计划#

接收推广计划审核通过通知#

查询推广计划详情#

停止推广计划#

指定订单推广商家券#

创建推广计划#

接收推广计划审核通过通知#

查询推广计划详情#

停止推广计划#

支付有礼沙箱调试说明

业务用例

指定支付成功页推广商家券

创建推广计划

接收推广计划审核通过通知

查询推广计划详情

停止推广计划

指定订单推广商家券

创建推广计划

接收推广计划审核通过通知

查询推广计划详情

停止推广计划