沙箱环境是支付宝开放平台为开发者提供的安全低门槛的测试环境，开发者在沙箱环境中调用接口无需具备所需的商业资质，无需绑定和开通产品，同时不会对生产环境中的数据造成任何影响。

合理使用沙箱环境，可以让研发流程与商业流程并行，降低联调资损风险，加速项目的交付。

注意：

前端开发过程使用沙箱环境，可以不依赖沙箱环境切换插件，直接使用沙箱支付宝 APP 拉起联调，详情参见前端开发过程使用沙箱。

后端开发过程使用沙箱环境，详情参见后端开发过程使用沙箱。

更多沙箱环境介绍、支持的产品范围、约束限制说明和常见问题等，请参见沙箱环境。

使用约束：

独立签约场景下，在小程序内唤起签约页暂不支持，正在建设中。

暂不支持支付并签约场景在沙箱环境测试，正在建设中。

业务用例

签约协议

10.

独立签约

11.

调用 OPENAPI 接口：alipay.user.agreement.page.sign

12.

入参示例值

13.

{
 "access_params":{
 "channel":"ALIPAYAPP"
 },
 "external_agreement_no":"DKRGVIAZAV",// 商户签约号，代扣协议中标示用户的唯一签约号（确保在商户系统中唯一）
 "period_rule_params":{
 "execute_time":"2023-07-26",
 "period":7,
 "period_type":"DAY",
 "single_amount":"99"
 },
 "personal_product_code":"CYCLE_PAY_AUTH_P",// 固定值
 "product_code":"GENERAL_WITHHOLDING",// 固定值
 "sign_scene":"INDUSTRY|DEFAULT_SCENE"// 协议签约场景，商户可根据 代扣产品常见场景值 选择符合自身的行业场景。
}

14.

参数使用说明：
独立签约支持 SDK、PC 转二维码、小程序(沙箱暂不支持)等三种方式接入，参数一样，根据接入场景，对返回结果做转换。

15.

沙箱只支持 INDUSTRY|DEFAULT_SCENE场景。

只能签约一次，可以解约再次签约。

external_logon_id 传中文可能导致异步验签失败。

16.

SDK 内唤起签约页

17.

调用接口，获取原始参数，使用 response = alipayClient.pageExecute(request,"get")

获取签名参数 signParams = response.getBody().replace("https://openapi-sandbox.dl.alipaydev.com/gateway.do?","")

把 signParams 使用 UTF-8 字符集整体做一次 encode，signParams = encode(signParams)

生成唤起客户端参数，

callParams = 'alipays://platformapi/startapp?appId=60000157&appClearTop=false&startMultApp=YES&sign_params=' + signParams

18.

注意

19.

alipays://platformapi/startapp?appId=60000157（该链接里面的 APPID 为固定值，不可修改）

20.

PC 转二维码唤起签约页

21.

调用接口，生成签约 URL，使用 signUrl = alipayClient.pageExecute(request, "get")。

使用二维码生成工具把签约URL转成二维码，用户扫码签约。

22.

注意：

23.

PHP 语言生成的签约字符串有可能会被转义，需要 htmlspecialchars 处理之后的签约字符串生成二维码。

24.

小程序内唤起签约页

25.

说明：沙箱环境暂不支持该场景，正在建设中。

26.

协议管理

27.

协议查询

28.

调用 OPENAPI 接口：alipay.user.agreement.query

29.

入参示例值

30.

{
 "alipay_user_id":"208872200058****",
 "external_agreement_no":"DK9KX0HB",// 商户签约号，代扣协议中标示用户的唯一签约号（确保在商户系统中唯一）
 "personal_product_code":"CYCLE_PAY_AUTH_P",
 "sign_scene":"INDUSTRY|DEFAULT_SCENE"// 协议签约场景，商户可根据 代扣产品常见场景值 选择符合自身的行业场景。
}

31.

出参示例值

32.

{
 "alipay_user_agreement_query_response":{
 "msg":"Success",
 "code":"10000",
 "third_party_type":"PARTNER",
 "external_agreement_no":"DK9KX0HB",
 "principal_id":"208872200058****",
 "sign_time":"2023-07-11 19:29:41",
 "agreement_no":"20235511025243691778",// 支付宝系统中用以唯一标识用户签约记录的编号。（只有签约成功时才会返回）
 "invalid_time":"2115-02-01 00:00:00",
 "personal_product_code":"CYCLE_PAY_AUTH_P",
 "pricipal_type":"CARD",
 "valid_time":"2023-07-11 19:29:41",
 "alipay_logon_id":"pji***@sandbox.com",
 "sign_scene":"INDUSTRY|DEFAULT_SCENE",
 "status":"NORMAL"
 }
}

33.

协议解约

34.

调用的 OPENAPI 接口：alipay.user.agreement.unsign

35.

{
 "agreement_no":"20235511025243691778"// 支付宝系统中用以唯一标识用户签约记录的编号。（只有签约成功时才会返回）
}
{
 "sign":"O8eWkL6LVzBaqNMQONhi1/cLUQVbtFM7q/cugCjR8v31M8jT3gGnJDYnFpo1by7jw9la+qIuAAQMzaGYG4saC4GvoPxIJF/FwNI6jPncGxV3sy7eglA85Sc+YENbAcioqvGS70J+RUFnKrdsZyEWqRvW2o39MOUj524+VcKxmGo/3UbGzxXA7iPQGn9LsFwQ0wXrK0ao44dTovAfxtTYs551Zwn7wCA+7mbdA29ufVZQLSNimBBREoOwxUIkXx0BedvdIOg8kBrey7CEA+ndFakHtHO1PUADEW7dswmWFaubhckzxsYngRGRyImCPSJH0mhJ79NRwJY9Vbt2S+ePYA==",
 "alipay_user_agreement_unsign_response":{
 "msg":"Success",
 "code":"10000"
 }
}

36.

协议修改

37.

调用的 OPENAPI 接口：alipay.user.agreement.executionplan.modify

38.

入参示例值

39.

{
  "agreement_no":"20235526025282926778"
  "deduct_time":"2023-07-28"
  "memo":"测试修改"
}

40.

出参示例值

41.

{
 "sign":"MX7oDyzKx3WdHnF8eUWc0qeyC6X1EfOBOTNAbW4H2B1TOsbewzoomPgWl2N7RJEeM4KA9EoJpvCqtVCnzKQimHIswa5efgIDaIrZbolITWUPQHhaFhtD8V5/WdjqHCE4KdMypLFT5g3DojuQrqSAe5HjuauW8nteUmqUuhrhv3UubogRvLvfiJ5TVZ2lZUydkcoXSBKWea36iO7K0Vam3DFh9tJGES1K3qY7jaSyzaIhZDzImqJmx7mRVfzOOao6A7YOAIxvgsmu1D80bfhmYuSdh6qRuzE2mh84RYgNYBumuBBaFByIt1aqPzh9PL6e9PjheuWo1fEwQ7fXjQaNFw==",
 "alipay_user_agreement_executionplan_modify_response":{
 "msg":"Success",
 "code":"10000",
 "agreement_no":"20235526025282926778",
 "deduct_time":"2023-07-28 08:00:00"
 }
}

42.

协议扣款

43.

扣款

44.

调用的 OPENAPI 接口：alipay.trade.pay

45.

入参示例值

46.

{
 "agreement_params":{
 "agreement_no":"20235511025243691778"
 },// 支付宝系统中用以唯一标识用户签约记录的编号。（只有签约成功时才会返回）
 "out_trade_no":"b895d854f7794fb3bbb2f17cebb6445b",
 "product_code":"GENERAL_WITHHOLDING",// 固定值
 "subject":"测试代扣",
 "total_amount":"28"
}

47.

注意：

48.

沙箱环境单笔限额 2000，正式环境限额 100。

请勿频繁扣款，每次扣款至少间隔 1 分钟，否则会报“协议信息异常”错误。

正式环境周期内只能扣款 1 次，沙箱不限制次数。

49.

出参示例值

50.

{
  "alipay_trade_pay_response": {
    "code": "10000",
    "msg": "Success",
    "buyer_logon_id": "pji***@sandbox.com",
    "buyer_pay_amount": "28.00",
    "buyer_user_id": "208872200058****",
    "buyer_user_type": "PRIVATE",
    "fund_bill_list": [
      {
        "amount": "28.00",
        "fund_channel": "ALIPAYACCOUNT"
      }
    ],
    "gmt_payment": "2023-07-12 14:35:57",
    "invoice_amount": "28.00",
    "out_trade_no": "86185826a13d4854a982c244a0729626",
    "point_amount": "0.00",
    "receipt_amount": "28.00",
    "total_amount": "28.00",
    "trade_no": "2023071222001486780500485476"
  }
}

51.

交易撤销

52.

调用的 OPENAPI 接口：alipay.trade.cancel

53.

入参示例值

54.

{
 "out_trade_no":"7e165070067845fba0f5b6537864f8ad"
}

55.

出参示例值

56.

{
  "alipay_trade_cancel_response":{
 "msg":"Success",
 "code":"10000",
 "out_trade_no":"7e165070067845fba0f5b6537864f8ad",
 "retry_flag":"N",
 "action":"close",
 "trade_no":"2023071222001486780500497860"
 }
}

57.

交易退款

58.

调用的 OPENAPI 接口：alipay.trade.refund

59.

入参示例值

60.

{
 "refund_amount":"28",
 "trade_no":"2023071222001486780500485476"
}

61.

出参示例值

62.

{
  "alipay_trade_refund_response":{
 "msg":"Success",
 "refund_detail_item_list":[
 {
 "amount":"28.00",
 "fund_channel":"ALIPAYACCOUNT"
 }
 ],
 "code":"10000",
 "out_trade_no":"86185826a13d4854a982c244a0729626",
 "refund_fee":"28.00",
 "gmt_refund_pay":"2023-07-12 17:38:51",
 "send_back_fee":"28.00",
 "trade_no":"2023071222001486780500485476",
 "buyer_logon_id":"pji***@sandbox.com",
 "buyer_user_id":"208872200058****",
 "fund_change":"Y"
 }
}

63.

查询对账单

64.

调用的 OPENAPI 接口：alipay.data.dataservice.bill.downloadurl.query

65.

入参示例值

66.

{
 "bill_date":"2023-07-11",
 "bill_type":"trade"
}

67.

出参示例值

68.

{
  "alipay_data_dataservice_bill_downloadurl_query_response":{
 "msg":"Success",
 "code":"10000",
 "bill_download_url":"http://dwbillcenter-sandbox.dl.alipaydev.com/downloadBillFile.resource?bizType=trade&userId=2088721000621517****&fileType=csv.zip&bizDates=20230711&downloadFileName=20887210006215170156_20230711.csv.zip&fileId=%2Ftrade%2F20887210006215170156%2F20230711.csv.zip&timestamp=1689155281&token=fc2b4cc81c517ca4446873365155250b"
 }
}

沙箱调试说明

业务用例#

签约协议#

独立签约#

SDK 内唤起签约页#

PC 转二维码唤起签约页#

小程序内唤起签约页#

协议管理#

协议查询#

协议解约#

协议修改#

协议扣款#

扣款#

交易撤销#

交易退款#

查询对账单#

业务用例

签约协议

独立签约

SDK 内唤起签约页

PC 转二维码唤起签约页

小程序内唤起签约页

协议管理

协议查询

协议解约

协议修改

协议扣款

扣款

交易撤销

交易退款

查询对账单