> ## 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. # Global Cashier > Learn how to use the HaiPay Global Cashier API for collection orders, required parameters, response fields, and asynchronous notifications. **Before reading this API documentation, please make sure to check [**API Description Guide**](/docs/en/guide/api_description_guide)** **If needed, you may contact HaiPay to unify all business key configuration information into one set.** ## **Collection API** ### **Collection Apply** **Description:** * Create a collection order **URL:** `/global/cashier/collect/apply` **Parameters:** | Parameter Name | Required | Type | Description | | :-------------- | :------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appId | Yes | Long | Business ID (retrieved from the backend; must use the Cashier-specific APPID, currency = CASHIER) | | orderId | Yes | String | Merchant order number (must be unique, max length 48) | | name | Yes | String | User full name (recommended to use real name). Format: firstName + lastName, separated by a space, e.g., John Doe | | email | Yes | String | Valid email address | | amount | Yes | String | Transaction amount (accurate to two decimals; do not use punctuation symbols such as “,”) | | currency | Yes | String | Transaction currency. Supported: USD (minimum 0.99 USD). For other currencies, see [Region Codes](#region-code). | | 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 note (transaction title, product name, reason for payment, etc.) | | body | No | String | Detailed remarks | | region | Yes | String | [Region Code](#region-code), use 2-letter code | | partnerUserId | Yes | String | Unique user identifier (e.g., userId), used for risk control. Must be real/valid, otherwise it may affect transactions. Allowed format: numbers, letters, or symbols -\~!@#\$%&\*()\_. | | paymentMethods | No | String | Supported payment method list, separated by English commas, e.g., CREDIT\_CARD,GOOGLE\_PAY,APPLE\_PAY | | sign | Yes | String | Signature | **Response Data** | Parameter Name | Type | Description | | :------------- | :----- | :---------------- | | orderId | String | Merchant order ID | | orderNo | String | Platform order ID | | payUrl | String | Payment URL | | sign | String | Signature | *** ### **Collection Query** **Description:** * Query collection order **URL:** `/global/cashier/collect/query` **Parameters:** | Parameter Name | Required | Type | Description | | :------------- | :------- | :----- | :------------------------------------------------------------------------------------------------ | | appId | Yes | Long | Business ID (retrieved from the backend; must use the Cashier-specific APPID, currency = CASHIER) | | orderId | Yes | String | Merchant order ID | | orderNo | Yes | String | Platform order ID | | sign | Yes | String | Signature | **Response Data** | Parameter Name | Type | Description | | :------------- | :------ | :------------------------------------------------------------------------------------------------------------ | | orderId | String | Merchant order ID | | orderNo | String | Platform order ID | | amount | String | Order amount | | actualAmount | String | Actual 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 (present when status=2, local time), format: yyyy-MM-dd HH:mm:ss | | errorMsg | String | Failure reason (present when status=3) | | sign | String | Signature | *** ### **Collection Query v2** **Description:** * Query collection order **URL:** `/global/cashier/collect/query/v2` **Parameters:** | Parameter Name | Required | Type | Description | | :------------- | :------- | :----- | :------------------------------------------------------------------------------------------------- | | appId | Yes | Long | Business ID (retrieved from the backend; must use the Cashier-specific APPID, currency is CASHIER) | | orderId | Yes | String | Merchant order ID | | orderNo | Yes | String | Platform order ID | | sign | Yes | String | Signature | **Response Data** | Parameter Name | Type | Description | | :---------------- | :------ | :------------------------------------------------------------------------------------------------------------ | | orderId | String | Merchant order ID | | orderNo | String | Platform order ID | | currency | String | Currency (available after selecting a specific payment method) | | amount | String | Order amount | | actualAmount | String | Actual 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 (present when status=2, local time), format: yyyy-MM-dd HH:mm:ss | | errorMsg | String | Failure reason (present when status=3) | | originalCurrency | String | Original payment currency | | floatExchangeRate | String | Exchange rate used in currency conversion | | originalAmount | String | Original payment amount | | sign | String | Signature | *** ### **Region Codes** | Code | Region Name | Supported Currency | | :--- | :------------------- | :----------------- | | AE | United Arab Emirates | AED | | AT | Austria | EUR | | BE | Belgium | EUR | | BH | Bahrain | BHD | | BR | Brazil | BRL | | EG | Egypt | EGP | | GB | United Kingdom | GBP | | HK | Hong Kong | HKD, USD | | ID | Indonesia | IDR, USD | | IN | India | INR | | JP | Japan | JPY, USD | | KR | South Korea | KRW, USD | | KW | Kuwait | KWD | | MY | Malaysia | MYR, USD | | NL | Netherlands | EUR | | OM | Oman | OMR | | PH | Philippines | PHP | | PK | Pakistan | PKR | | PL | Poland | EUR | | QA | Qatar | QAR | | SA | Saudi Arabia | SAR | | SG | Singapore | SGD, USD | | TH | Thailand | THB, USD | | TR | Türkiye | TRY | | TW | Taiwan | TWD, USD | | US | United States | USD | | VN | Vietnam | VND, USD | | IT | Italy | EUR | | EU | European Union | EUR | ## Related Topics * [Common API](/docs/en/api/version2/CommonApi) * [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide) * [Europe Payment API](/docs/en/api/version2/Europe)