curl --request GET \
--url https://api.citadel.example/api/v1/transfers/{tx_hash} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.citadel.example/api/v1/transfers/{tx_hash}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/transfers/{tx_hash}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/transfers/{tx_hash}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"tx_hash": "<string>",
"chain": "tron",
"instance": "<string>",
"network": "mainnet",
"direction": "in",
"status": "confirmed",
"legs": [
{
"index": 123,
"asset": "<string>",
"contract": "<string>",
"kind": "<string>",
"from": "<string>",
"from_basis": "owner",
"origin": "<string>",
"to": "<string>",
"amount_base_units": "<string>",
"wallet": "<string>"
}
],
"block_number": 123,
"block_time": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"aml": [
{
"provider": "<string>",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"checked_at": "2023-11-07T05:31:56Z",
"response": {}
}
]
}Get a transfer
One transfer by its transaction hash, on network — the answer to “I sent it, where is
it?”. 404 until it is confirmed: Citadel reports a transaction once it is final. The body
is a row of the list: the blockchain_event.confirmed webhook’s, plus aml. Read it again
after a screening workflow ran to see the provider’s reply.
Needs the read scope. A transfer that touches no wallet in the key’s vaults answers 404.
curl --request GET \
--url https://api.citadel.example/api/v1/transfers/{tx_hash} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.citadel.example/api/v1/transfers/{tx_hash}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/transfers/{tx_hash}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/transfers/{tx_hash}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"tx_hash": "<string>",
"chain": "tron",
"instance": "<string>",
"network": "mainnet",
"direction": "in",
"status": "confirmed",
"legs": [
{
"index": 123,
"asset": "<string>",
"contract": "<string>",
"kind": "<string>",
"from": "<string>",
"from_basis": "owner",
"origin": "<string>",
"to": "<string>",
"amount_base_units": "<string>",
"wallet": "<string>"
}
],
"block_number": 123,
"block_time": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"aml": [
{
"provider": "<string>",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"checked_at": "2023-11-07T05:31:56Z",
"response": {}
}
]
}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.
Path Parameters
The transaction hash, as the chain's explorers show it.
Query Parameters
The network the data lives on. Required — there is no default network: without it,
422 network_required. A wallet named by its id on another network: 422 network_mismatch.
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 Response
The transfer.
tron, evm, solana, ton The chain instance it landed on, as GET /networks names it: for EVM, which L1/L2.
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 in arrived from outside (a deposit), out left your wallets, internal moved between two of them.
in, out, internal Always confirmed. Citadel reports a transaction only once it is final.
confirmed Show child attributes
Show child attributes
The block's time, as the chain states it.
When Citadel recorded it — what from and to filter on.
API only: the compliance screenings your workflows ran for this transfer — the workflows it started, and the ones they called. Empty when none ran. The webhook body has none: it leaves before any screening.
Show child attributes
Show child attributes