> 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/wallet/wallet-addition.md).

# Wallet addition

{% hint style="info" %}
TIP

Add the wallet in [monitor mode](/description/payment-method.md).
{% endhint %}

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

```
POST https://api.tokenpay.me/v1/wallet/insert
```

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

| Name            | Location | Type   | Required | Description                                                                                                                                                    |
| --------------- | -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| app\_id         | header   | string | Yes      | Application ID, example value: `8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd`.                                                                                             |
| mch\_id         | body     | string | Yes      | Merchant ID, example value: `1234567890`.                                                                                                                      |
| name            | body     | string | No       | Wallet note. In [monitor wallet mode](/description/payment-method.md), it can be used to identify `one user one wallet` unique information, such as `user ID`. |
| wallet\_address | body     | string | Yes      | Wallet address, example value: `TQjxEW2Z3pxxxxxxxxxxxxgJUrWXVAC92T`.                                                                                           |
| chain           | body     | string | Yes      | Owned public chain, example value:`TRON`、`ETHEREUM`、`BSC`. [View supported public chains](/currency/currency-information.md).                                  |

#### Parameters example <a href="#parameters-example" id="parameters-example"></a>

```json
{
  "mch_id": "1234567890",
  "app_id": "8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd",
  "wallet_address": "TQjxEW2Z3pxxxxxxxxxxxxgJUrWXVAC92T",
  "chain": "TRON",
  "name": "28713"
}
```

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

| Name        | Type                                                         | Required | Description                               |
| ----------- | ------------------------------------------------------------ | -------- | ----------------------------------------- |
| code        | integer                                                      | true     | [Status code](/error-code/status-code.md) |
| msg         | string                                                       | true     | Statements                                |
| request\_id | string                                                       | true     |                                           |
| data        | [WalletDetail](/description/data-structure.md#wallet-detial) | false    |                                           |

### Return example <a href="#return-example" id="return-example"></a>

```json
{
    "code": 0,
    "msg": "ok",
    "request_id": "60eeeab2-7896-4f80-8088-4251d262dea6",
    "data": {
        "app_id": "8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd",
        "mch_id": "1234567890",
        "name": "28713",
        "chain": "TRON",
        "wallet_address": "TQjxEW2Z3pxxxxxxxxxxxxgJUrWXVAC92T",
        "create_time": 1675236993,
        "last_time": 0
    }
}
```

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

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

```sh
curl --location --request POST 'https://api.tokenpay.me/v1/wallet/insert' \
--header 'Authorization: <Authorization>' \
--header 'User-Agent: tokenpay API (https://tokenpay.me)' \
--header 'Content-Type: application/json' \
--data-raw '<body data here>'
```

{% endtab %}

{% tab title="Go" %}

```go
package main

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

func main() {

   url := "https://api.tokenpay.me/v1/wallet/insert"
   method := "POST"

   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/wallet/insert',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'<body data here>',
   CURLOPT_HTTPHEADER => array(
      'Authorization: <Authorization>',
      'User-Agent: tokenpay API (https://tokenpay.me)',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

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

<br>
{% endtab %}

{% tab title="Python" %}

```python
import http.client
import json

conn = http.client.HTTPSConnection("https://api.tokenpay.me")
payload = "<body data here>"
headers = {
   'Authorization': '<Authorization>',
   'User-Agent': 'tokenpay API (https://tokenpay.me)',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/wallet/insert", 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/wallet/insert")
   .method("POST", body)
   .addHeader("Authorization", "<Authorization>")
   .addHeader("User-Agent", "tokenpay API (https://tokenpay.me)")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://apidoc.tokenpay.me/wallet/wallet-addition.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
