> ## Documentation Index
> Fetch the complete documentation index at: https://dexbuilder.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 獲取充值簽名資料

> 構建鏈上充值所需的簽名資料。

構建鏈上充值所需的簽名資料。

> [!NOTE]
>
> 使用 Broker API Key 呼叫，並在請求頭提供 `X-User-Wallet-Address`。網關會校驗錢包與 Broker 的歸屬關係。 認證規則見[Broker API 認證與簽名](https://dexbuilder.mintlify.site/zh-TW/api-reference/common/broker-authentication.md)。

## 使用說明

* 建議先呼叫[估算充值手續費](https://dexbuilder.mintlify.site/zh-TW/api-reference/dexbuilder/deposit-fee.md)，將 `native_fee` 原樣傳入，並將 `lz_fee` 按 USDT 六位小數轉換為整數。
* 首次成功呼叫可能為使用者綁定 Perp 帳戶；重複呼叫不會重複綁定。回傳的 `contract_address` 與 `data` 用於構造鏈上交易。
* `x-perp-device-type` 必填，僅支援 `1`、`2`、`3`。


## OpenAPI

````yaml openapi/dexbuilder-zh-TW.yaml POST /api/v4/dexbuilder/deposit/sign_data
openapi: 3.0.3
info:
  title: DexBuilder 平台 Broker API
  version: 1.0.0
  description: DexBuilder 平台 Broker API，涵蓋資產配置、使用者、充值與提現能力。認證和使用者錢包校驗見本站統一網關說明。
servers:
  - url: https://api.dexbuilder.com
security: []
paths:
  /api/v4/dexbuilder/deposit/sign_data:
    post:
      tags:
        - 充值
      summary: 獲取充值簽名資料
      description: >-
        回傳鏈上充值所需的 calldata 與 Vault 合約地址。若使用者在該鏈尚未綁定 Perp
        賬戶，首次成功呼叫會完成綁定；重復呼叫不會重復綁定。
      operationId: dexBuilderDepositSignData
      parameters:
        - $ref: '#/components/parameters/SubUserWalletAddr'
        - $ref: '#/components/parameters/DeviceType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PerpDepositSignDataRequest'
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDepositSignData'
        '400':
          $ref: '#/components/responses/OpenAPIBadRequest'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/GatewayUnauthorized'
        '403':
          $ref: '#/components/responses/ProjectAccessDenied'
      security:
        - BrokerAPIKey: []
          Timestamp: []
          Signature: []
components:
  parameters:
    SubUserWalletAddr:
      name: X-User-Wallet-Address
      in: header
      required: true
      description: 目標終端使用者錢包地址。網關校驗該錢包對應的使用者屬於當前 Broker。
      schema:
        type: string
    DeviceType:
      name: x-perp-device-type
      in: header
      required: true
      description: >-
        DexBuilder 設備類型：1 Android、2 iOS、3 WEB。缺少或無效時回傳
        INVALID_DEVICE_TYPE。僅適用於明確列出此請求標頭的平台介面。
      schema:
        type: string
        enum:
          - '1'
          - '2'
          - '3'
      example: '3'
  schemas:
    PerpDepositSignDataRequest:
      type: object
      required:
        - address
        - chain
        - token_address
        - token_amount
        - token_symbol
      properties:
        address:
          type: string
          description: 使用者錢包，須已綁定；與 X-User-Wallet-Address 一致
        chain:
          $ref: '#/components/schemas/OpenAPIChainId'
        token_address:
          type: string
          description: 代幣合約地址
        token_amount:
          type: string
          description: 充值數量，十進制字符串
        token_symbol:
          type: string
          description: 代幣符號
        native_fee:
          type: integer
          format: int64
          description: 來自 POST /deposit/fee 的 native_fee（int64，鏈原生幣最小單位）
        lz_fee:
          type: integer
          format: int64
          description: >-
            來自 POST /deposit/fee：USDT 6 位小數轉 int64（如 lz_fee 字符串 "0.5" →
            500000）；native_fee 原樣 int64
    EnvelopeDepositSignData:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/PerpDepositSignDataResponse'
    ErrorEnvelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          required:
            - label
          properties:
            label:
              type: string
              description: 穩定的機器可讀錯誤標識
            data:
              nullable: true
              description: 錯誤時一般為 null
    OpenAPIChainId:
      type: string
      enum:
        - base
        - bsc
        - ethereum
        - solana
        - arbitrum
      description: 網路標識：base、bsc、ethereum、solana 或 arbitrum。
      example: ethereum
    EnvelopeBase:
      type: object
      properties:
        code:
          type: integer
          example: 0
          description: 業務碼，`0` 表示成功
        message:
          type: string
          example: success
          description: 人類可讀說明，成功時為 success
        reason:
          type: string
          description: 錯誤原因標識；成功時通常為空字符串
        trace_id:
          type: string
          description: 鏈路追蹤 ID，排障時提供
    PerpDepositSignDataResponse:
      type: object
      properties:
        account_id:
          type: string
          description: Perp 賬戶 ID
        broker_hash:
          type: string
          description: Broker 哈希（鏈上參數）
        token_hash:
          type: string
          description: 代幣哈希（鏈上參數）
        token_amount:
          type: string
          description: 充值數量，十進制字符串
        contract_address:
          type: string
          description: Vault 合約地址，與 data 組裝交易
        data:
          type: string
          description: ABI calldata（0x hex）
  responses:
    OpenAPIBadRequest:
      description: 請求無效（參數、請求體、使用者身份或業務校驗）
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalidArgument:
              summary: 參數無效
              value:
                label: INVALID_ARGUMENT
                message: invalid argument
            userNotFound:
              summary: 使用者不存在
              value:
                label: USER_NOT_FOUND
                message: User not found
            missingHeader:
              summary: 缺少必要請求頭
              value:
                label: MISSING_REQUIRED_HEADER
                message: invalid headers
    GatewayUnauthorized:
      description: Broker API Key、簽名或時間戳無效
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalidKey:
              summary: 無效 API Key
              value:
                label: INVALID_KEY
                message: Invalid key provided
                code: 401
                trace_id: abc123
            invalidSignature:
              summary: 簽名錯誤
              value:
                label: INVALID_SIGNATURE
                message: Invalid signature
                code: 401
                trace_id: abc123
    ProjectAccessDenied:
      description: 專案未綁定或 Broker/API Key 不匹配
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            code: 40300801
            reason: P_DEX_BUILDER_IN_PROJECT_ACCESS_DENIED
            label: PROJECT_ACCESS_DENIED
            message: project access denied
            data: null
  securitySchemes:
    BrokerAPIKey:
      type: apiKey
      in: header
      name: KEY
      description: Broker API Key
    Timestamp:
      type: apiKey
      in: header
      name: Timestamp
      description: Unix 秒級時間戳
    Signature:
      type: apiKey
      in: header
      name: SIGN
      description: 使用 Broker Secret Key 生成的 HMAC-SHA512 十六進制簽名

````

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