> For the complete documentation index, see [llms.txt](https://apidoc.tokenpay.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.tokenpay.me/zh-hk/shuo-ming/zi-liao-jie-gou.md).

# 資料結構

#### 貨幣詳情

{% hint style="info" %}
提示（TIP）

貨幣詳情
{% endhint %}

| **參數名稱**                 | **類型**  | **描述**                | **示例**                                                       |
| ------------------------ | ------- | --------------------- | ------------------------------------------------------------ |
| network                  | string  | 網路                    | 示例值：`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| chain                    | string  | 所屬公鏈                  | 示例值：`TRON`、`ETHEREUM`、`BSC`                                  |
| code                     | string  | 幣種代碼                  |                                                              |
| currency                 | string  | 幣種                    |                                                              |
| name                     | integer | 名稱                    |                                                              |
| logo                     | integer | 圖標                    |                                                              |
| contract\_address        | integer | 合約地址                  |                                                              |
| decimal                  | integer |                       |                                                              |
| Accuracy                 |         |                       |                                                              |
| is\_fiat                 | integer | 是否為法定貨幣               | 是 1 否 0                                                      |
| payment\_qr\_code        | integer | 是否支援掃碼支付              | 是 1 否 0                                                      |
| payment\_connect\_wallet | integer | 是否支援 ConnectWallet 支付 | 是 1 否 0                                                      |
| payment\_tron\_link      | integer | 是否支援 tronlink 支付      | 是 1 否 0                                                      |
| min\_payment\_amount     | integer | 最小支付金額                |                                                              |
| max\_payment\_amount     | integer | 最大支付金額                |                                                              |

#### 交易詳情

{% hint style="info" %}
提示（TIP）

交易詳情
{% endhint %}

| **參數名稱**                   | **類型**  | **描述**                                              | **示例**                                                       |
| -------------------------- | ------- | --------------------------------------------------- | ------------------------------------------------------------ |
| out\_trade\_no             | string  | 商戶訂單號                                               |                                                              |
| transaction\_id            | string  | 平台訂單號                                               |                                                              |
| description                | string  | 訂單描述（utf8-mb4）                                      |                                                              |
| block\_no                  | integer | 區塊高度，您也可以透過此參數查詢區塊哈希                                |                                                              |
| create\_time               | integer | 訂單創建時間                                              |                                                              |
| block\_time                | integer | 區塊時間                                                |                                                              |
| pay\_time                  | integer | 支付時間（僅限成功）                                          |                                                              |
| tx\_id                     | string  | 交易哈希                                                |                                                              |
| from\_address              | string  | 支付地址                                                |                                                              |
| contract\_address          | string  | 合約地址                                                |                                                              |
| to\_address                | string  | 資金轉帳地址                                              |                                                              |
| amount                     | integer | 交易金額                                                |                                                              |
| decimals                   | integer | 交易金額精度                                              |                                                              |
| pay\_amount                | integer | 實際支付金額                                              |                                                              |
| pay\_decimal               | integer | 實際支付金額精度                                            |                                                              |
| pay\_currency              | string  | 實際支付幣種                                              |                                                              |
| pay\_chain                 | string  | 實際支付公鏈: TRON、ETHEREUM、BSC                           |                                                              |
| attach                     | string  | 附加數據，在查詢 API 和支付通知中原樣返回，可作為自定義參數，實際上僅在支付完成狀態下返回此欄位。 |                                                              |
| service\_amount            | integer | 手續費                                                 |                                                              |
| service\_amount\_currency  | string  | 手續費幣種                                               |                                                              |
| status                     | integer | 狀態                                                  | 1: 未支付 2: 支付成功 3: 正向退款 4: 已關閉                                |
| currency                   | object  | 支付幣種詳情                                              |                                                              |
| currency.network           | string  | 網路                                                  | 示例值：`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| currency.chain             | string  | 所屬公鏈                                                | 示例值：`TRON`、`ETHEREUM`、`BSC`                                  |
| currency.code              | string  | 幣種代碼                                                |                                                              |
| currency.currency          | string  | 幣種                                                  |                                                              |
| currency.name              | string  | 名稱                                                  |                                                              |
| currency.contract\_address | string  | 合約地址                                                |                                                              |
| currency.decimal           | integer |                                                     |                                                              |

#### 通知詳情

{% hint style="info" %}
提示（TIP）

交易通知詳情
{% endhint %}

| **參數名稱**          | **類型**         | **描述**                                              | **示例**                             |
| ----------------- | -------------- | --------------------------------------------------- | ---------------------------------- |
| out\_trade\_no    | string         | 商戶訂單號                                               |                                    |
| transaction\_id   | string         | 平台訂單號                                               |                                    |
| description       | string         | 訂單描述（utf8-mb4）                                      |                                    |
| block\_no         | integer        | 區塊高度，您也可以透過此參數查詢區塊哈希                                |                                    |
| create\_time      | integer        | 訂單創建時間                                              |                                    |
| block\_time       | integer        | 區塊時間                                                |                                    |
| pay\_time         | integer        | 支付時間（僅限成功）                                          |                                    |
| tx\_id            | string         | 交易哈希                                                |                                    |
| from\_address     | string         | 支付地址                                                |                                    |
| contract\_address | string         | 合約地址                                                |                                    |
| to\_address       | string         | 資金轉帳地址                                              |                                    |
| amount            | integer        | 交易金額                                                |                                    |
| decimals          | integer        | 交易金額精度                                              |                                    |
| currency          | CurrencyDetail | 幣種詳情對象                                              |                                    |
| pay\_amount       | integer        | 實際支付金額                                              |                                    |
| pay\_decimal      | integer        | 實際支付金額精度                                            |                                    |
| pay\_currency     | string         | 實際支付幣種                                              |                                    |
| pay\_chain        | string         | 實際支付公鏈 TRON、ETHEREUM、BSC                            |                                    |
| attach            | string         | 附加數據，在查詢 API 和支付通知中原樣返回，可作為自定義參數，實際上僅在支付完成狀態下返回此欄位。 |                                    |
| handle\_status    | integer        | 處理狀態                                                | 1: `待處理`；2: `處理中`；3:`已處理`；4:`待驗證`  |
| status            | integer        | 狀態                                                  | 1:`未支付`；2:`支付成功`；3:`正向退款`；4:`已關閉`； |
| sign              | string         | 簽名                                                  |                                    |
| price\_rate       | folat          | 貨幣匯率                                                |                                    |

#### 代付詳情

{% hint style="info" %}
提示（TIP）

代付交易詳情
{% endhint %}

| 參數名稱                       | 類型      | 描述       | 示例                                                                                           |
| -------------------------- | ------- | -------- | -------------------------------------------------------------------------------------------- |
| out\_trade\_no             | string  | 商戶訂單號    | 示例值：`fb72xxxx-xxxx-xxxx-xxxx-xxxx8a7b52cb`                                                   |
| transaction\_id            | string  | 平台訂單號    | 示例值：`e98b30294xxxxxxxxxxxx97a9d9e09ce`                                                       |
| trade\_type                | string  | 交易類型     | 示例值：DAPP、TRANSFER、API                                                                        |
| description                | string  | 訂單描述     | 示例值：`recharge`                                                                               |
| block\_no                  | integer | 區塊高度     | 示例值：`33215220`                                                                               |
| create\_time               | integer | 訂單創建時間   | 示例值：`1673407302044`                                                                          |
| block\_time                | integer | 區塊時間     | 示例值：`1673407329000`                                                                          |
| pay\_time                  | integer | 支付時間     | 示例值：`1673407329000`                                                                          |
| tx\_id                     | string  | 交易哈希     | 示例值：`9fdf0ab5823e23225f93bcc644af30a6ab83b6583a8e29e359ee80219802a33a`                       |
| from\_address              | string  | 支付地址     | 示例值：`TULRFYoFuEmUbxxxxxxxx8nQYFHJ88888`                                                      |
| contract\_address          | string  | 合約地址     | 示例值：`TR7NHqjeKQxGTxxxxxxxxpL8otSzgjLj6t`                                                     |
| to\_address                | string  | 收款地址     | 示例值：`TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w`                                                     |
| amount                     | number  | 交易金額     | 示例值：`15000000`                                                                               |
| pay\_chain                 | integer | 實際支付公鏈   | 示例值：`TRON`、`ETHEREUM`、`BSC`. [View support public chain](/zh-hk/bi-zhong/bi-zhong-xin-xi.md) |
| decimals                   | integer | 代幣精度     | 示例值： `6`                                                                                     |
| pay\_network               | string  | 支付網路     | 示例值：TRX、TRC10、TRC20、TRC721、TRC1155、ERC20、BEP20                                               |
| pay\_currency              | string  | 實際支付幣種   |                                                                                              |
| pay\_amount                | integer | 實際支付金額   |                                                                                              |
| pay\_decimal               | integer | 實際支付金額精度 |                                                                                              |
| attach                     | string  | 自定義參數    | 在查詢 API 和支付通知中原樣返回，可作為自定義參數，實際上僅在支付完成狀態下會返回此欄位。                                              |
| service\_amount            | number  | 手續費      | 示例值： `45000`                                                                                 |
| service\_rate              | folat   | 手續費率     |                                                                                              |
| service\_amount\_currency  | string  | 手續費      | 示例值： `USDT`                                                                                  |
| status                     | integer | 狀態       | 示例值： `1`: Unpaid; `2`: Successful payment; `3`:Forward refund; `4`: Closed;                  |
| handle\_status             | integer | 處理狀態     | 示例值： `1 :` Pending `2` : Processing `3` : Processed `4` : Pending verification               |
| currency                   | object  | 支付代幣詳情   |                                                                                              |
| currency.network           | string  | 網路       | 示例值：`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20`                                 |
| currency.chain             | string  | 所屬公鏈     | 示例值：`TRON`、`ETHEREUM`、`BSC`                                                                  |
| currency.code              | string  | 幣種代碼     |                                                                                              |
| currency.currency          | string  | 幣種       |                                                                                              |
| currency.name              | string  | 名稱       |                                                                                              |
| currency.contract\_address | string  | 合約地址     |                                                                                              |
| currency.decimal           | integer |          |                                                                                              |

#### 商戶餘額

{% hint style="info" %}
提示（TIP）

商戶餘額
{% endhint %}

| **參數名稱**     | **類型**  | **描述** | **示例**                                                       |
| ------------ | ------- | ------ | ------------------------------------------------------------ |
| merchant\_id | integer | 商戶 ID  | 示例值：`1234567890`                                             |
| mch\_id      | string  | 商戶 ID  | 示例值：`12345678`                                               |
| network      | string  | 網路     | 示例值：`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| chain        | string  | 所屬公鏈   | 示例值：`TRON`、`ETHEREUM`、`BS`                                   |
| balance      | string  | 餘額     |                                                              |
| currency     | string  | 幣種     |                                                              |
| decimal      | integer |        |                                                              |
| create\_time | integer | 創建時間   | 示例值：`1673333676`                                             |
| modify\_time | integer | 修改時間   | 示例值：`1673333676`                                             |
| cash\_time   | integer | 提現時間   | 示例值：`1673333676`                                             |
