> ## 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 Arab Emirates — Collection Application (Legacy navigation V20260628)

> Historical version (V20260628): United Arab Emirates — Collection Application (Legacy navigation V20260628) (POST /aed/collect/apply): Use the appId corresponding to AED. After successful user payment, the AED balance will be increased. Key request parameters include orderId, name, phone, email.

> [!NOTE]
>
> All example requests on this page are based on the **sandbox (test) environment**. Please be careful to distinguish it from the production environment.

#### Secret Key & Private Key (Generate Signature)

## Related Topics

* [UAE Payment API](https://doc.haipay.net/en/history/V20260628/api/version2/UAE.md)
* [HaiPay API Reference Overview](https://doc.haipay.net/en/history/V20260628/api-reference/overview.md)
* [HaiPay Configuration and Signature Guide](https://doc.haipay.net/en/history/V20260628/guide/config_settings_and_signature_rules_guide.md)


## OpenAPI

````yaml docs/en/api-reference/aed/aed.openapi.json POST /aed/collect/apply
openapi: 3.1.0
info:
  title: AED Payment API
  description: >-
    All APIs use POST requests, Content-Type: application/json

    Request header may carry Sys-Language (optional, for multi-language currency
    translation, e.g. zh, en)
  version: 1.0.0
servers:
  - url: https://uat-interface.haipay.asia
    description: 测试-interface
security: []
tags: []
paths:
  /aed/collect/apply:
    post:
      tags: []
      summary: AED Collection Application
      description: >-
        Use the appId corresponding to AED. After successful user payment, the
        AED balance will be increased.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appId:
                  type: integer
                  description: >-
                    Business ID (obtained from backend, must match the currency
                    in the URL)
                orderId:
                  type: string
                  description: Merchant Order Number (must be unique, max length 48)
                  maxLength: 48
                name:
                  type: string
                  description: Recipient name, used for risk control
                phone:
                  type: string
                  description: Real mobile number
                email:
                  type: string
                  description: Real email address
                  format: email
                amount:
                  type: string
                  description: >-
                    Transaction amount (unit: local currency, accurate to two
                    decimal places; punctuation marks such as "," are
                    prohibited), test environment please use amount below 10AED
                  pattern: ^\d+\.\d{2}$
                currency:
                  type: string
                  description: Currency (USD, local currency)
                payType:
                  type: string
                  description: Transaction type
                inBankCode:
                  type: string
                  description: Payment Method
                callBackUrl:
                  type: string
                  description: Redirect URL after successful payment
                  format: uri
                callBackFailUrl:
                  type: string
                  description: Redirect URL after failed payment
                  format: uri
                notifyUrl:
                  type: string
                  description: Callback URL
                  format: uri
                goodsName:
                  type: string
                  description: Product name
                goodsQuantity:
                  type: string
                  description: Product quantity
                goodsPrice:
                  type: string
                  description: Product price
                goodsSku:
                  type: string
                  description: Product unique identifier
                goodsAvatar:
                  type: string
                  description: Product image (https://)
                  format: uri
                platform:
                  type: string
                  description: Platform name
                subject:
                  type: string
                  description: Payment note
                body:
                  type: string
                  description: Additional description
                partnerUserId:
                  type: string
                  description: >-
                    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
                    -~!@#$%&*()_.
                  pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
                sign:
                  type: string
                  description: Signature
              required:
                - appId
                - orderId
                - name
                - phone
                - email
                - amount
                - payType
                - inBankCode
                - callBackUrl
                - callBackFailUrl
                - goodsName
                - goodsQuantity
                - goodsPrice
                - goodsSku
                - goodsAvatar
                - platform
                - partnerUserId
                - sign
              additionalProperties: false
            example:
              appId: 1054
              orderId: M233323000059
              name: Khalid Al-Mansouri
              phone: '0501234567'
              email: khalid.mansouri@gmail.com
              amount: '800.00'
              currency: AED
              payType: ONLINE_BANKING
              inBankCode: CARD
              callBackUrl: https://merchant.com/payment/success
              callBackFailUrl: https://merchant.com/payment/fail
              notifyUrl: https://merchant.com/api/notify
              goodsName: Premium Widget
              goodsQuantity: '1'
              goodsPrice: '100.00'
              goodsSku: SKU-001
              goodsAvatar: https://merchant.com/images/product.png
              platform: WEB
              subject: Payment for order
              body: Premium subscription
              partnerUserId: '149597870'
              sign: >-
                af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw==
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: '1: Normal, 0: Exception'
                  error:
                    type: string
                    description: Error code
                  msg:
                    type: string
                    description: Error description
                  data:
                    type: object
                    properties:
                      orderId:
                        type: string
                        description: Merchant Order Number (must be unique)
                      orderNo:
                        type: string
                        description: Platform Order Number
                      payUrl:
                        type: string
                        description: Payment URL
                      sign:
                        type: string
                        description: Signature
                    additionalProperties: false
                additionalProperties: false
              examples:
                success:
                  summary: Success
                  value:
                    status: '1'
                    error: '00000000'
                    msg: success
                    data:
                      orderId: M233323000059
                      orderNo: '6023071013539074'
                      payUrl: https://pay.haipay.asia/cashier/1L9zQS2
                      sign: >-
                        af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw==
                param_error:
                  summary: Parameter validation failed
                  value:
                    status: '0'
                    error: '1001'
                    msg: orderId can not blank
                    data: null
                sign_error:
                  summary: Signature error
                  value:
                    status: '0'
                    error: '1002'
                    msg: Invalid request signature
                    data: null
          headers: {}
      deprecated: false
      security: []

````

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