> ## 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.
# Brazil
**Before reading this API documentation, please make sure to first review the [API Description Guide](/docs/en/guide/api_description_guide)**
## **Limits**
| Transaction Type | Limit (Unit: BRL) |
| :--------------- | ----------------- |
| Collection | 5-20000 |
| Disbursement | 5-20000 |
> **Amount Decimal Places:** BRL — 2 decimal places
## **Collection API**
### **Collection Application**
**Brief Description:**
* Create a collection order
**URL: `/brl/collect/apply`**
Note: appId is for Brazilian Real, amount is for Brazilian Real, and the settlement is in Brazilian Real.
**Parameters:**
| Parameter | Required | Type | Description |
| :-------------- | :------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| appId | Yes | Long | Business ID (obtained from the backend, corresponding to the currency in the URL) |
| orderId | Yes | String | Merchant order number (must be unique, length not exceeding 48) |
| name | Yes | String | Payer's name (format: English letters, case-sensitive, and spaces allowed, 1-30 characters, "firstName middleName lastName" (middleName is optional), special characters !- are supported) |
| 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: Brazilian Real, accurate to two decimal places; no punctuation, e.g., ",") Range: 1-99999 |
| payType | Yes | String | [Payout API](#inBankCode) |
| inBankCode | Yes | String | [Payment Method](#inBankCode) |
| inBankNo | No | String | CPF (11 digits only) |
| callBackUrl | Yes | String | Redirect URL after successful user payment |
| callBackFailUrl | Yes | String | Redirect URL after failed user 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 | No | String | Payment remarks |
| body | No | String | Remark details |
| partnerUserId | Yes | String | Unique user identifier (e.g., userId), for the risk control system. Must be real and valid, otherwise it may affect transactions. Format requirements: numbers, uppercase/lowercase letters, or common symbols -\~!@#\$%&\*()\_ |
| sign | Yes | String | Signature |
#####
request
```json theme={null}
{
"appId": 1054,
"orderId": "M233323000059",
"amount": "300",
"phone": "09230219312",
"email": "23423@qq.com",
"name": "test",
"inBankCode": "PIX",
"payType": "QR",
"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",
"bankCode": "PIX",
"bankNo": "PC0007I10000035",
"qrCode": "00020101021228760011ph.ppmi.p2m0111OPDVPHM1XXX0315777148000000017041652948137245442930503001520460165303608540810000.php Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX63042763",
"sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
}
}
```
### Returned `data` Parameter Description
| Parameter Name | Type | Description |
| :------------- | :----- | :---------------------------------------------------------------------------- |
| orderId | String | Merchant order number (must be unique) |
| orderNo | String | Platform order number |
| payUrl | String | The returned URL for repayment; otherwise, it returns instructions or details |
| bankNo | String | Repayment account number (VA) |
| bankCode | String | Channel code (VA) |
| qrCode | String | QR code content – can generate QR code yourself (QR) |
| sign | String | Signature |
### **Collection Query**
**Brief Description:**
* Create a payout order
* After the asynchronous notification, use `orderNo` to query the secondary confirmation status
**URL:** `/brl/collect/query`
**Parameters:**
| Parameter Name | Required | Type | Description |
| :------------- | :------- | :----- | :----------------------------------------------------------------------------------------- |
| appId | Yes | Long | Business ID (get it from the backend, needs to be passed based on the currency in the URL) |
| orderId | Yes | String | Merchant order number |
| orderNo | No | String | Platform order number (response is faster) |
| 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.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=="
}
}
```
### Returned `data` Parameter Description
| Parameter Name | Type | Description |
| :------------- | :------ | :---------------------------------------------------------------------------------------------------------------- |
| orderId | String | Merchant order number (must be unique) |
| orderNo | String | Platform order number |
| amount | String | Transaction amount |
| actualAmount | String | Amount received |
| fee | String | Transaction fee |
| status | Integer | Status (0: not started, 1: in progress, 2: successful (final), 3: failed (final), -1: error pending confirmation) |
| payTime | String | Payment successful time (present when status=2,4,5) (Brazil Time), format: yyyy-MM-dd HH:mm:ss |
| errorMsg | String | Failure reason (present when status=3) |
| sign | String | Signature |
### **Payment Method**
| Currency | Payment Type (payType) | Payment Code (inBankCode) | Limit | Status | Description |
| :------- | :--------------------- | :------------------------ | :------ | :-------- | :---------- |
| BRL | QR | PIX | 5-20000 | Available | PIX QR Code |
## **Payout API**
### **Payout Application**
**Brief Description:**
* Create a payout order
**URL:** `/brl/pay/apply`
***
**Parameters:**
| Parameter Name | Required | Type | Description | |
| :------------- | :------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - |
| appId | Yes | Long | Business ID (obtained from the backend, needs to be passed according to the currency in the URL) | |
| orderId | Yes | String | Merchant order number (must be unique, length not exceeding 48) | |
| amount | Yes | String | Transaction amount (unit: Brazilian Real, accurate to two decimal places; do not include punctuation such as commas) Range: 1-99999 | |
| accountType | Yes | String | Account type: EWALLET (electronic wallet) | |
| bankCode | Yes | String | Wallet code | |
| identifyType | Yes | String | Account type (CPF/PHONE/EMAIL) | |
| accountNo | Yes | String | User's receiving account numbe | |
| name | Yes | String | Recipient's name (Format: uppercase English letters, may include spaces, 1-30 characters, "firstName middleName lastName" (middleName is optional, special characters like '.- are supported)) | |
| phone | Yes | String | Real phone number (refer to the [phone format](/docs/en/guide/frequently_asked_question#en_faq_phone-number-format)) | |
| email | Yes | String | Real email address | |
| notifyUrl | No | String | Callback URL | |
| subject | No | String | Payment remark (transaction title, product name, payment reason) | |
| body | No | String | Detailed remarks | |
| partnerUserId | Yes | String | Unique user identifier (e.g., userID), used for risk control, must be valid; otherwise, it will affect the transaction. Format: digits, uppercase and lowercase letters, or common symbols such as -\~!@#\$%&\*()\_. | |
| sign | Yes | String | Signature | |
#####
request
```json theme={null}
{
"appId": 1054,
"orderId": "M100000450012",
"amount": "500",
"accountType": "EWALLET",
"bankCode": "PIX",
"identifyType": "CPF",
"accountNo": "09876543210",
"name": "john doe",
"phone": "09876543210",
"email": "johndoe@cashfree.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 Name | Required | Type | Description |
| :------------- | :------- | :----- | :------------------------------------- |
| orderId | Yes | String | Merchant order number (must be unique) |
| orderNo | Yes | String | Platform order number |
| sign | Yes | String | Signature |
### **Payment Query**
**Brief Description:**
* Query for payment orders
**URL:** `/brl/pay/query`
**Parameters:**
| Parameter Name | Required | Type | Description |
| :------------- | :------- | :----- | :----------------------------------------------------------------------------------------------- |
| appId | Yes | Long | Business ID (obtained from the backend, needs to be passed according to 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": "Đơn hàng không tồn tại",
"sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
}
}
```
response — Order Success
```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 Name | Type | Description |
| :------------- | :------ | :---------------------------------------------------------------------------------------------------------------------- |
| orderId | String | Merchant order number (must be unique) |
| orderNo | String | Platform order number |
| amount | String | Transaction amount |
| fee | String | Service fee |
| status | Integer | Status (0 = Not started, 1 = In process, 2 = Success (final), 3 = Failed (final), -1 = Exception awaiting confirmation) |
| payTime | String | Payment success time (present when status=2) (Brazil 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 |
| :------- | :------------------------- | :---------------------- | :------ | :-------- | :---------- |
| BRL | EWALLET | PIX | 5-20000 | Available | PIX |
## Related Topics
* [Common API](/docs/en/api/version2/CommonApi)
* [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide)
* [Mexico Payment API](/docs/en/api/version2/Mexico)