# API 集成

### 1. 创建链接

::: warning 注意：
详细的API参数请参阅[创建链接](https://docs.payermax.com/api.html?docName=New%20Version&docVer=v1.0&docLang=cn#/paths/aggregate-pay-api-gateway-createPaybylink/post)接口。
:::

请求API；环境及地址如下：

| 请求环境 | 请求地址                                                                    |
| -------- | --------------------------------------------------------------------------- |
| Test     | https://pay-gate-uat.payermax.com/aggregate-pay/api/gateway/createPaybylink |
| Prod     | https://pay-gate.payermax.com/aggregate-pay/api/gateway/createPaybylink     |

请求Header示例：

```json
{
    'Content-Type': 'application/json;charset=utf-8',
    'Accept': 'application/json',
    'sign': <参考 https://docs.payermax.com/202606-version/developer/signature-rules.html>
};
```

请求Body示例：

```json
{
	"appId": <商户后台appid>,
    "merchantNo": <商户号>,
	"keyVersion": "1",
	"requestTime": "2024-02-27T13:45:36.960+08:00",
	"version": "1.1",
    "data": {
        "merchantLinkId": "paylinktest999",
        "linkType": "ONETIME",
        "expiresTime": "86400",
        "country": "ID",
        "currency": "IDR",
        "totalAmount": "40000",
        "language": "en",
        "description": "冬季新款运动鞋",
        "linkDescription": "链接收款衣物鞋帽",
        "userInfo": {
            "userId": "98",
            "username": "payermax"
        },
        "goodsDetails": [
            {
                "goodsName": "运动鞋",
                "goodsDescription": "冬季新款减震跑步运动鞋",
                "quantity": "2",
                "price": "20000",
                "goodsCurrency": "IDR",
                "showUrl": "http://www.baidu.com"
            }
        ],
        "notifyUrl": "http://www.baidu.com"
    }
}
```

请求Response示例：

```json
{
    "msg": "Success.",
    "code": "APPLY_SUCCESS",
    "data": {
        "linkStatus": "ACTIVE",
        "linkId": "BYLqPQaQlD",
        "qrCodeUrl": "https://img-cdn.shareitpay.in/qrcode/20240227054625j6r5x8.png",
        "linkUrl": "http://uat.payermax.link/uat/#/BYLqPQaQlD",
        "merchantLinkId": "paylinktest999",
        "expiresAt": "2024-02-28T05:46:25Z"
    }
}
```

### 2. 查询链接详情

+ [查询链接详情](https://docs.payermax.com/api.html?docName=New%20Version&docVer=v1.0&docLang=cn#/paths/aggregate-pay-api-gateway-queryPaybylink/post)接口中会返回链接失效的具体时间
+ 此接口只是链接状态查询，并不代表订单状态

### 3. 失效支付链接

+ 在用户完成支付前，您可以提前调用[失效支付链接](https://docs.payermax.com/api.html?docName=New%20Version&docVer=v1.0&docLang=cn#/paths/aggregate-pay-api-gateway-expirePaybylink/post)接口将链接失效，失效后用户将无法打开支付
+ 如果用户已经完成支付，此功能将无法使用

### 4. 支付链接更新回调

您需要在后台添加链接支付的回调地址。

![](https://img-cdn-sg.payermax.com/public/20240913-7f526425-f773-474a-b5a6-77dd3f23891e.png)

我们会将链接更新的状态通过您配置的地址回调到服务端，回调数据请参阅[支付链接更新回调](https://docs.payermax.com/api.html?docName=New%20Version&docVer=v1.0&docLang=cn#/paths/payLinkResultNotifyUrl/post)接口。