> For the complete documentation index, see [llms.txt](https://useepay.gitbook.io/developer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://useepay.gitbook.io/developer/reference/local-pay-ben-di-hua/ben-di-hua-jie-kou/dian-zi-qian-bao/wechat-hk/jsapi.md).

# Jsapi支付下单接口

## Pay接口

## jsapi支付下单接口

<mark style="color:green;">`POST`</mark> `USEEPAY_PATH/api`

#### Headers

| Name                                           | Type   | Description                       |
| ---------------------------------------------- | ------ | --------------------------------- |
| content-type<mark style="color:red;">\*</mark> | String | application/x-www-form-urlencoded |

#### Request Body

| Name                                              | Type         | Description                                                                                   |
| ------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------- |
| transactionType<mark style="color:red;">\*</mark> | String       | <p></p><p></p><p>交易类型 : <strong>pay</strong> </p>                                             |
| version<mark style="color:red;">\*</mark>         | String(5)    | 目前固定为 1.0 (5)                                                                                 |
| signType<mark style="color:red;">\*</mark>        | String       | 商户生成签名字符串所使用的签名算法类型，目前支持：RSA/MD5                                                              |
| merchantNo<mark style="color:red;">\*</mark>      | String(16)   | 商户号                                                                                           |
| transactionId<mark style="color:red;">\*</mark>   | String(64)   | 商户订单号                                                                                         |
| transactionExpirationTime                         | String(6)    | 可选，默认为20分钟 .范围1-20                                                                            |
| appId<mark style="color:red;">\*</mark>           | String (128) | 网站域名                                                                                          |
| amount<mark style="color:red;">\*</mark>          | String(12)   | 支付金额，单位为对应币种的最小货币单位[(详见 ISO 4217)](/developer/gui-fan-xing-shuo-ming/huo-bi-dan-wei.md)       |
| currency<mark style="color:red;">\*</mark>        | String(3)    | 3 位 ISO 大写字母货币代码[(详见 ISO 4217)](/developer/gui-fan-xing-shuo-ming/huo-bi-dan-wei.md) 目前仅支持HKD |
| notifyUrl<mark style="color:red;">\*</mark>       | String(512)  | [异步通知](/developer/reference/notify/notifyurl.md)                                              |
| echoParam                                         | String(256)  | 回声参数，响应报文会原样返回                                                                                |
| payerInfo<mark style="color:red;">\*</mark>       | String       | Json格式的String 付款方信息, 请下方                                                                      |
| orderInfo                                         | String       | json string, 订单信息, 请参考下方                                                                      |

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "amount": "100",
    "redirectUrl": "",
    "resultCode": "pending",
    "sign": "aPkk1Y735aop9iND6byVEACwrhmWHNIRP9Hd/a36wE9g9iYMB2jXklU8QzOrOI3fJefeDl3+JcAE\nUcJXDKI8fjYUGtlA/8VhJuOmyN1xoOWSwgDr1YAGK2B+beOeFTPuWXtSsqnCoO6ebhk1soBVeT3x\nJHmPS4wSoccGXrn/VAQ=\n",
    "errorCode": "3200",
    "transactionId": "1663122582326",
    "errorMsg": "Transaction is pending",
    "transactionType": "pay",
    "reference": "1012209141029011519",
    "redirectMethod": "",
    "echoParam": "echoParam",
    "redirectParam": "{\"timeStamp\":\"1663122586556\",\"package\":\"prepay_id=wx1410294747107604126381be3c62a80000\",\"paySign\":\"qnYD6nuEZc3odQmXeGNvzD6ls65juKBuym6/rH7KClgbOuK9NXCyjC8B300eUEGRNMPlZCuAkiDDSeKj79yn2Vs/QXMwwJKlxuybrRHUw0vEb4oYkt2t0p9ugIQUYkbTzznfCcUKFhPS+lkYZXczBRLjGe+644zWRqnuUTy91h3GD250tbfwlybK+7y1hF6yp/JN9e8WsjXmbXu7Ah9NknMQ3aJtDk8GXD0MWPeylLlFfGo5J7DAIVcXmYrlMf6PKr+7vnwyrLZux24jscWayK6kHepfDQgh+PkZpCEp/hW4x8fltvfgecN3Yq22bsNmlweZWACnzleB8Gl/y6fr8A==\",\"appId\":\"wxbd881f2b1b6c426d\",\"signType\":\"RSA\",\"nonceStr\":\"1663122586556\"}",
    "signType": "RSA",
    "currency": "CNY",
    "merchantNo": "500000000007264"
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Request Body" %}

```
amount=100&appId=www.pay.com&currency=HKD&echoParam=echoParam&merchantNo=500000000007381&notifyUrl=https://gatewaytest.useepay.com/notifyV2u0&orderInfo={"subject":"description"}&payerInfo={"paymentMethod":"wechat_jsapi","sub_appid":"wxbd881f2b1b6c426d","sub_openid":"oOW1us-s_y3xkl3x_VS6fxpBqHp4"}&redirectUrl=https://gatewaytest.useepay.com/gateway-test/redirectV2u0&sign=b9295adac577bae00b337a1c389a68bd&signType=MD5&transactionExpirationTime=2&transactionId=1663212415666&transactionType=pay&version=1.0
```

{% endtab %}

{% tab title="Response Body" %}

```
{
    "amount": "100",
    "redirectUrl": "",
    "resultCode": "pending",
    "sign": "762ee08739e984247c3af43bc5ac3f13",
    "errorCode": "3200",
    "transactionId": "1663212415666",
    "errorMsg": "Transaction is pending",
    "transactionType": "pay",
    "reference": "1012209151126671861",
    "redirectMethod": "",
    "echoParam": "echoParam",
    "redirectParam": "{\"timeStamp\":\"1663212418085\",\"package\":\"prepay_id=wx151126578017180326e42cc8c99e120000\",\"paySign\":\"CwYJyb/loSraqm048bdY13cV3rDYzIGd6ZH87SPWwEoLcijz5nP8aCMpiq1DJLJiGDib+XJsUyUd4DE2iyaDrcQMHj4XJQSz18nWpHq/sMz1ra01C4Uyd3y+wf8BFCiQMD/5V+0ma/ltpC7M8ZewKMinNCXvg0oXiDIgaFufoGEiTDzDzr/t7hoIl3YYiv1Rs7Bz5MZ9oASRiUUzZwqTU1aa42Hx54Ggt+gYaY3/hA7vzeFZBV17dmEEquEwEDsHAGn4Wkbl878OEjYwxBnuKwlrtmFs6R+uNaGA1rmMpZ2htz7D1fSjMpmKM2WofRDgSJ0cAVPSLmqLH7kDWSLYCA==\",\"appId\":\"wxbd881f2b1b6c426d\",\"signType\":\"RSA\",\"nonceStr\":\"1663212418085\"}",
    "signType": "MD5",
    "currency": "HKD",
    "merchantNo": "500000000007381"
}
```

{% endtab %}
{% endtabs %}

### Request 参数详细描述

#### PayerInfo 付款人信息

| 参数            | 必选 | 类型     | 说明                                 |
| ------------- | -- | ------ | ---------------------------------- |
| paymentMethod | Y  | String | 目前固定为 wechat\_jsapi                |
| sub\_appid    | Y  | String | 公众号id                              |
| sub\_openid   | Y  | String | 消费者的[openid](#ru-he-huo-qu-openid) |

#### orderInfo 订单信息

<table><thead><tr><th></th><th>必选</th><th width="250">类型</th><th>说明</th></tr></thead><tbody><tr><td>subject</td><td>Y</td><td>String</td><td>商品标题</td></tr></tbody></table>

### Response

<table><thead><tr><th>字段</th><th>描述</th><th>是否必须</th></tr></thead><tbody><tr><td>resultCode</td><td>业务结果（详见 <a href="/pages/5dsLYen8TqUwNkLk3EqV">业务结果码</a>）<strong>判断交易是否成功的依据</strong> 当前交易涉及的有<strong>:</strong> succeed,pending,failed, closed</td><td>Y</td></tr><tr><td>reference</td><td>USEEPAY 订单号</td><td>N</td></tr><tr><td>transactionType</td><td>支付类型 pay</td><td>Y</td></tr><tr><td>transactionId</td><td>商户订单号</td><td>Y</td></tr><tr><td>sign</td><td>签名</td><td>Y</td></tr><tr><td>echoParam</td><td>回声参数，响应报文会原样返回</td><td>N</td></tr><tr><td>errorMsg</td><td>错误码消息描述</td><td>Y</td></tr><tr><td>errorCode</td><td>错误码（详见 错误码 errorCode）</td><td>Y</td></tr><tr><td>currency</td><td>3 位 ISO 大写字母货币代码<a href="/pages/iMDnjbvzwm4r9OjBcaMt">(详见 ISO 4217)</a></td><td>Y</td></tr><tr><td>amount</td><td>订单金额</td><td>Y</td></tr><tr><td><pre><code>redirectParam
</code></pre></td><td>微信公众号支付需要的参数Json String</td><td>N</td></tr><tr><td><pre><code>signType
</code></pre></td><td>签名类型</td><td>Y</td></tr></tbody></table>

```
{
    "amount": "100",
    "redirectUrl": "",
    "resultCode": "pending",
    "sign": "aPkk1Y735aop9iND6byVEACwrhmWHNIRP9Hd/a36wE9g9iYMB2jXklU8QzOrOI3fJefeDl3+JcAE\nUcJXDKI8fjYUGtlA/8VhJuOmyN1xoOWSwgDr1YAGK2B+beOeFTPuWXtSsqnCoO6ebhk1soBVeT3x\nJHmPS4wSoccGXrn/VAQ=\n",
    "errorCode": "3200",
    "transactionId": "1663122582326",
    "errorMsg": "Transaction is pending",
    "transactionType": "pay",
    "reference": "1012209141029011519",
    "redirectMethod": "",
    "echoParam": "echoParam",
    "redirectParam": "{\"timeStamp\":\"1663122586556\",\"package\":\"prepay_id=wx1410294747107604126381be3c62a80000\",\"paySign\":\"qnYD6nuEZc3odQmXeGNvzD6ls65juKBuym6/rH7KClgbOuK9NXCyjC8B300eUEGRNMPlZCuAkiDDSeKj79yn2Vs/QXMwwJKlxuybrRHUw0vEb4oYkt2t0p9ugIQUYkbTzznfCcUKFhPS+lkYZXczBRLjGe+644zWRqnuUTy91h3GD250tbfwlybK+7y1hF6yp/JN9e8WsjXmbXu7Ah9NknMQ3aJtDk8GXD0MWPeylLlFfGo5J7DAIVcXmYrlMf6PKr+7vnwyrLZux24jscWayK6kHepfDQgh+PkZpCEp/hW4x8fltvfgecN3Yq22bsNmlweZWACnzleB8Gl/y6fr8A==\",\"appId\":\"wxbd881f2b1b6c426d\",\"signType\":\"RSA\",\"nonceStr\":\"1663122586556\"}",
    "signType": "RSA",
    "currency": "CNY",
    "merchantNo": "500000000007264"
}
```

#### redirectParam

| 字段        | 描述                                             | 是否必须 |
| --------- | ---------------------------------------------- | ---- |
| timeStamp | 时间戳                                            | Y    |
| package   | 统一下单接口返回的prepay\_id参数值，提交格式如：prepay\_id=\*\*\* | Y    |
| paySign   | 微信签名                                           | Y    |
| appId     | 公众号名称，由商户传入                                    | Y    |
| signType  | 微信签名方式 固定诶RSA                                  | Y    |
| noceStr   | 随机串                                            | Y    |

```json
{
    "timeStamp": "1663122586556",
    "package": "prepay_id=wx1410294747107604126381be3c62a80000",
    "paySign": "qnYD6nuEZc3odQmXeGNvzD6ls65juKBuym6/rH7KClgbOuK9NXCyjC8B300eUEGRNMPlZCuAkiDDSeKj79yn2Vs/QXMwwJKlxuybrRHUw0vEb4oYkt2t0p9ugIQUYkbTzznfCcUKFhPS+lkYZXczBRLjGe+644zWRqnuUTy91h3GD250tbfwlybK+7y1hF6yp/JN9e8WsjXmbXu7Ah9NknMQ3aJtDk8GXD0MWPeylLlFfGo5J7DAIVcXmYrlMf6PKr+7vnwyrLZux24jscWayK6kHepfDQgh+PkZpCEp/hW4x8fltvfgecN3Yq22bsNmlweZWACnzleB8Gl/y6fr8A==",
    "appId": "wxbd881f2b1b6c426d",
    "signType": "RSA",
    "nonceStr": "1663122586556"
}
```

##
