> ## Documentation Index
> Fetch the complete documentation index at: https://doc.haipay.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 香港地区

<Warning>
  **阅读该接口文档前，务必先查看 [**接口说明**](/docs/zh/guide/api_description_guide)**
</Warning>

## **限额**

| 交易类型 | 限额                          |
| :--- | --------------------------- |
| 代收   | 美元: 0.99-499.99, 港元: 1-5000 |

> **金额小数位：** HKD — 2位小数 | USD — 2位小数

## **代收API**

### **代收申请**

**简要描述：**

* 创建代收订单

**URL：**

港币: `/hkd/collect/apply`
说明：appId需使用港元对应的，用户支付成功后增加港元余额

美元: `/usd/collect/apply`
说明：appId需使用美元对应的，用户支付成功后增加美元余额

**参数：**

| 参数名             | 必选 | 类型     | 说明                                                                                          |
| :-------------- | :- | :----- | :------------------------------------------------------------------------------------------ |
| appId           | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID）                                                             |
| orderId         | 是  | String | 商户订单号(必须保证唯一性，长度不超过48)                                                                      |
| name            | 是  | String | 用户姓名，推荐使用真实姓名，格式：包含firstName和lastName，以空格分割的，示例：John Doe                                    |
| phone           | 是  | String | 真实手机号，（格式参考 [电话号码格式](/docs/zh/guide/frequently_asked_question#zh_faq_phone-number-format) ） |
| email           | 是  | String | 真实电子邮件                                                                                      |
| amount          | 是  | String | 交易金额，最多两位小数                                                                                 |
| payType         | 是  | String | 交易类型                                                                                        |
| inBankCode      | 是  | String | [支付方式](#inBankCode)                                                                         |
| callBackUrl     | 是  | String | 用户支付成功后跳转地址                                                                                 |
| callBackFailUrl | 是  | String | 用户支付失败后跳转地址                                                                                 |
| cancelUrl       | 否  | String | 如果传递，支付页面会展示返回按钮，用户点击跳转至该链接                                                                 |
| notifyUrl       | 否  | String | 回调地址                                                                                        |
| subject         | 否  | String | 支付备注                                                                                        |
| body            | 否  | String | 备注详情                                                                                        |
| partnerUserId   | 是  | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。             |
| sign            | 是  | String | 签名                                                                                          |

返回data参数说明

| 参数名     | 类型     | 说明             |
| :------ | :----- | :------------- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号          |
| payUrl  | String | 支付链接           |
| sign    | String | 签名             |

### **代收查询**

**简要描述：**

* 查询代收订单

**URL：**

港币: `/hkd/collect/query`

美元: `/usd/collect/query`

**请求方式：**

*

| 参数名     | 必选 | 类型     | 说明                              |
| :------ | :- | :----- | :------------------------------ |
| appId   | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是  | String | 商户订单号                           |
| orderNo | 否  | String | 平台订单号（响应快）                      |
| sign    | 是  | String | 签名                              |

返回data参数说明

| 参数名          | 类型      | 说明                                                  |
| :----------- | :------ | :-------------------------------------------------- |
| orderId      | String  | 商户订单号(必须保证唯一性)                                      |
| orderNo      | String  | 平台订单号                                               |
| amount       | String  | 交易金额                                                |
| actualAmount | String  | 收到金额                                                |
| fee          | String  | 手续费                                                 |
| status       | Integer | 状态(0未开始，1支付中，2成功（终态），3失败（终态）, -1异常待确认)              |
| payTime      | String  | 支付成功时间（当status=2时有值）(币种时间), 格式: yyyy-MM-dd HH:mm:ss |
| errorMsg     | String  | 支付失败原因（当status=3时有值）                                |
| sign         | String  | 签名                                                  |

### **支付方式**<a id="inBankCode" />

| 币种  | 支付类型(accountType) | 支付编码(bankCode)           | 限额          | 状态 | 说明       |
| :-- | :---------------- | :----------------------- | :---------- | :- | :------- |
| HKD | EWALLET           | WXPAY\_SCANCODE          | 1-1000      | 可用 | 香港微信扫码支付 |
| HKD | EWALLET           | ALIPAY\_HKD              | 1-5000      | 可用 | AlipayHK |
| USD | EWALLET           | HK\_WXPAY\_SCANCODE\_USD | 0.99-120    | 可用 | 香港微信扫码支付 |
| USD | BANK\_TRANSFER    | ALIPAY\_USD              | 0.99-499.99 | 可用 | AlipayHK |
| USD | BANK\_TRANSFER    | PAYME\_USD               | 1-1000      | 维护 | PayMe    |

## 相关主题

* [公共接口](/docs/zh/api/version2/CommonApi)
* [HaiPay 接口说明与公共规则](/docs/zh/guide/api_description_guide)
* [台湾地区支付接口](/docs/zh/api/version2/Taiwan)