> 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/pt-br/descricao/estrutura-de-dados.md).

# Estrutura de dados

#### Detalhes da moeda

{% hint style="info" %}
DICA(TIP)

Detalhes da moeda
{% endhint %}

| **Nome**                 | **Tipo** | **Descrição**                                | **Exemplo**                                                                |
| ------------------------ | -------- | -------------------------------------------- | -------------------------------------------------------------------------- |
| network                  | string   | Rede                                         | Valor de exemplo: `TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| chain                    | string   | Cadeia pública pertencente                   | Valor de exemplo: `TRON`、`ETHEREUM`、`BSC`                                  |
| code                     | string   | Código da moeda                              |                                                                            |
| currency                 | string   | Moeda                                        |                                                                            |
| name                     | integer  | Nome                                         |                                                                            |
| logo                     | integer  | LOGOTIPO                                     |                                                                            |
| contract\_address        | integer  | Endereço do contrato                         |                                                                            |
| decimal                  | integer  |                                              |                                                                            |
| Accuracy                 |          |                                              |                                                                            |
| is\_fiat                 | integer  | Se é uma moeda fiduciária                    | Sim `1` Não `0`                                                            |
| payment\_qr\_code        | integer  | Suporta pagamento por código de escaneamento | Sim `1` Não `0`                                                            |
| payment\_connect\_wallet | integer  | Suporta pagamento por ConnectWallet          | Sim `1` Não `0`                                                            |
| payment\_tron\_link      | integer  | Suporta pagamento por tronlink               | Sim `1` Não `0`                                                            |
| min\_payment\_amount     | integer  | Valor mínimo de pagamento                    |                                                                            |
| max\_payment\_amount     | integer  | Valor máximo de pagamento                    |                                                                            |

#### Detalhes da transação

{% hint style="info" %}
DICA(TIP)

Detalhes da transação
{% endhint %}

| **Nome**                   | **Tipo** | **Descrição**                                                                                                                                                                                                                    | **Exemplo**                                                                |
| -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| out\_trade\_no             | string   | Número do pedido do comerciante                                                                                                                                                                                                  |                                                                            |
| transaction\_id            | string   | Número do pedido da plataforma                                                                                                                                                                                                   |                                                                            |
| description                | string   | Descrição do pedido (utf8-mb4)                                                                                                                                                                                                   |                                                                            |
| block\_no                  | integer  | Número do bloco, você também pode consultar o hash do bloco através deste parâmetro                                                                                                                                              |                                                                            |
| create\_time               | integer  | Hora de criação do pedido                                                                                                                                                                                                        |                                                                            |
| block\_time                | integer  | Tempo do bloco                                                                                                                                                                                                                   |                                                                            |
| pay\_time                  | integer  | Tempo de pagamento (apenas para sucesso)                                                                                                                                                                                         |                                                                            |
| tx\_id                     | string   | Hash da transação                                                                                                                                                                                                                |                                                                            |
| from\_address              | string   | Endereço de pagamento                                                                                                                                                                                                            |                                                                            |
| contract\_address          | string   | Endereço do contrato                                                                                                                                                                                                             |                                                                            |
| to\_address                | string   | Endereço de transferência de fundos                                                                                                                                                                                              |                                                                            |
| amount                     | integer  | Valor da transação                                                                                                                                                                                                               |                                                                            |
| decimals                   | integer  | Precisão do valor da transação                                                                                                                                                                                                   |                                                                            |
| pay\_amount                | integer  | Valor efetivamente pago                                                                                                                                                                                                          |                                                                            |
| pay\_decimal               | integer  | Precisão do valor efetivamente pago                                                                                                                                                                                              |                                                                            |
| pay\_currency              | string   | Moeda de pagamento real                                                                                                                                                                                                          |                                                                            |
| pay\_chain                 | string   | Cadeia pública de pagamento real: TRON, ETHEREUM, BSC                                                                                                                                                                            |                                                                            |
| attach                     | string   | Dados adicionais, retornados como estão na API de consulta e nas notificações de pagamento, podem ser usados como um parâmetro personalizado; na prática, apenas o status de conclusão do pagamento é retornado para este campo. |                                                                            |
| service\_amount            | integer  | Taxa de serviço                                                                                                                                                                                                                  |                                                                            |
| service\_amount\_currency  | string   | Moeda da taxa de serviço                                                                                                                                                                                                         |                                                                            |
| status                     | integer  | Status                                                                                                                                                                                                                           | 1: Unpaid 2: Successful payment 3: Forward refund 4: Closed                |
| currency                   | object   | Detalhes da moeda de pagamento                                                                                                                                                                                                   |                                                                            |
| currency.network           | string   | Rede                                                                                                                                                                                                                             | Valor de exemplo: `TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| currency.chain             | string   | Cadeia pública pertencente                                                                                                                                                                                                       | Valor de exemplo: `TRON`、`ETHEREUM`、`BSC`                                  |
| currency.code              | string   | Código da moeda                                                                                                                                                                                                                  |                                                                            |
| currency.currency          | string   | Moeda                                                                                                                                                                                                                            |                                                                            |
| currency.name              | string   | Nome                                                                                                                                                                                                                             |                                                                            |
| currency.contract\_address | string   | Endereço do contrato                                                                                                                                                                                                             |                                                                            |
| currency.decimal           | integer  |                                                                                                                                                                                                                                  |                                                                            |

#### Detalhes do aviso

{% hint style="info" %}
DICA(TIP)

detalhes da notificação de transação
{% endhint %}

| **Nome**          | **Tipo**       | **Descrição**                                                                                                                                                                                                                    | **Exemplo**                                                             |
| ----------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| out\_trade\_no    | string         | Número do pedido do comerciante                                                                                                                                                                                                  |                                                                         |
| transaction\_id   | string         | Número do pedido da plataforma                                                                                                                                                                                                   |                                                                         |
| description       | string         | Descrição do pedido (utf8-mb4)                                                                                                                                                                                                   |                                                                         |
| block\_no         | integer        | Número do bloco, você também pode consultar o hash do bloco através deste parâmetro                                                                                                                                              |                                                                         |
| create\_time      | integer        | Hora de criação do pedido                                                                                                                                                                                                        |                                                                         |
| block\_time       | integer        | Tempo do bloco                                                                                                                                                                                                                   |                                                                         |
| pay\_time         | integer        | Tempo de pagamento (apenas para sucesso)                                                                                                                                                                                         |                                                                         |
| tx\_id            | string         | Hash da transação                                                                                                                                                                                                                |                                                                         |
| from\_address     | string         | Endereço de pagamento                                                                                                                                                                                                            |                                                                         |
| contract\_address | string         | Endereço do contrato                                                                                                                                                                                                             |                                                                         |
| to\_address       | string         | Endereço de transferência de fundos                                                                                                                                                                                              |                                                                         |
| amount            | integer        | Valor da transação                                                                                                                                                                                                               |                                                                         |
| decimals          | integer        | Precisão do valor da transação                                                                                                                                                                                                   |                                                                         |
| currency          | CurrencyDetail | Objeto de detalhe da moeda                                                                                                                                                                                                       |                                                                         |
| pay\_amount       | integer        | Valor efetivamente pago                                                                                                                                                                                                          |                                                                         |
| pay\_decimal      | integer        | Precisão do valor efetivamente pago                                                                                                                                                                                              |                                                                         |
| pay\_currency     | string         | Moeda de pagamento real                                                                                                                                                                                                          |                                                                         |
| pay\_chain        | string         | Cadeia pública de pagamento real TRON, ETHEREUM, BSC                                                                                                                                                                             |                                                                         |
| attach            | string         | Dados adicionais, retornados como estão na API de consulta e nas notificações de pagamento, podem ser usados como um parâmetro personalizado; na prática, apenas o status de conclusão do pagamento é retornado para este campo. |                                                                         |
| handle\_status    | integer        | Status de tratamento                                                                                                                                                                                                             | 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         | Assinatura                                                                                                                                                                                                                       |                                                                         |
| price\_rate       | folat          | Taxa de câmbio                                                                                                                                                                                                                   |                                                                         |

#### Detalhes do pagamento

{% hint style="info" %}
DICA(TIP)

Detalhes da Transação de Pagamento
{% endhint %}

| Nome                       | Tipo    | Descrição                           | Exemplo                                                                                                                                                                                             |
| -------------------------- | ------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| out\_trade\_no             | string  | Número do pedido do comerciante     | Valor de exemplo:`fb72xxxx-xxxx-xxxx-xxxx-xxxx8a7b52cb`                                                                                                                                             |
| transaction\_id            | string  | Número do pedido da plataforma      | Valor de exemplo:`e98b30294xxxxxxxxxxxx97a9d9e09ce`                                                                                                                                                 |
| trade\_type                | string  | Tipo de transação                   | Valor de exemplo:DAPP、TRANSFER、API                                                                                                                                                                  |
| description                | string  | Descrição do pedido                 | Valor de exemplo:`recharge`                                                                                                                                                                         |
| block\_no                  | integer | Número do bloco                     | Valor de exemplo:`33215220`                                                                                                                                                                         |
| create\_time               | integer | Hora de criação do pedido           | Valor de exemplo:`1673407302044`                                                                                                                                                                    |
| block\_time                | integer | Tempo do bloco                      | Valor de exemplo:`1673407329000`                                                                                                                                                                    |
| pay\_time                  | integer | Tempo de pagamento                  | Valor de exemplo:`1673407329000`                                                                                                                                                                    |
| tx\_id                     | string  | Hash da transação                   | Valor de exemplo:`9fdf0ab5823e23225f93bcc644af30a6ab83b6583a8e29e359ee80219802a33a`                                                                                                                 |
| from\_address              | string  | Endereço de pagamento               | Valor de exemplo:`TULRFYoFuEmUbxxxxxxxx8nQYFHJ88888`                                                                                                                                                |
| contract\_address          | string  | Endereço do contrato                | Valor de exemplo:`TR7NHqjeKQxGTxxxxxxxxpL8otSzgjLj6t`                                                                                                                                               |
| to\_address                | string  | Endereço de cobrança                | Valor de exemplo:`TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w`                                                                                                                                               |
| amount                     | number  | Valor da transação                  | Valor de exemplo:`15000000`                                                                                                                                                                         |
| pay\_chain                 | integer | Cadeia pública de pagamento real    | Valor de exemplo:`TRON`、`ETHEREUM`、`BSC`. [View support public chain](/pt-br/moeda/informacoes-da-moeda.md)                                                                                         |
| decimals                   | integer | Precisão do token                   | Valor de exemplo: `6`                                                                                                                                                                               |
| pay\_network               | string  | Rede de pagamento                   | Valor de exemplo:TRX、TRC10、TRC20、TRC721、TRC1155、ERC20、BEP20                                                                                                                                         |
| pay\_currency              | string  | Moeda de pagamento real             |                                                                                                                                                                                                     |
| pay\_amount                | integer | Pagamentos reais                    |                                                                                                                                                                                                     |
| pay\_decimal               | integer | Precisão do valor real do pagamento |                                                                                                                                                                                                     |
| attach                     | string  | Parâmetro autodefinido              | Retorna como está na API de consulta e nas notificações de pagamento, pode ser usado como um parâmetro personalizado; na prática, apenas o status de conclusão do pagamento retornará a este campo. |
| service\_amount            | number  | Taxa de serviço                     | Valor de exemplo:`45000`                                                                                                                                                                            |
| service\_rate              | folat   | Taxas de serviço                    |                                                                                                                                                                                                     |
| service\_amount\_currency  | string  | Taxa de serviço                     | Valor de exemplo:`USDT`                                                                                                                                                                             |
| status                     | integer | Status                              | Valor de exemplo:`1`: Unpaid; `2`: Successful payment; `3`:Forward refund; `4`: Closed;                                                                                                             |
| handle\_status             | integer | Status de processamento             | Valor de exemplo:`1 :` Pending `2` : Processing `3` : Processed `4` : Pending verification                                                                                                          |
| currency                   | object  | Detalhes do token de pagamento      |                                                                                                                                                                                                     |
| currency.network           | string  | Rede                                | Valor de exemplo:`TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20`                                                                                                                           |
| currency.chain             | string  | Cadeia pública pertencente          | Valor de exemplo:`TRON`、`ETHEREUM`、`BSC`                                                                                                                                                            |
| currency.code              | string  | Código da moeda                     |                                                                                                                                                                                                     |
| currency.currency          | string  | Código da moeda                     |                                                                                                                                                                                                     |
| currency.name              | string  | Nome                                |                                                                                                                                                                                                     |
| currency.contract\_address | string  | Endereço do contrato                |                                                                                                                                                                                                     |
| currency.decimal           | integer |                                     |                                                                                                                                                                                                     |

#### Saldo do comerciante

{% hint style="info" %}
DICA(TIP)

Saldo do comerciante
{% endhint %}

| **Nome**     | **Tipo** | **Descrição**              | **Exemplo**                                                                |
| ------------ | -------- | -------------------------- | -------------------------------------------------------------------------- |
| merchant\_id | integer  | ID do comerciante          | Valor de exemplo: `1234567890`                                             |
| mch\_id      | string   | ID do comerciante          | Valor de exemplo: `12345678`                                               |
| network      | string   | Rede                       | Valor de exemplo: `TRX`、`TRC10`、`TRC20`、`TRC721`、`TRC1155`、`ERC20`、`BEP20` |
| chain        | string   | Cadeia pública pertencente | Valor de exemplo: `TRON`、`ETHEREUM`、`BSC`                                  |
| balance      | string   | Saldo                      |                                                                            |
| currency     | string   | Moeda                      |                                                                            |
| decimal      | integer  |                            |                                                                            |
| create\_time | integer  | Hora de criação            | Valor de exemplo: `1673333676`                                             |
| modify\_time | integer  | Tempo de modificação       | Valor de exemplo: `1673333676`                                             |
| cash\_time   | integer  | Hora do saque              | Valor de exemplo: `1673333676`                                             |
