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

# Iraq

<Warning>
  **Before reading this API document, please check [**API Description Guide**](/docs/en/guide/api_description_guide)**
</Warning>

## **Transaction Limits**

| Transaction Type | Limit             |
| :--------------- | ----------------- |
| Collection       | IQD: 250-10000000 |

> **Amount Decimal Places:** IQD — integer (0 decimal places)

## **Collection API**

### **Collection Request**

**Brief Description:**

* Create a collection order

**URL:**

Iraq: `/iqd/collect/apply`
Note: appId needs to use IQD corresponding, user payment success will increase IQD balance

**Parameters:**

| Parameter Name  | Required | Type   | Description                                                                                                                                                                         |
| :-------------- | :------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId           | Yes      | Long   | Business ID (obtained from backend, needs to pass the corresponding Business ID based on the currency in the URL)                                                                   |
| orderId         | Yes      | String | Merchant order number (must be unique, length no more than 48)                                                                                                                      |
| name            | Yes      | String | Payer name                                                                                                                                                                          |
| phone           | Yes      | String | Payer mobile number                                                                                                                                                                 |
| email           | Yes      | String | Payer email address                                                                                                                                                                 |
| amount          | Yes      | String | Transaction amount                                                                                                                                                                  |
| payType         | Yes      | String | [Payment Method Type](#inBankCode)                                                                                                                                                  |
| inBankCode      | Yes      | String | [Payment Method Code](#inBankCode)                                                                                                                                                  |
| callBackUrl     | Yes      | String | Redirect URL after successful payment                                                                                                                                               |
| callBackFailUrl | Yes      | String | Redirect URL after failed payment                                                                                                                                                   |
| cancelUrl       | No       | String | If provided, the payment page displays a Back button that redirects the user to this URL when clicked.                                                                              |
| notifyUrl       | No       | String | Callback URL                                                                                                                                                                        |
| subject         | Yes      | String | Payment remark                                                                                                                                                                      |
| body            | No       | String | Remark details                                                                                                                                                                      |
| partnerUserId   | Yes      | String | Unique user identifier (e.g., userId), used for risk control system, must be valid, otherwise it will affect the transaction. Format: digits, letters, or symbols -\~!@#\$%&\*()\_. |
| sign            | Yes      | String | Signature                                                                                                                                                                           |

#####

request

```json theme={null}
{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "50000",
  "phone": "+9647701234567",
  "email": "test123@gmail.com",
  "name": "Test Test",
  "inBankCode": "ZAIN",
  "payType": "EWALLET",
  "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://a.api-uat.php.com/1L9zQS2",
    "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
  }
}
```

Response data field description

| Parameter Name | Type   | Description                            |
| :------------- | :----- | :------------------------------------- |
| orderId        | String | Merchant order number (must be unique) |
| orderNo        | String | Platform order number                  |
| payUrl         | String | Payment link                           |
| sign           | String | Signature                              |

### **Collection Query**

**Brief Description:**

* Query collection order

**URL:**

Iraq: `/iqd/collect/query`

**Parameters:**

| Parameter Name | Required | Type   | Description                                                                                                       |
| :------------- | :------- | :----- | :---------------------------------------------------------------------------------------------------------------- |
| appId          | Yes      | Long   | Business ID (obtained from backend, needs to pass the corresponding Business ID based on the currency in the URL) |
| orderId        | Yes      | String | Merchant order number                                                                                             |
| orderNo        | No       | String | Platform order number (faster response)                                                                           |
| sign           | Yes      | String | Signature                                                                                                         |

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",
        "actualAmount": "0",
        "fee": "0",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
    }
}
```

Response data field description

| Parameter Name | Type    | Description                                                                                                   |
| :------------- | :------ | :------------------------------------------------------------------------------------------------------------ |
| orderId        | String  | Merchant order number (must be unique)                                                                        |
| orderNo        | String  | Platform order number                                                                                         |
| amount         | String  | Transaction amount                                                                                            |
| actualAmount   | String  | Received amount                                                                                               |
| fee            | String  | Transaction fee                                                                                               |
| status         | Integer | Status (0 Not Started, 1 In Progress, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation) |
| payTime        | String  | Payment success time (when status=2), format: yyyy-MM-dd HH:mm:ss (Iraq Time)                                 |
| errorMsg       | String  | Failure reason (when status=3)                                                                                |
| sign           | String  | Signature                                                                                                     |

### **Payment Methods**<a id="inBankCode" />

#### Iraq

| Currency | Payment Type (payType) | Payment Code (inBankCode) | Limit        | Status    | Description      |
| -------- | ---------------------- | ------------------------- | ------------ | --------- | ---------------- |
| IQD      | EWALLET                | ZAIN                      | 250-10000000 | Available | Zain Cash Wallet |

## Related Topics

* [Common API](/docs/en/api/version2/CommonApi)
* [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide)
* [Jordan Payment API](/docs/en/V20260801/api/version2/Jordan)
