Create run-off claim
curl --request POST \
--url https://hip4-api.totalis.trade/v1/me/run-off-claims \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"schema_version": 1,
"request_id": "0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60",
"sent_at": "2026-10-16T12:00:00Z",
"command": {
"vault_address": "0x2222222222222222222222222222222222222222",
"account": "0x1111111111111111111111111111111111111111",
"to": "0x1111111111111111111111111111111111111111",
"amount": "4200000",
"expiry": "1792152300",
"salt": "84190357266103877",
"signature": "0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab"
}
}
'import requests
url = "https://hip4-api.totalis.trade/v1/me/run-off-claims"
payload = {
"schema_version": 1,
"request_id": "0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60",
"sent_at": "2026-10-16T12:00:00Z",
"command": {
"vault_address": "0x2222222222222222222222222222222222222222",
"account": "0x1111111111111111111111111111111111111111",
"to": "0x1111111111111111111111111111111111111111",
"amount": "4200000",
"expiry": "1792152300",
"salt": "84190357266103877",
"signature": "0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
schema_version: 1,
request_id: '0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60',
sent_at: '2026-10-16T12:00:00Z',
command: {
vault_address: '0x2222222222222222222222222222222222222222',
account: '0x1111111111111111111111111111111111111111',
to: '0x1111111111111111111111111111111111111111',
amount: '4200000',
expiry: '1792152300',
salt: '84190357266103877',
signature: '0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab'
}
})
};
fetch('https://hip4-api.totalis.trade/v1/me/run-off-claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hip4-api.totalis.trade/v1/me/run-off-claims",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'schema_version' => 1,
'request_id' => '0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60',
'sent_at' => '2026-10-16T12:00:00Z',
'command' => [
'vault_address' => '0x2222222222222222222222222222222222222222',
'account' => '0x1111111111111111111111111111111111111111',
'to' => '0x1111111111111111111111111111111111111111',
'amount' => '4200000',
'expiry' => '1792152300',
'salt' => '84190357266103877',
'signature' => '0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hip4-api.totalis.trade/v1/me/run-off-claims"
payload := strings.NewReader("{\n \"schema_version\": 1,\n \"request_id\": \"0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60\",\n \"sent_at\": \"2026-10-16T12:00:00Z\",\n \"command\": {\n \"vault_address\": \"0x2222222222222222222222222222222222222222\",\n \"account\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x1111111111111111111111111111111111111111\",\n \"amount\": \"4200000\",\n \"expiry\": \"1792152300\",\n \"salt\": \"84190357266103877\",\n \"signature\": \"0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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))
}HttpResponse<String> response = Unirest.post("https://hip4-api.totalis.trade/v1/me/run-off-claims")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schema_version\": 1,\n \"request_id\": \"0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60\",\n \"sent_at\": \"2026-10-16T12:00:00Z\",\n \"command\": {\n \"vault_address\": \"0x2222222222222222222222222222222222222222\",\n \"account\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x1111111111111111111111111111111111111111\",\n \"amount\": \"4200000\",\n \"expiry\": \"1792152300\",\n \"salt\": \"84190357266103877\",\n \"signature\": \"0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hip4-api.totalis.trade/v1/me/run-off-claims")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_version\": 1,\n \"request_id\": \"0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60\",\n \"sent_at\": \"2026-10-16T12:00:00Z\",\n \"command\": {\n \"vault_address\": \"0x2222222222222222222222222222222222222222\",\n \"account\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x1111111111111111111111111111111111111111\",\n \"amount\": \"4200000\",\n \"expiry\": \"1792152300\",\n \"salt\": \"84190357266103877\",\n \"signature\": \"0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab\"\n }\n}"
response = http.request(request)
puts response.read_body{
"vault_address": "0x2222222222222222222222222222222222222222",
"operation": {
"operation_id": "0x4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e",
"kind": "WITHDRAW_USER",
"amount": "4200000",
"status": "QUEUED",
"transaction_hash": null,
"created_at": "2026-10-16T12:00:00Z",
"updated_at": "2026-10-16T12:00:00Z"
}
}{
"error": {
"code": "INVALID_REQUEST",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "FORBIDDEN",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "RATE_LIMITED",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "BACKOFF"
}
}{
"error": {
"code": "AUTHORIZATION_UNAVAILABLE",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "BACKOFF"
}
}Account
Create run-off claim
Moves the account’s cash in a vault running off (run_off in Get balances) to the account’s own wallet, part of Cash, by relaying its owner-signed Exit for that vault; a Totalis embedded wallet’s run-off cash moves on its own and needs no claim.
Requires a key for your account with funding:withdraw, sponsorship:use.
A wallet session for the account also works, with no scope limit, sent from its Origin.
POST
/
v1
/
me
/
run-off-claims
Create run-off claim
curl --request POST \
--url https://hip4-api.totalis.trade/v1/me/run-off-claims \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"schema_version": 1,
"request_id": "0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60",
"sent_at": "2026-10-16T12:00:00Z",
"command": {
"vault_address": "0x2222222222222222222222222222222222222222",
"account": "0x1111111111111111111111111111111111111111",
"to": "0x1111111111111111111111111111111111111111",
"amount": "4200000",
"expiry": "1792152300",
"salt": "84190357266103877",
"signature": "0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab"
}
}
'import requests
url = "https://hip4-api.totalis.trade/v1/me/run-off-claims"
payload = {
"schema_version": 1,
"request_id": "0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60",
"sent_at": "2026-10-16T12:00:00Z",
"command": {
"vault_address": "0x2222222222222222222222222222222222222222",
"account": "0x1111111111111111111111111111111111111111",
"to": "0x1111111111111111111111111111111111111111",
"amount": "4200000",
"expiry": "1792152300",
"salt": "84190357266103877",
"signature": "0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
schema_version: 1,
request_id: '0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60',
sent_at: '2026-10-16T12:00:00Z',
command: {
vault_address: '0x2222222222222222222222222222222222222222',
account: '0x1111111111111111111111111111111111111111',
to: '0x1111111111111111111111111111111111111111',
amount: '4200000',
expiry: '1792152300',
salt: '84190357266103877',
signature: '0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab'
}
})
};
fetch('https://hip4-api.totalis.trade/v1/me/run-off-claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hip4-api.totalis.trade/v1/me/run-off-claims",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'schema_version' => 1,
'request_id' => '0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60',
'sent_at' => '2026-10-16T12:00:00Z',
'command' => [
'vault_address' => '0x2222222222222222222222222222222222222222',
'account' => '0x1111111111111111111111111111111111111111',
'to' => '0x1111111111111111111111111111111111111111',
'amount' => '4200000',
'expiry' => '1792152300',
'salt' => '84190357266103877',
'signature' => '0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hip4-api.totalis.trade/v1/me/run-off-claims"
payload := strings.NewReader("{\n \"schema_version\": 1,\n \"request_id\": \"0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60\",\n \"sent_at\": \"2026-10-16T12:00:00Z\",\n \"command\": {\n \"vault_address\": \"0x2222222222222222222222222222222222222222\",\n \"account\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x1111111111111111111111111111111111111111\",\n \"amount\": \"4200000\",\n \"expiry\": \"1792152300\",\n \"salt\": \"84190357266103877\",\n \"signature\": \"0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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))
}HttpResponse<String> response = Unirest.post("https://hip4-api.totalis.trade/v1/me/run-off-claims")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schema_version\": 1,\n \"request_id\": \"0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60\",\n \"sent_at\": \"2026-10-16T12:00:00Z\",\n \"command\": {\n \"vault_address\": \"0x2222222222222222222222222222222222222222\",\n \"account\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x1111111111111111111111111111111111111111\",\n \"amount\": \"4200000\",\n \"expiry\": \"1792152300\",\n \"salt\": \"84190357266103877\",\n \"signature\": \"0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hip4-api.totalis.trade/v1/me/run-off-claims")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_version\": 1,\n \"request_id\": \"0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a60\",\n \"sent_at\": \"2026-10-16T12:00:00Z\",\n \"command\": {\n \"vault_address\": \"0x2222222222222222222222222222222222222222\",\n \"account\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x1111111111111111111111111111111111111111\",\n \"amount\": \"4200000\",\n \"expiry\": \"1792152300\",\n \"salt\": \"84190357266103877\",\n \"signature\": \"0xababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababababab\"\n }\n}"
response = http.request(request)
puts response.read_body{
"vault_address": "0x2222222222222222222222222222222222222222",
"operation": {
"operation_id": "0x4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e4e",
"kind": "WITHDRAW_USER",
"amount": "4200000",
"status": "QUEUED",
"transaction_hash": null,
"created_at": "2026-10-16T12:00:00Z",
"updated_at": "2026-10-16T12:00:00Z"
}
}{
"error": {
"code": "INVALID_REQUEST",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "FORBIDDEN",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "NEVER"
}
}{
"error": {
"code": "RATE_LIMITED",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "BACKOFF"
}
}{
"error": {
"code": "AUTHORIZATION_UNAVAILABLE",
"field_violations": [
{
"code": "REQUIRED",
"field": "<string>"
}
],
"message": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry": "BACKOFF"
}
}Authorizations
apiKeywalletSession
Scoped API key (ttk_...), created in the Totalis app or by a wallet-session user through the API keys routes with a fresh wallet signature; those routes never accept a key. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires. Send no Origin.
Headers
Lowercase UUIDv7 naming this command, unique per caller and route. A retry with the same key and body returns the original result; the same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Body
application/json
Envelope format version; always 1.
Client-generated UUIDv7 for this request, echoed back in error responses.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$RFC 3339 UTC time the client sent the request, ending in Z.
Maximum string length:
30Pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$The owner-signed EIP-712 Exit of the account's cash in a vault running off, to the account's own wallet; Totalis relays it and pays the gas.
Show child attributes
Show child attributes
Response
Claim durably accepted, not yet on chain; it shows as the vault's claim in Get balances until it resolves. Follow its operation with Get operation. An exact replay of the same Idempotency-Key and body returns the stored claim.
Was this page helpful?