Alipay Open Platform

https://opendocs.alipay.com/open
Admin
Alipay Open Platform provides APIs, SDKs, and developer tools for integrating Alipay payment...
Tokens:122,735
Snippets:574
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Alipay Eco Edu Kt Billing Modify Response Example

Source: https://opendocs.alipay.com/open/02auyv

Shown as the response example for the billing modification API. The source labels it as a normal example and notes that it is for reference only.

```json
{
    "alipay_eco_edu_kt_billing_modify_response": {
        "code": "10000",
        "msg": "Success",
        "status": "Y"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
```

--------------------------------

### Initialize AlipayClient with public key certificate mode (Java)

Source: https://opendocs.alipay.com/open/009yp8

Initializes the AlipayClient for the public key certificate signing mode. Set the certificate paths and other required parameters, then use certificateExecute to submit data to Alipay. This mode requires the additional JAR packages bcprov-jdk15on, commons-logging, and fastjson.

```java
CertAlipayRequest certAlipayRequest = new CertAlipayRequest ();
certAlipayRequest.setServerUrl(URL);
certAlipayRequest.setAppId(APPID);
certAlipayRequest.setPrivateKey(APP_PRIVATE_KEY);
certAlipayRequest.setFormat("JSON");
certAlipayRequest.setCharset(CHARSET);
certAlipayRequest.setSignType(SIGN_TYPE);
certAlipayRequest.setCertPath(app_cert_pathAPP_CERT_PATH);
certAlipayRequest.setAlipayPublicCertPath(alipay_cert_path);
certAlipayRequest.setRootCertPath(alipay_root_cert_path );
DefaultAlipayClient alipayClient = new DefaultAlipayClient(certAlipayRequest);
// 提交数据至支付宝时请使用 
alipayClient.certificateExecute(request);
```

--------------------------------

### 普通公钥模式调用 alipay.trade.precreate

Source: https://opendocs.alipay.com/open/009yp8

使用普通公钥模式调用支付宝预下单接口 alipay.trade.precreate。需要先初始化 AlipayClient，传入网关地址、应用ID、应用私钥、格式、字符集、支付宝公钥和签名类型 RSA2。创建 AlipayTradePrecreateRequest 并设置业务参数，然后通过 alipayClient.execute(request) 同步获取响应。

```java
// 获得初始化的AlipayClient 
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do",APP_ID,APP_PRIVATE_KEY,"json",CHARSET,ALIPAY_PUBLIC_KEY,"RSA2");  
// 创建API对应的request类 
AlipayTradePrecreateRequest request = new AlipayTradePrecreateRequest ();
 request.setBizContent ("{"   + 
 "\"out_trade_no\":\"20150320010101002\","   + //商户订单号 
 "\"total_amount\":\"88.88\","   + 
 "\"subject\":\"Iphone6 16G\","   + 
 "\"store_id\":\"NJ_001\","   + 
 "\"timeout_express\":\"90m\"}" ); //订单允许的最晚付款时间 
 AlipayTradePrecreateResponse response = alipayClient.execute( request );
 System.out.print(response.getBody());
 // 根据response中的结果继续业务逻辑处理
```

--------------------------------

### Message example for ant.merchant.expand.shop.save.rejected

Source: https://opendocs.alipay.com/open/03s3jn

Example of the message sent when a shop creation is rejected. The biz_content contains the order_id, reason, shop_id, shop_name, biz_source, msg_type, out_biz_no, and store_id. The message includes the required public parameters and signature.

```plaintext
ISV_GATEWAY_URL?charset=GBK&biz_content=
{
"order_id":"2018011900502000000005124744",
"reason":"资料有问题，拒绝",
"shop_id":"2020081400077000000001112602",
"shop_name":"支付宝（西溪路店）",
"biz_source":"APLUS_SHOP",
"msg_type":"SHOP_SETTLE_AUDIT",
"out_biz_no":"0001119901210328000565010000",
"store_id":"NO0001"
}
&msg_method=ant.merchant.expand.shop.save.rejected&utc_timestamp=1516797622752&version=1.1&sign_type=RSA2&notify_id=d275fec564e62af6bedbcee73f3f05fi5x&app_id=2013121700999429&sign=I+Y/lvqYUEEc10EPdpntRhFIQ==
```

--------------------------------

### cURL 请求示例：alipay.iservice.ccm.sw.tree.create

Source: https://opendocs.alipay.com/open/df029ced_alipay.iservice.ccm.sw.tree.create

调用 alipay.iservice.ccm.sw.tree.create 接口创建知识库类目的 cURL 请求示例。请求参数通过 biz_content 传递，包含 ccs_instance_id 和 name。示例仅供参考。

```bash
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.iservice.ccm.sw.tree.create&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'app_auth_token=${app_auth_token}' \
 -F 'biz_content={
	"ccs_instance_id":"ZPNASDK",
	"name":"蚂蚁科技"
}' 
```

--------------------------------

### API Response Example

Source: https://opendocs.alipay.com/open/02awe4

A standard JSON response structure for a successful historical balance query, including the beginning and ending balance fields.

```JSON
{
    "alipay_data_bill_balancehis_query_response": {
        "code": "10000",
        "msg": "Success",
        "beginning_balance": "10000.00",
        "ending_balance": "11000.00"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
```

--------------------------------

### Initialize AlipayClient with normal public key mode (Java)

Source: https://opendocs.alipay.com/open/009yp8

Initializes the AlipayClient object for the normal public key signing mode. Configure the required parameters such as server URL, APPID, private key, format, charset, Alipay public key, and sign type before constructing the client. The client can be reused for multiple API calls.

```java
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl(URL);
alipayConfig.setAppId(APP_ID);
alipayConfig.setPrivateKey(PRIVATE_KEY);
alipayConfig.setFormat("json");
alipayConfig.setCharset(CHARSET);
alipayConfig.setAlipayPublicKey(ALIPAY_PUBLIC_KEY);
alipayConfig.setSignType(SIGN_TYPE);
//构造client
AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
```

--------------------------------

### cURL Request for alipay.data.bill.balancehis.query

Source: https://opendocs.alipay.com/open/02awe4

A cURL example demonstrating how to call the historical balance query API. Note that the sign and appid parameters must be replaced with your actual credentials.

```cURL
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.data.bill.balancehis.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'biz_content={
	"biz_date":"2019-08-01",
	"biz_month":"2019-08"
}'
```

--------------------------------

### ant.merchant.expand.shop.save.rejected(门店保存拒绝消息)

Source: https://opendocs.alipay.com/open/03s3jn

该接口用于在 ant.merchant.expand.shop.create 中创建商户时，如果创建被拒绝，通过此接口返回拒绝结果。

```APIDOC
## ant.merchant.expand.shop.save.rejected(门店保存拒绝消息)

### Description
该接口用于在 ant.merchant.expand.shop.create 中创建商户时，如果创建被拒绝，通过此接口返回拒绝结果。

### Method
POST

### Endpoint
ISV_GATEWAY_URL

### Parameters
#### Query Parameters
- **charset** (String) - Required - 编码集，该字符集为验签和解密所需要的字符集，示例值：GBK
- **biz_content** (String) - Required - 消息报文，参见消息属性
- **msg_method** (String) - Required - 消息接口名称，示例值：ant.merchant.expand.shop.save.rejected
- **utc_timestamp** (String) - Required - 消息发送时的服务端时间，示例值：1516797622752
- **version** (String) - Required - 版本号(1.1版本为标准消息)，示例值：1.1
- **sign_type** (String) - Required - 签名类型，示例值：RSA2
- **notify_id** (String) - Required - 通知ID，示例值：d275fec564e62af6bedbcee73f3f05fi5x
- **app_id** (String) - Required - 消息接受方的应用id，示例值：2013121700999429
- **sign** (String) - Required - 签名，示例值：I+Y/lvqYUEEc10EPdpntRhFIQ==

#### Request Body
- **order_id** (String) - Required - 申请单id，示例值：2018011900502000000005124744
- **reason** (String) - Required - 拒绝原因，示例值：资料有问题，拒绝
- **shop_id** (String) - Required - 支付宝侧门店id，门店创建成功后支付宝返回的门店 id，示例值：2020081400077000000001112602
- **shop_name** (String) - Required - 门店名称，示例值：支付宝（西溪路店）
- **biz_source** (String) - Optional - 业务来源，团购门店：APLUS_SHOP，示例值：APLUS_SHOP
- **msg_type** (String) - Optional - 消息类型，枚举值：门店结算审核: SHOP_SETTLE_AUDIT，示例值：SHOP_SETTLE_AUDIT
- **out_biz_no** (String) - Optional - 外部业务号，前四位为约定的系统标识符，四位以后部分为外围传入的外部单号，示例值：0001119901210328000565010000
- **store_id** (String) - Optional - 商家侧门店编号，创建门店时由商家自定义传入的编号值，示例值：NO0001

### Request Example
```
ISV_GATEWAY_URL?charset=GBK&biz_content=
{
"order_id":"2018011900502000000005124744",
"reason":"资料有问题，拒绝",
"shop_id":"2020081400077000000001112602",
"shop_name":"支付宝（西溪路店）",
"biz_source":"APLUS_SHOP",
"msg_type":"SHOP_SETTLE_AUDIT",
"out_biz_no":"0001119901210328000565010000",
"store_id":"NO0001"
}
&msg_method=ant.merchant.expand.shop.save.rejected&utc_timestamp=1516797622752&version=1.1&sign_type=RSA2&notify_id=d275fec564e62af6bedbcee73f3f05fi5x&app_id=2013121700999429&sign=I+Y/lvqYUEEc10EPdpntRhFIQ==
```

### Response
#### Success Response (200)
- **响应值** (String) - 描述 - 是否重试
- **fail** (String) - 消息获取失败 - 是
- **success** (String) - 消息获取成功 - 否

#### Response Example
```
{
  "响应值": "success"
}
```
```
Tokens:
Raw