curl --request POST \
--url https://api.citadel.example/api/v1/wallets/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"network": "mainnet",
"wallets": [
{
"reference": "user-4211",
"chain": "tron",
"end_user_ref": "user-4211",
"tags": [
"vip"
]
},
{
"reference": "user-4212",
"chain": "tron",
"end_user_ref": "user-4212"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
network: 'mainnet',
wallets: [
{
reference: 'user-4211',
chain: 'tron',
end_user_ref: 'user-4211',
tags: ['vip']
},
{reference: 'user-4212', chain: 'tron', end_user_ref: 'user-4212'}
]
})
};
fetch('https://api.citadel.example/api/v1/wallets/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/wallets/batch"
payload = {
"network": "mainnet",
"wallets": [
{
"reference": "user-4211",
"chain": "tron",
"end_user_ref": "user-4211",
"tags": ["vip"]
},
{
"reference": "user-4212",
"chain": "tron",
"end_user_ref": "user-4212"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/wallets/batch"
payload := strings.NewReader("{\n \"network\": \"mainnet\",\n \"wallets\": [\n {\n \"reference\": \"user-4211\",\n \"chain\": \"tron\",\n \"end_user_ref\": \"user-4211\",\n \"tags\": [\n \"vip\"\n ]\n },\n {\n \"reference\": \"user-4212\",\n \"chain\": \"tron\",\n \"end_user_ref\": \"user-4212\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"chain": "tron",
"network": "mainnet",
"status": "creating",
"created_at": "2023-11-07T05:31:56Z",
"address": "<string>",
"label": "<string>",
"tags": [
"<string>"
],
"end_user_ref": "<string>",
"vault": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_implementation": "<string>"
}
]
}Issue wallets in a batch
Issues up to 100 wallets in one call — for instance when your users move over from another
system. network is named once, for the whole batch: every wallet is issued on it. Each item
of wallets is what POST /wallets takes (reference, chain, end_user_ref, and
optionally label, tags, vault, account_implementation) and is issued or found the same
way: a reference that already names a wallet on the network returns that wallet as it is.
All or nothing. An item that is refused refuses the whole batch with 422, its index in the
message (wallets[3]: chain is not supported), and nothing is created. Fix it and send the
same batch again: the wallets it names that already exist come back as they are, the rest are
issued. An item may repeat the batch’s network, but not name another one; a reference may
appear once per batch; any other field is refused.
data lists the wallets in the order you sent them. A new wallet answers status: creating
without an address, as with POST /wallets: each one gets its wallet.active webhook when
your signer has derived it. Your signer derives them one after another, so the addresses of a
large batch arrive over a while.
Needs the wallets.write scope. A key limited to vaults issues only into them; an item whose
vault is outside them, or whose reference names a wallet outside them, refuses the batch.
curl --request POST \
--url https://api.citadel.example/api/v1/wallets/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"network": "mainnet",
"wallets": [
{
"reference": "user-4211",
"chain": "tron",
"end_user_ref": "user-4211",
"tags": [
"vip"
]
},
{
"reference": "user-4212",
"chain": "tron",
"end_user_ref": "user-4212"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
network: 'mainnet',
wallets: [
{
reference: 'user-4211',
chain: 'tron',
end_user_ref: 'user-4211',
tags: ['vip']
},
{reference: 'user-4212', chain: 'tron', end_user_ref: 'user-4212'}
]
})
};
fetch('https://api.citadel.example/api/v1/wallets/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/wallets/batch"
payload = {
"network": "mainnet",
"wallets": [
{
"reference": "user-4211",
"chain": "tron",
"end_user_ref": "user-4211",
"tags": ["vip"]
},
{
"reference": "user-4212",
"chain": "tron",
"end_user_ref": "user-4212"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/wallets/batch"
payload := strings.NewReader("{\n \"network\": \"mainnet\",\n \"wallets\": [\n {\n \"reference\": \"user-4211\",\n \"chain\": \"tron\",\n \"end_user_ref\": \"user-4211\",\n \"tags\": [\n \"vip\"\n ]\n },\n {\n \"reference\": \"user-4212\",\n \"chain\": \"tron\",\n \"end_user_ref\": \"user-4212\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"chain": "tron",
"network": "mainnet",
"status": "creating",
"created_at": "2023-11-07T05:31:56Z",
"address": "<string>",
"label": "<string>",
"tags": [
"<string>"
],
"end_user_ref": "<string>",
"vault": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_implementation": "<string>"
}
]
}Authorizations
An API key minted in the console (ctd_…). Authenticates; never authorizes funds. A key
carries scopes (read, wallets.write, transactions.write, events.write,
webhooks.write, policy.write) and may be limited to vaults, to IP addresses, and in
lifetime — see Authentication.
Body
The network the data lives on. Required wherever it appears in a request — there is no
default network. One your installation does not serve: 422 network_not_served.
mainnet, testnet 1 - 100 elementsShow child attributes
Show child attributes
Response
Every reference already named a wallet on this network. Nothing was issued.
The wallets, in the order the batch named them.
Show child attributes
Show child attributes