> ## 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. # South Africa Payment API **Before reading this API document, please make sure to check [**API Description Guide**](/docs/en/guide/api_description_guide) first.** ## **Transaction Limits** | Transaction Type | Limit | | :--------------- | :------------- | | Disbursement | ZAR: 2-1000000 | > **Amount Decimal Places:** ZAR — 2 decimal places ## **Disbursement API** ### **Disbursement Apply** **Description:** * Create a Disbursement order **URL: `/zar/pay/apply`** **Parameters:** | Parameter | Required | Type | Description | | :------------ | :------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appId | Yes | Long | Business ID (obtained from backend, must match the currency in the URL) | | orderId | Yes | String | Merchant order ID (must be unique, length ≤ 48) | | amount | Yes | String | Transaction amount, up to 2 decimal places. Range: 2-1,000,000 | | accountType | Yes | String | Account type: BANK\_ACCOUNT | | bankCode | Yes | String | Bank code | | accountNo | Yes | String | User bank account number | | name | Yes | String | Recipient name (Format: English characters only, 1–30 characters. Format: "firstName middleName lastName"(middleName is optional and does not support special characters or numbers.)) | | phone | Yes | String | Real phone number | | email | Yes | String | Real email address | | notifyUrl | No | String | Callback URL | | subject | No | String | Payment note (transaction title, product name, payment reason) | | body | No | String | Detailed note | | partnerUserId | Yes | String | User unique identifier (e.g., userId). Used by risk control, must be valid. Format: numbers, letters, or common symbols -\~!@#\$%&\*()\_. | | sign | Yes | String | Signature | ##### request（when accountType is BANK\_ACCOUNT） ```json theme={null} { "appId": 1054, "orderId": "M100000450012", "amount": "500", "accountType": "BANK_ACCOUNT", "bankCode": "051001", "accountNo": "1234567890", "name": "john doe", "phone": "27821234567", "email": "johndoe@example.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==" } } ``` Return `data` Parameter Description | Parameter | Required | Type | Description | | :-------- | :------- | :----- | :--------------------------------- | | orderId | Yes | String | Merchant order ID (must be unique) | | orderNo | Yes | String | Platform order ID | | sign | Yes | String | Signature | ### **Disbursement Query** **Description:** * Query a Disbursement order **URL: `/zar/pay/query`** **Parameters:** | Parameter | Required | Type | Description | | :-------- | :------- | :----- | :---------------------------------------------------------------------- | | appId | Yes | Long | Business ID (obtained from backend, must match the currency in the URL) | | orderId | Yes | String | Merchant order ID | | orderNo | No | String | Platform order ID (faster response) | | sign | Yes | String | Signature | request ```json theme={null} { "appId": 1000, "orderId": "M1234567111", "orderNo": "3022111516571436", "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg==" } ``` response — Order Failed ```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 — Order Successful ```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==" } } ``` Return `data` Parameter Description | Parameter | Type | Description | | :-------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------- | | orderId | String | Merchant order ID (must be unique) | | orderNo | String | Platform order ID | | amount | String | Transaction amount | | fee | String | Fee | | status | Integer | Order status (0 Not Started, 1 Processing, 2 Disbursement Success (final), 3 Disbursement Failed (final), -1 Exception Pending Confirmation) | | payTime | String | Payment success time (present when status=2) (South Africa Standard Time), format: yyyy-MM-dd HH:mm:ss | | errorMsg | String | Payment failure reason (present when status=3) | | sign | String | Signature | ### **Payment Methods** | Currency | Payment Type (accountType) | Payment Code (bankCode) | Limit | Status | Description | | -------- | -------------------------- | ----------------------- | --------- | --------- | ----------------------- | | ZAR | BANK\_ACCOUNT | 051001 | 2-1000000 | Available | Standard Bank | | ZAR | BANK\_ACCOUNT | 198765 | 2-1000000 | Available | Nedbank | | ZAR | BANK\_ACCOUNT | 250655 | 2-1000000 | Available | FNB | | ZAR | BANK\_ACCOUNT | 250655 | 2-1000000 | Available | RMB | | ZAR | BANK\_ACCOUNT | 350005 | 2-1000000 | Available | CitiBank | | ZAR | BANK\_ACCOUNT | 410506 | 2-1000000 | Available | Access Bank | | ZAR | BANK\_ACCOUNT | 430000 | 2-1000000 | Available | African Bank | | ZAR | BANK\_ACCOUNT | 431010 | 2-1000000 | Available | Ubank Limited | | ZAR | BANK\_ACCOUNT | 462005 | 2-1000000 | Available | Bidvest Bank | | ZAR | BANK\_ACCOUNT | 462105 | 2-1000000 | Available | Old Mutual Bank | | ZAR | BANK\_ACCOUNT | 470010 | 2-1000000 | Available | Capitec Bank | | ZAR | BANK\_ACCOUNT | 580105 | 2-1000000 | Available | Investec | | ZAR | BANK\_ACCOUNT | 587000 | 2-1000000 | Available | HSBC Bank | | ZAR | BANK\_ACCOUNT | 632005 | 2-1000000 | Available | ABSA | | ZAR | BANK\_ACCOUNT | 678910 | 2-1000000 | Available | TymeBank | | ZAR | BANK\_ACCOUNT | 679000 | 2-1000000 | Available | Discovery Bank | | ZAR | BANK\_ACCOUNT | 683000 | 2-1000000 | Available | Sasfin Bank | | ZAR | BANK\_ACCOUNT | 730020 | 2-1000000 | Available | Standard Chartered Bank | | ZAR | BANK\_ACCOUNT | 800000 | 2-1000000 | Available | Albaraka Bank | | ZAR | BANK\_ACCOUNT | 888000 | 2-1000000 | Available | Bank Zero | ## Related Topics * [Common API](/docs/en/api/version2/CommonApi) * [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide) * [Global Cashier Payment API](/docs/en/api/version2/GlobalCashier)