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

# 南非支付接口

> 南非（ZAR）本地支付接入指南，支持调用 ZAR 代收申请、代收查询、代付申请与代付查询接口。

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

## **限额**

| 交易类型 | 限额 |
| :- | - |
| 代收 | ZAR: 2.00-150000.00 |
| 代付 | ZAR: 100.00-50000.00 |

> **金额小数位：** ZAR — 2位小数

## **代收API**

> [!TIP]
>
> 1. 南非代收支持 Pay with Bank / Instant EFT（payType 固定传 BANK\_TRANSFER），用户选择银行后重定向到对应银行页面完成支付。
> 2. 支付完成后用户会被重定向回商户的 callBackUrl（成功）或 callBackFailUrl（失败），同时平台会异步回调 notifyUrl。

### **代收申请**

**简要描述：**

* 创建代收订单

**URL：`/zar/collect/apply`**

**参数：**

| 参数名 | 必选 | 类型 | 说明 |
| :- | :- | :- | :- |
| appId | 是 | Long | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是 | String | 商户订单号(必须保证唯一性，长度不超过48) |
| name | 是 | String | 付款人姓名 |
| phone | 是 | String | 付款人手机号 |
| email | 是 | String | 付款人电子邮箱 |
| amount | 是 | String | 交易金额，最多两位小数 范围:2.00-150,000.00 |
| payType | 是 | String | 支付方式类型，固定传：BANK\_TRANSFER |
| inBankCode | 是 | String | [支付方式编码](#inBankCode) |
| callBackUrl | 是 | String | 支付成功后的跳转地址 |
| callBackFailUrl | 是 | String | 支付失败后的跳转地址 |
| notifyUrl | 否 | String | 回调地址 |
| subject | 是 | String | 支付备注 |
| body | 否 | String | 备注详情 |
| partnerUserId | 是 | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。 |
| sign | 是 | String | 签名 |

#####

request

```json theme={null}
{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "500.00",
    "phone": "0712345678",
    "email": "sipho.nkosi@gmail.com",
    "name": "Sipho Nkosi",
    "inBankCode": "250655",
    "payType": "BANK_TRANSFER",
    "callBackUrl": "https://merchant.com/payment/success",
    "callBackFailUrl": "https://merchant.com/payment/fail",
    "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": "https://pay.haipay.asia/cashier/1L9zQS2",
        "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
    }
}
```

返回data参数说明

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

### **代收查询**

**简要描述：**

* 查询代收订单

**URL：`/zar/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": "50000.00",
        "actualAmount": "0.00",
        "fee": "0.00",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+9AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKILw=="
    }
}
```

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

### **支付方式**

| Currency | Payment Type (payType) | Payment Code (inBankCode) | Limit | Status | Description |
| - | - | - | - | - | - |
| ZAR | BANK\_TRANSFER | Standard Bank | 2.00-150000.00 | 可用 | Standard Bank |
| ZAR | BANK\_TRANSFER | Nedbank | 2.00-150000.00 | 可用 | Nedbank |
| ZAR | BANK\_TRANSFER | FNB | 2.00-150000.00 | 可用 | FNB |
| ZAR | BANK\_TRANSFER | African Bank | 2.00-150000.00 | 可用 | African Bank |
| ZAR | BANK\_TRANSFER | Bidvest Bank | 2.00-150000.00 | 可用 | Bidvest Bank |
| ZAR | BANK\_TRANSFER | Investec | 2.00-150000.00 | 可用 | Investec |
| ZAR | BANK\_TRANSFER | ABSA | 2.00-150000.00 | 可用 | ABSA |
| ZAR | BANK\_TRANSFER | TymeBank | 2.00-150000.00 | 可用 | TymeBank |

## **代付API**

### **代付申请**

**简要描述：**

* 创建代付订单

**URL：`/zar/pay/apply`**

**参数：**

| 参数名 | 必选 | 类型 | 说明 |
| :- | :- | :- | :- |
| appId | 是 | Long | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是 | String | 商户订单号(必须保证唯一性，长度不超过48) |
| amount | 是 | String | 交易金额，最多两位小数 范围:100.00-50,000.00 |
| accountType | 是 | String | 账户类型： BANK\_ACCOUNT |
| bankCode | 是 | String | [银行代码](#支付方式) |
| accountNo | 是 | String | 用户银行账号 |
| name | 是 | String | 收款人姓名(格式：仅限英文字符，1-30位,"firstName middleName lastName" (middleName 非必填, 不支持特殊字符和数字)) |
| phone | 是 | String | 真实手机号 |
| email | 是 | String | 真实电子邮件 |
| notifyUrl | 否 | String | 回调地址 |
| subject | 否 | String | 支付备注（交易标题，商品名称，支付原因） |
| body | 否 | String | 备注详情 |
| partnerUserId | 是 | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。 |
| sign | 是 | String | 签名 |

#####

request（accountType为BANK\_ACCOUNT类型时）

```json theme={null}
{
    "appId": 1054,
    "orderId": "M100000450012",
    "amount": "500.00",
    "accountType": "BANK_ACCOUNT",
    "bankCode": "051001",
    "accountNo": "12345678901",
    "name": "Sipho Nkosi",
    "phone": "0712345678",
    "email": "sipho.nkosi@gmail.com",
    "subject": "iphone13",
    "body": "ProMotion technology with adaptive refresh rates up to 120Hz",
    "partnerUserId": "149597870",
    "sign": "I1PeK3eJOVsFFNowxVRqMXpeWm1lr/BcRpBi8WsW4wVo1+5CC3JsrFq/m/L2O69NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p18oe7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}
```

response

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
    "orderId": "M100000450013",
    "orderNo": "3023062014149637",
    "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
}
}
```

返回data参数说明

| 参数名 | 必选 | 类型 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| sign | String | 签名 |

### **代付查询**

**简要描述：**

* 查询代付订单

**URL：`/zar/pay/query`**

**参数：**

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

request

```json theme={null}
{
    "appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}
```

response — 订单失败

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "amount": "100000.00",
    "fee": "0.00",
    "status": 3,
    "errorMsg": "error",
    "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
}
}
```

response — 订单成功

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
    "orderId": "M1234567112",
    "orderNo": "3022111517401574",
    "amount": "100000.00",
    "fee": "1003.00",
    "status": 2,
    "payTime": "2024-03-01 23:59:59",
    "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
}
}
```

返回data参数说明

| 参数名 | 类型 | 说明 |
| :- | :- | :- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号 |
| amount | 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 | 签名 |

### **支付方式**

> **银行代码**
>
> | Currency | Payment Type (accountType) | Payment Code (bankCode) | Limit | Status | Description |
> | - | - | - | - | - | - |
> | ZAR | BANK\_ACCOUNT | Standard Bank | 100.00-50000.00 | 可用 | Standard Bank |
> | ZAR | BANK\_ACCOUNT | Nedbank | 100.00-50000.00 | 可用 | Nedbank |
> | ZAR | BANK\_ACCOUNT | FNB | 100.00-50000.00 | 可用 | FNB |
> | ZAR | BANK\_ACCOUNT | RMB | 100.00-50000.00 | 可用 | RMB |
> | ZAR | BANK\_ACCOUNT | CitiBank | 100.00-50000.00 | 可用 | CitiBank |
> | ZAR | BANK\_ACCOUNT | Access Bank | 100.00-50000.00 | 可用 | Access Bank |
> | ZAR | BANK\_ACCOUNT | African Bank | 100.00-50000.00 | 可用 | African Bank |
> | ZAR | BANK\_ACCOUNT | Ubank Limited | 100.00-50000.00 | 可用 | Ubank Limited |
> | ZAR | BANK\_ACCOUNT | Bidvest Bank | 100.00-50000.00 | 可用 | Bidvest Bank |
> | ZAR | BANK\_ACCOUNT | Old Mutual Bank | 100.00-50000.00 | 可用 | Old Mutual Bank |
> | ZAR | BANK\_ACCOUNT | Capitec Bank | 100.00-50000.00 | 可用 | Capitec Bank |
> | ZAR | BANK\_ACCOUNT | Investec | 100.00-50000.00 | 可用 | Investec |
> | ZAR | BANK\_ACCOUNT | HSBC Bank | 100.00-50000.00 | 可用 | HSBC Bank |
> | ZAR | BANK\_ACCOUNT | ABSA | 100.00-50000.00 | 可用 | ABSA |
> | ZAR | BANK\_ACCOUNT | TymeBank | 100.00-50000.00 | 可用 | TymeBank |
> | ZAR | BANK\_ACCOUNT | Discovery Bank | 100.00-50000.00 | 可用 | Discovery Bank |
> | ZAR | BANK\_ACCOUNT | Sasfin Bank | 100.00-50000.00 | 可用 | Sasfin Bank |
> | ZAR | BANK\_ACCOUNT | Standard Chartered Bank | 100.00-50000.00 | 可用 | Standard Chartered Bank |
> | ZAR | BANK\_ACCOUNT | Albaraka Bank | 100.00-50000.00 | 可用 | Albaraka Bank |
> | ZAR | BANK\_ACCOUNT | Bank Zero | 100.00-50000.00 | 可用 | Bank Zero |

## 相关主题

* [公共接口](https://doc.haipay.net/zh/history/V20260701/api/version2/CommonApi.md)
* [HaiPay 接口说明与公共规则](https://doc.haipay.net/zh/history/V20260701/get-started/api-conventions.md)
* [全球收银台支付接口](https://doc.haipay.net/zh/history/V20260701/payments/cashier.md)
* [南非 — 南非兰特代收申请 (POST /zar/collect/apply)](https://doc.haipay.net/zh/history/V20260701/api-reference/zar/collect-apply.md)
* [南非 — 南非兰特代收查询 (POST /zar/collect/query)](https://doc.haipay.net/zh/history/V20260701/api-reference/zar/collect-query.md)
* [南非 — 南非兰特代付申请 (POST /zar/pay/apply)](https://doc.haipay.net/zh/history/V20260701/api-reference/zar/pay-apply.md)
* [南非 — 南非兰特代付查询 (POST /zar/pay/query)](https://doc.haipay.net/zh/history/V20260701/api-reference/zar/pay-query.md)
* [处理异步通知并验证签名](https://doc.haipay.net/zh/operations/callback.md)
* [端到端测试：修改订单状态与发送通知](https://doc.haipay.net/zh/history/V20260701/testing/end-to-end.md)
* [查询代收支付类型与编码 (payType)](https://doc.haipay.net/zh/history/V20260701/resources/cashin-code-list.md)
* [查询代付账户类型与银行编码](https://doc.haipay.net/zh/history/V20260701/resources/cashout-code-list.md)
* [HaiPay 本地支付产品页](https://www.haipay.net/products/local-payment)


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