# Balance Inquiry

{% hint style="info" %}
TIP

Check account balance and real-time status
{% endhint %}

### Interface address <a href="#interface-address" id="interface-address"></a>

```
POST https://api.tokenpay.me/v1/merchant/balance
```

### Interface parameters <a href="#interface-parameters" id="interface-parameters"></a>

| Name     | Location | Type   | Required | Description                                                                                                          |
| -------- | -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------- |
| mch\_id  | body     | string | Yes      | Merchant ID, example value:`12345678`                                                                                |
| chain    | body     | string | Yes      | Owned public chain, example value:`TRON`                                                                             |
| currency | body     | string | Yes      | Currency, example value:`TRX`. [View supported currencies](https://apidoc.tokenpay.me/currency/currency-information) |

### Interface return <a href="#interface-return" id="interface-return"></a>

| Name        | Type    | Description                                                              | Description                                                                         |
| ----------- | ------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
| code        | integer | [Service status code](https://apidoc.tokenpay.me/error-code/status-code) | Service status code. 0: success, non 0: indicate the specific cause reference `msg` |
| msg         | string  | Status service message                                                   | Status service message                                                              |
| request\_id | string  | Request ID                                                               | Request ID                                                                          |
| data        | array   | [merchantBalance](/description/data-structure.md#merchantbalance)        | Content                                                                             |

### Return example

```json
{
    "code": 0,
    "msg": "ok",
    "request_id": "08250916-a677-4a36-a090-323807ac644c",
    "data": {
     "merchant_id": 167,
        "mch_id": "12345678",
        "network": "TRC20",
        "chain": "TRON",
        "balance": "54670000",
        "currency": "USDT",
        "decimal": 6,
        "create_time": 1724237814113,
        "modify_time": 1724239248394,
        "cash_time": 0
    }
}
```

### Example code <a href="#example-code" id="example-code"></a>

{% tabs %}
{% tab title="Shell" %}

```sh
curl --location --request GET 'https://api.tokenpay.me/v1/merchant/balance
--header 'Authorization: '
--header 'User-Agent: Tokenpay API (https://tokenpay.me)'
--header 'Content-Type: application/json'
--data-raw ''
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
   "fmt"
   "strings"
   "net/http"
   "io/ioutil"
)

func main() {

   url := "https://api.tokenpay.me/v1/merchant/balance"
   method := "GET"

   payload := strings.NewReader(`<body data here>`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("Authorization", "<Authorization>")
   req.Header.Add("User-Agent", "Tokenpay API (https://tokenpay.me)")
   req.Header.Add("Content-Type", "application/json")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := ioutil.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.tokenpay.me/v1/merchant/balance',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_POSTFIELDS =>'<body data here>',
   CURLOPT_HTTPHEADER => array(
      'Authorization: <Authorization>',
      'User-Agent: Tokenpay API (https://api.tokenpay.me)',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

{% endtab %}

{% tab title="Python" %}

```python
import http.client
import json

conn = http.client.HTTPSConnection("https://api.tokenpay.io")
payload = "<body data here>"
headers = {
   'Authorization': '<Authorization>',
   'User-Agent': 'TokenpayAPI (https://tokenpay.io)',
   'Content-Type': 'application/json'
}
conn.request("GET", "/v1/merchant/balance", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```java
OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "<body data here>");
Request request = new Request.Builder()
   .url("https://api.tokenpay.me/v1/merchant/balance")
   .method("GET", body)
   .addHeader("Authorization", "<Authorization>")
   .addHeader("User-Agent", "Tokenpay API (https://tokenpay.io)")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidoc.tokenpay.me/currency/balance-inquiry.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
