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

## **限额**

| 交易类型 | 限额                            |
| :--- | :---------------------------- |
| 代收   | 沙特里亚尔：2-10000, 美元: 0.5 - 2500 |

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

## **代收API**

### **代收申请**

**简要描述：**

* 创建代收订单

**URL：**

沙特: `/sar/collect/apply`
说明：appId需使用沙特里亚尔对应的，用户支付成功后增加沙特里亚尔余额

**参数：**

| 参数名             | 必选 | 类型     | 说明                                                                                         |
| :-------------- | :- | :----- | :----------------------------------------------------------------------------------------- |
| appId           | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID）                                                            |
| orderId         | 是  | String | 商户订单号(必须保证唯一性，长度不超过48)                                                                     |
| name            | 是  | String | 收款人姓名，用于风险控制                                                                               |
| phone           | 是  | String | 真实手机号（格式参考 [电话号码格式](/docs/zh/guide/frequently_asked_question#zh_faq_phone-number-format) ） |
| email           | 是  | String | 真实电子邮件                                                                                     |
| amount          | 是  | String | 交易金额（单位：本币，精确到小数点后两位；禁止添加标点符号，例如：","），测试环境请使用10SAR以下的金额                                    |
| currency        | 否  | String | 币种(USD,本币)                                                                                 |
| payType         | 是  | String | 交易类型                                                                                       |
| inBankCode      | 是  | String | [支付方式](#inBankCode)                                                                        |
| callBackUrl     | 是  | String | 用户支付成功后跳转地址                                                                                |
| callBackFailUrl | 是  | String | 用户支付失败后跳转地址                                                                                |
| notifyUrl       | 否  | String | 回调地址                                                                                       |
| goodsName       | 是  | String | 商品名称                                                                                       |
| goodsQuantity   | 是  | String | 商品数量                                                                                       |
| goodsPrice      | 是  | String | 商品单价                                                                                       |
| goodsSku        | 是  | String | 商品唯一标识                                                                                     |
| goodsAvatar     | 是  | String | 商品图(https\://)                                                                             |
| platform        | 是  | String | 平台名称                                                                                       |
| subject         | 否  | String | 支付备注                                                                                       |
| body            | 否  | String | 备注详情                                                                                       |
| partnerUserId   | 是  | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。            |
| sign            | 是  | String | 签名                                                                                         |

#####

request

```json theme={null}
{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "300",
  "phone": "09230219312",
  "email": "23423@qq.com",
  "name": "test",
  "inBankCode": "STCPay",
  "payType": "PAYMENT_GATEWAY",
  "partnerUserId": "149597870",
  "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}
```

response

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

返回data参数说明

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

### **代收查询**

**简要描述：**

* 创建代收订单
* 当"payType=BANK\_TRANSFER" 时同步返回orderNo可以直接查询
* 其他支付方式异步通知后，通过orderNo查询二次确认状态

**URL：**

沙特: `/sar/collect/query`

**参数：**

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

request

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

response

```json theme={null}
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M22222000028",
    "orderNo": "6023042811314347",
    "amount": "50.00",
    "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  | 签名                                                  |

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

#### 沙特阿拉伯

| 币种  | 支付类型(payType)    | 支付编码(inBankCode)  | 限额       | 状态 | 说明                        |
| --- | ---------------- | ----------------- | -------- | -- | ------------------------- |
| SAR | PAYMENT\_GATEWAY | CARD              | 2-10000  | 可用 | 支持 VISA, MasterCard, Mada |
| SAR | PAYMENT\_GATEWAY | STCPAY            | 2-10000  | 可用 | STCPay钱包                  |
| SAR | EWALLET          | APPLE\_PAY        | 2-10000  | 可用 | Apple Pay                 |
| USD | PAYMENT\_GATEWAY | SA\_CARD\_USD     | 0.5-2500 | 可用 | 支持 VISA, MasterCard, Mada |
| USD | PAYMENT\_GATEWAY | SA\_STCPAY\_USD   | 0.5-2500 | 可用 | STCPay钱包                  |
| USD | EWALLET          | SA\_APPLEPAY\_USD | 0.5-2500 | 可用 | Apple Pay                 |

## 相关主题

* [公共接口](/docs/zh/api/version2/CommonApi)
* [HaiPay 接口说明与公共规则](/docs/zh/guide/api_description_guide)
* [埃及支付接口](/docs/zh/api/version2/Egypt)
