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

# United States

> [!WARNING]
>
> **Before reading this API document, please make sure to review [**API Description Guide**](https://doc.haipay.net/docs/en/V20260623/guide/api_description_guide.md)**

## **Limits**

| Transaction Type | Limit (Unit: USD) |
| :- | - |
| Payout | 1–800 |

## **Payout API**

### **Payout Request**

**URL：**

USD: `/usd/pay/apply`

**Parameters：**

| Name | Required | Type | Description |
| :- | :- | :- | :- |
| appId | Yes | Long | Business ID (obtained from the backend; must use the corresponding business ID for the currency in the URL). |
| orderId | Yes | String | Merchant order number (must be unique, max length 48). |
| name | Yes | String | Recipient's full name, recommended to use the real name in English, no special characters, separated by spaces, must include at least firstName and lastName. Example: John Doe |
| phone | Yes | String | Real phone number (format reference: [Phone Number Format](https://doc.haipay.net/docs/en/V20260623/guide/frequently_asked_question.md#en_faq_phone-number-format)). |
| email | Yes | String | Real email address. |
| notifyUrl | No | String | Callback URL. |
| amount | Yes | String | Transaction amount (unit: USD, accurate to two decimals; no punctuation marks allowed, e.g., “,”). |
| accountType | Yes | String | Account type. |
| bankCode | Yes | String | [Payment Method](#payment-methods). |
| subject | Yes | String | Payment remark. |
| accountNo | Yes | String | Account number, for PayPal it is the email address. |
| body | No | String | Remark details, required for ECASHAPP. |
| partnerUserId | Yes | String | User unique identifier (e.g., userId). Used for risk control. Must be real and valid, otherwise it will affect the transaction. Allowed characters: digits, uppercase/lowercase letters, or common symbols `-~!@#$%&*()_`. |
| sign | Yes | String | Signature. |

#####

request

```json theme={null}
{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "200.00",
    "phone": "02012345678",
    "email": "james.anderson@gmail.com",
    "name": "James Anderson",
    "accountType": "EWALLET",
    "bankCode": "PayPal",
    "accountNo": "123465",
    "partnerUserId": "149597870",
    "sign": "af0gAHkUOyYH***"
}
```

response

```json theme={null}
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "",
        "sign": "YEoA8Y2JzQFG***"
    }
}
```

**Response data description**

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

### **Payout Query**

**Description:**

* Create a payout order
* If orderNo is returned synchronously, it can be queried directly
* For other payment methods, after asynchronous notification, use orderNo to query and confirm the status again

**URL：**

USD: `/usd/pay/query`

**Parameters：**

| Name | Required | Type | Description |
| :- | :- | :- | :- |
| appId | Yes | Long | Business ID (obtained from the 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": "200.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=="
    }
}
```

Response data description

| Name | Type | Description |
| :- | :- | :- |
| orderId | String | Merchant order number (must be unique). |
| orderNo | String | Platform order number. |
| amount | String | Transaction amount. |
| fee | String | Transaction fee. |
| status | Integer | Status (0 = Not started, 1 = Processing, 2 = Success (final), 3 = Failed (final), -1 = Exception pending confirmation). |
| payTime | String | Payment success time (value present when status=2). Local time, format: yyyy-MM-dd HH:mm:ss. |
| errorMsg | String | Failure reason (value present when status=3). |
| sign | String | Signature. |

### **Payment Methods**

| Currency | Payment Type (accountType) | Payment Code (bankCode) | Limit | Status | Description |
| :- | :- | :- | :- | :- | :- |
| USD | EWALLET | PayPal | 1-800 | Available | PayPal Wallet |
| USD | EWALLET | VENMO | 1-800 | Available | Venmo Wallet |
| USD | EWALLET | ECASHAPP | 1-800 | Maintenance | CashApp Wallet |

### **Notes**

1. **What does the failure reason `<Bank Reversal>` mean?**

   The user’s account has been flagged by PayPal as a high-risk account and cannot receive funds. The user must change to another account.

2. **Can an order that is already in the payout process be recalled?**

   No, it cannot.

3. **Funds have been sent, but the user has not received them. What should be done?**

   The user needs to check their PayPal email to see if there is a notification email and claim the payment.\
   If the payment remains in "pending transfer" status, after 30 days without being claimed, it will be automatically refunded.

   **Below is the PayPal email claiming guide:**

   ![Example of the PayPal email claim flow for received funds](https://mintcdn.com/haipay-3385f6e8/qslC2gsg_E8Updwu/images/common/guide/paypal-email-claim.jpg?fit=max\&auto=format\&n=qslC2gsg_E8Updwu\&q=85\&s=f79ea8a97926467a44670be0071614b0)

## Related Topics

* [Common API](https://doc.haipay.net/docs/en/V20260623/api/version2/CommonApi.md)
* [HaiPay API Description and Common Rules](https://doc.haipay.net/docs/en/V20260623/guide/api_description_guide.md)
* [Brazil Payment Interface](https://doc.haipay.net/docs/en/V20260701/api/version2/Brazil.md)


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