> ## 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.

# Apple Pay 支付接入指南

> 了解 Apple Pay 支付集成方案，包括设备要求、代收 API、前置组件和 Token 获取方式。

> [!WARNING]
>
> **阅读该接口文档前，务必先查看 [接口说明](https://doc.haipay.net/zh/history/V20260801/get-started/api-conventions.md)**

> [!TIP]
>
> 通过[支付链接](https://doc.haipay.net/zh/history/V20260801/payments/cards/payment-links.md)或[前置组件](https://doc.haipay.net/zh/history/V20260801/payments/cards/payment-element.md)快速集成 Apple Pay。

## 设备和浏览器要求

> [!TIP]
>
> 如果您在支付页面中看不到 Apple Pay 按钮，则您的设备或浏览器可能不符合以下条件。
>
> * 钱包里必须至少有一张卡。
> * 您必须使用兼容的 [Apple Pay 设备](https://support.apple.com/zh-cn/102896)。
> * 您必须使用 **HTTPS** 和[支持的浏览器](#supported-browsers)来测试。
> * 允许 Safari 访问您的钱包：**设置** > **高级** > **允许网站检查 Apple Pay 和 Apple 卡**
> * 不要使用 Safari 私人窗口。
> * 确认您在受支持的 Apple Pay 地区进行操作。
> * 确认您的设备支持[生物识别身份验证](https://support.apple.com/zh-cn/102626#:~:text=iPhone%20or%20.iPad,on%20all%20devices.)。

> [!TIP]
>
> **桌面浏览器**
>
> * Safari 10.1+
> * Chrome 38+
>
> **移动浏览器**
>
> * iOS Safari 9+ 以及其他使用系统提供的 WebKit 引擎的浏览器和 Web 视图
> * Android Chrome 38+
>
> **其他说明**
>
> 对于未明确支持的浏览器，我们限制支持如下：
>
> * 要求浏览器支持 **TLS 1.2**
> * 需要足够现代的浏览器来支持 JavaScript 中的 **Promises**
> * 我们会响应错误报告，但不会主动测试其他浏览器

> [!CAUTION]
>
> Apple Pay 仅在部分国家和地区可用。请查看 [支持的国家和地区列表](https://doc.haipay.net/zh/history/V20260801/payments/cards/supported-regions.md) 确认您的目标市场是否可用。

## 限额

| 交易类型 | 限额(单位:USD) |
| :- | - |
| 代收 | 0.99-1000 |

## 代收 API

### 代收申请

**简要描述：**

* 查询代收订单

**URL：**

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

**参数：**

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

**请求示例**

```json theme={null}
{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "299.99",
  "phone": "02012345678",
  "email": "robert.taylor@gmail.com",
  "name": "Robert Taylor",
  "inBankCode": "APPLE_PAY",
  "payType": "EWALLET",
  "partnerUserId": "149597870",
  "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}
```

**响应示例**

```json theme={null}
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M233323000059",
    "orderNo": "6023071013539074",
    "payUrl": "",
    "clientToken": "",
    "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
  }
}
```

返回data参数说明

| 参数名 | 类型 | 说明 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| payUrl | String | 支付链接 |
| clientToken | String | 在前置组件中使用的客户端令牌 (见[前置组件](https://doc.haipay.net/zh/history/V20260801/payments/cards/payment-element.md)) |
| sign | String | 签名 |

### 代收查询

**简要描述：**

* 查询代收订单

**URL：**

美元: `/usd/collect/query`

**参数：**

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

**请求示例**

```json theme={null}
{
  "appId": 1054,
  "orderId": "M22222000028",
  "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}
```

**响应示例**

```json theme={null}
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M22222000028",
    "orderNo": "6023042811314347",
    "amount": "299.99",
    "actualAmount": "0.00",
    "fee": "0.00",
    "status": 1,
    "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
  }
}
```

返回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 | 签名 |

## 支付方式

| 币种 | 支付类型(payType) | 支付编码(inBankCode) | 限额 | 状态 | 说明 |
| :- | :- | :- | :- | :- | :- |
| USD | EWALLET | APPLE\_PAY | 0.99-1000 | 可用 | Apple Pay |

## 相关主题

* [前置组件](https://doc.haipay.net/zh/history/V20260801/payments/cards/payment-element.md)
* [支付链接](https://doc.haipay.net/zh/history/V20260801/payments/cards/payment-links.md)
* [Google Pay](https://doc.haipay.net/zh/history/V20260801/payments/cards/google-pay.md)
* [国际信用卡(VISA/MASTER)](https://doc.haipay.net/zh/history/V20260801/payments/cards/overview.md)
* [处理异步通知并验证签名](https://doc.haipay.net/zh/history/V20260801/operations/callback.md)
* [使用测试卡号模拟支付成功、拒付与争议场景](https://doc.haipay.net/zh/history/V20260801/testing/test-cards.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.