> ## 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.
# UAE
**Before reading this API documentation, be sure to review [**API Description Guide**](/docs/en/guide/api_description_guide)**
## **Transaction Limits**
| Transaction Type | Limit |
| :--------------- | :-------------------------- |
| Collection | AED: 2-10000, USD: 0.5-2500 |
| Payout | AED: 10-100000000 |
> **Amount Decimal Places:** AED — 2 decimal places | USD — 2 decimal places
## **Collection API**
### **Collection Request**
**Brief Description:**
* Create a collection order
**URL:**
UAE: `/aed/collect/apply`
Note: appId needs to use AED corresponding, user payment success will increase AED balance
**Parameters:**
| Parameter | Required | Type | Description |
| :-------------- | :------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId | Yes | Long | Business ID (obtained from the backend, must pass the corresponding business ID based on the currency in the URL) |
| orderId | Yes | String | Merchant order number (must be unique, max length 48) |
| name | Yes | String | Recipient name, used for risk control |
| phone | Yes | String | Real mobile number (format reference: [Phone Number Format](/docs/en/guide/frequently_asked_question#en_faq_phone-number-format)) |
| email | Yes | String | Real email address |
| amount | Yes | String | Transaction amount (unit: local currency, accurate to two decimal places; punctuation marks such as "," are prohibited), test environment please use amount below 10AED |
| currency | No | String | Currency (USD, local currency) |
| payType | Yes | String | Transaction type |
| inBankCode | Yes | String | [Payment Method](#inBankCode) |
| callBackUrl | Yes | String | Redirect URL after successful payment |
| callBackFailUrl | Yes | String | Redirect URL after failed payment |
| notifyUrl | No | String | Callback URL |
| goodsName | Yes | String | Product name |
| goodsQuantity | Yes | String | Product quantity |
| goodsPrice | Yes | String | Product price |
| goodsSku | Yes | String | Product unique identifier |
| goodsAvatar | Yes | String | Product image (https\://) |
| platform | Yes | String | Platform name |
| subject | No | String | Payment note |
| body | No | String | Additional description |
| 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 |
\*\*AED VA payin request parameters: \*\*
**Amount limit to two decimal places.**
| Parameter Name | Required | Type | Description |
| -------------- | -------- | ------ | ------------------------------------------------ |
| firstName | Yes | String | Recipient's first name |
| lastName | Yes | String | Recipient's last name |
| dateOfBirth | Yes | String | Date of birth (format example: DD-MM-YYYY) |
| countryCode | Yes | String | Country code (e.g., AE for United Arab Emirates) |
| street | Yes | String | Street address |
| city | Yes | String | City |
| state | Yes | String | Emirate/Province |
| postalCode | Yes | String | Postal code |
| phoneCode | Yes | String | Phone area code (e.g., "+971" for UAE) |
#####
request
```json theme={null}
{
"appId": 1054,
"orderId": "M233323000059",
"amount": "300",
"phone": "09230219312",
"email": "23423@qq.com",
"name": "test",
"inBankCode": "CARD",
"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=="
}
}
```
Return Data Parameters Description
| Parameter | Type | Description |
| :-------- | :----- | :------------------------------------- |
| orderId | String | Merchant Order Number (must be unique) |
| orderNo | String | Platform Order Number |
| payUrl | String | Payment URL |
| sign | String | Signature |
### **Collection Query**
**Brief Description:**
* Query collection order
* When "payType = BANK\_TRANSFER", the orderNo is returned synchronously and can be queried directly
* For other payment methods, after asynchronous notification, use orderNo for second confirmation
**URL:**
UAE: `/aed/collect/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 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": "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=="
}
}
```
Return Data Parameters Description
| Parameter | 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 | 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 (available when status=2) (UAE Time), format: yyyy-MM-dd HH:mm:ss |
| errorMsg | String | Failure Reason (available when status=3) |
| sign | String | Signature |
### **Payment Methods**
#### UAE
| Currency | Payment Type (payType) | Payment Code (inBankCode) | Limit | Status | Description |
| -------- | ---------------------- | ------------------------- | ------------ | --------- | ------------------------ |
| AED | PAYMENT\_GATEWAY | CARD | 2-10000 | Available | support VISA, MasterCard |
| AED | EWALLET | APPLE\_PAY | 2-10000 | Available | Apple Pay |
| AED | VA | BANK\_TRANSFER | 10-100000000 | Available | VA BANK TRANSFER |
| USD | PAYMENT\_GATEWAY | CARD | 0.5-2500 | Available | support VISA, MasterCard |
| USD | EWALLET | APPLE\_PAY | 0.5-2500 | Available | Apple Pay |
## **Disbursement API**
### **Disbursement Application**
**Brief Description:**
* Create a disbursement order
**URL: `/aed/pay/apply`**
**Parameters:**
| Parameter Name | Required | Type | Description |
| :------------- | :------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId | Yes | Long | Business ID (obtained from the backend, must pass the corresponding business ID based on the currency in the URL) |
| orderId | Yes | String | Merchant order number (must be unique, max length 48) |
| amount | Yes | String | Transaction amount (unit: AED) Range: 10-100000000; **Limit to two decimal places.** |
| accountType | Yes | String | Account type: BANK\_ACCOUNT |
| bankCode | Yes | String | Bank code |
| accountNo | Yes | String | IBAN account number |
| name | Yes | String | Recipient name (English, 1-30 characters, "firstName middleName lastName" (middleName optional, special characters: .-)) |
| phone | Yes | String | Real mobile 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 | Additional description |
| 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 |
| swiftCode | Yes | String | Global Bank Financial Telecommunication Code |
| city | Yes | String | City |
| street | Yes | String | Street |
#####
request (when accountType is BANK\_ACCOUNT)
```json theme={null}
{
"appId": 1054,
"orderId": "M100000450012",
"amount": "500",
"accountType": "BANK_ACCOUNT",
"bankCode": "BANK_TRANSFER",
"accountNo": "AE03022099991555571999",
"name": "john-doe",
"phone": "08276543210",
"email": "johndoe@cashfree.com",
"subject": "iphone13",
"body": "ProMotion technology with adaptive refresh rates up to 120Hz",
"partnerUserId": "149597870",
"swiftCode": "EBILAEAD",
"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=="
}
}
```
Response data field description
| Parameter | Type | Description |
| :-------- | :----- | :------------------------------------- |
| orderId | String | Merchant Order Number (must be unique) |
| orderNo | String | Platform Order Number |
| sign | String | Signature |
### **Disbursement Query**
**Brief Description:**
* Query disbursement order
**URL: `/aed/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 Number |
| orderNo | No | String | Platform Order Number (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": "Order does not exist",
"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=="
}
}
```
Response data field description
| Parameter | Type | Description |
| :-------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------- |
| orderId | String | Merchant Order Number (must be unique) |
| orderNo | String | Platform Order Number |
| amount | String | Transaction Amount |
| fee | String | Fee |
| status | Integer | Order status (0 Not Started, 1 Disbursing, 2 Disbursement Success (final), 3 Disbursement Failed (final), -1 Exception Pending Confirmation) |
| payTime | String | Payment Success Time (available when status=2) (UAE Time), format: yyyy-MM-dd HH:mm:ss |
| errorMsg | String | Failure Reason (available when status=3) |
| sign | String | Signature |
### **Payment Methods**
| Currency | Payment Type (accountType) | Payment Code (bankCode) | Limit | Status | Description |
| -------- | -------------------------- | ----------------------- | ------------ | --------- | ------------- |
| AED | BANK\_ACCOUNT | BANK\_TRANSFER | 10-100000000 | Available | Bank Transfer |
## Related Topics
* [Common API](/docs/en/api/version2/CommonApi)
* [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide)
* [Egypt Payment API](/docs/en/api/version2/Egypt)