> 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/description/data-structure.md).
# Data structure
#### Currency detail
{% hint style="info" %}
TIP
CurrencyDetail
{% endhint %}
| Name | Type | Description | Example |
| ------------------------ | ------- | ------------------------------------------- | ----------------------------------------------------------------------- |
| network | string | Network | Example value: `TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| chain | string | Owned public chain | Example value: `TRON`、`ETHEREUM`、`BSC` |
| code | string | Currency code | |
| currency | string | Currency | |
| name | integer | Name | |
| logo | integer | LOGO | |
| contract\_address | integer | Contract address | |
| decimal | integer | | |
| Accuracy | | | |
| is\_fiat | integer | Whether is it a fiat currency | Yes `1` No `0` |
| payment\_qr\_code | integer | Whether to support payment by scanning code | Yes `1` No `0` |
| payment\_connect\_wallet | integer | Whether to support payment by ConnectWallet | Yes `1` No `0` |
| payment\_tron\_link | integer | Whether to support payment by tronlink | Yes `1` No `0` |
| min\_payment\_amount | integer | Minimum payment amount | |
| max\_payment\_amount | integer | Maximum payment amount | |
#### Transaction detail
{% hint style="info" %}
TIP
TransactionDetail
{% endhint %}
| Name | Type | Description | Example |
| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- |
| out\_trade\_no | string | Merchant order number | |
| transaction\_id | string | Platform order number | |
| description | string | Order description（utf8-mb4） | |
| block\_no | integer | Block number, you can also query the block hash through this param | |
| create\_time | integer | Order creation time | |
| block\_time | integer | Block time | |
| pay\_time | integer | Payment time ( only for success ) | |
| tx\_id | string | Transaction hash | |
| from\_address | string | Payment address | |
| contract\_address | string | Contract address | |
| to\_address | string | Fund transfer address | |
| amount | integer | Transaction amount | |
| decimals | integer | Transaction amount accuracy | |
| pay\_amount | integer | Amount actually paid | |
| pay\_decimal | integer | Amount actually paid accuracy | |
| pay\_currency | string | Actual payment currency | |
| pay\_chain | string | Actual payment public chain: TRON、ETHEREUM、BSC | |
| attach | string | Additional data, returned as-is in the query API and payment notifications, can be used as a custom parameter, in practice only payment completion status is returned to this field. | |
| service\_amount | integer | Service charge | |
| service\_amount\_currency | string | Service charge currency | |
| status | integer | Status | 1: Unpaid 2: Successful payment 3: Forward refund 4: Closed |
| currency | object | Payment currency details | |
| currency.network | string | Network | Example value：`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| currency.chain | string | Owned public chain | Example value：`TRON`、`ETHEREUM`、`BSC` |
| currency.code | string | Currency code | |
| currency.currency | string | Currency | |
| currency.name | string | Name | |
| currency.contract\_address | string | Contract address | |
| currency.decimal | integer | | |
#### Notice details
{% hint style="info" %}
TIP
transactionNotifyDetail
{% endhint %}
| Name | Type | Description | Example |
| ----------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| out\_trade\_no | string | Merchant order number | |
| transaction\_id | string | Platform order number | |
| description | string | Order description（utf8-mb4） | |
| block\_no | integer | Block number, you can also query the block hash through this param | |
| create\_time | integer | Order creation time | |
| block\_time | integer | Block time | |
| pay\_time | integer | Payment time ( only for success ) | |
| tx\_id | string | Transaction hash | |
| from\_address | string | Payment address | |
| contract\_address | string | Contract address | |
| to\_address | string | Fund transfer address | |
| amount | integer | Transaction amount | |
| decimals | integer | Transaction amount accuracy | |
| currency | CurrencyDetail | CurrencyDetail | |
| pay\_amount | integer | Amount actually paid | |
| pay\_decimal | integer | Amount actually paid accuracy | |
| pay\_currency | string | Actual payment currency | |
| pay\_chain | string | Actual payment public chain TRON、ETHEREUM、BSC | |
| attach | string | Additional data, returned as-is in the query API and payment notifications, can be used as a custom parameter, in practice only payment completion status is returned to this field. | |
| handle\_status | integer | Treatment Status | 1: `Pending`; 2: `In progress`; 3:`Processed`; 4:`Wait for verificatio` |
| status | integer | Status | 1:`Unpaid`; 2:`Successful payment`; 3:`Forward refund`; 4:`Closed`; |
| sign | string | Signature | |
| price\_rate | folat | Currency exchange rate | |
#### Payout detial
{% hint style="info" %}
TIP
PayoutTransactionDetail
{% endhint %}
| Name | Type | Description | Description |
| -------------------------- | ------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| out\_trade\_no | string | Merchant order number | Example value: `fb72xxxx-xxxx-xxxx-xxxx-xxxx8a7b52cb` |
| transaction\_id | string | Platform order number | Example value: `e98b30294xxxxxxxxxxxx97a9d9e09ce` |
| trade\_type | string | Type of transaction | Example value: DAPP、TRANSFER、API |
| description | string | Order description | Example value: `recharge` |
| block\_no | integer | Block number | Example value: `33215220` |
| create\_time | integer | Order creation time | Example value: `1673407302044` |
| block\_time | integer | Block time | Example value: `1673407329000` |
| pay\_time | integer | Payment time | Example value: `1673407329000` |
| tx\_id | string | Transaction hash | Example value: `9fdf0ab5823e23225f93bcc644af30a6ab83b6583a8e29e359ee80219802a33a` |
| from\_address | string | Payment address | Example value: `TULRFYoFuEmUbxxxxxxxx8nQYFHJ88888` |
| contract\_address | string | Contract address | Example value: `TR7NHqjeKQxGTxxxxxxxxpL8otSzgjLj6t` |
| to\_address | string | Collection address | Example value: `TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w` |
| amount | number | Transaction amount | Example value: `15000000` |
| pay\_chain | integer | Actual payment public chain | Example value: `TRON`、`ETHEREUM`、`BSC`. [View support public chain](/currency/currency-information.md) |
| decimals | integer | Token accuracy | Example value: `6` |
| pay\_network | string | Payment network | Example value: TRX、TRC10、TRC20、TRC721、TRC1155、ERC20、BEP20 |
| pay\_currency | string | Actual currency of payment | |
| pay\_amount | integer | Actual payments | |
| pay\_decimal | integer | Accuracy of actual payment amount | |
| attach | string | Self-defined parameter | Returns as-is in the query API and payment notifications, can be used as a custom parameter, in practice only payment completion status will return this field. |
| service\_amount | number | Service charge | Example value: `45000` |
| service\_rate | folat | Service charge rates | |
| service\_amount\_currency | string | Service charge | Example value: `USDT` |
| status | integer | Status | Example value: `1`: Unpaid; `2`: Successful payment; `3`:Forward refund; `4`: Closed; |
| handle\_status | integer | Handle status | Example values: `1 :` Pending `2` : Processing `3` : Processed `4` : Pending verification |
| currency | object | Payment token details | |
| currency.network | string | Network | Example value：`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| currency.chain | string | Owned public chain | Example value：`TRON`、`ETHEREUM`、`BSC` |
| currency.code | string | Currency code | |
| currency.currency | string | Currency | |
| currency.name | string | Name | |
| currency.contract\_address | string | Contract address | |
| currency.decimal | integer | | |
#### **merchantBalance**
{% hint style="info" %}
TIP
merchantBalance
{% endhint %}
| Name | Type | Description | Description |
| ------------ | ------- | ------------------ | ----------------------------------------------------------------------- |
| merchant\_id | integer | Merchant ID | Example value: `1234567890` |
| mch\_id | string | Merchant ID | Example value: `12345678` |
| network | string | Network | Example value: `TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| chain | string | Owned public chain | Example value: `TRON`、`ETHEREUM`、`BSC` |
| balance | string | Balance | |
| currency | string | Currency | |
| decimal | integer | | |
| create\_time | integer | Creation time | Example value: `1673333676` |
| modify\_time | integer | Modify time | Example value: `1673333676` |
| cash\_time | integer | Cash time | Example value: `1673333676` |