Documentation Index
Fetch the complete documentation index at: https://docs.sertexity.com/llms.txt
Use this file to discover all available pages before exploring further.
Data Models
Schemas for all objects returned by the API.
User
{
"id": "usr_01hx3k9j2e4m7n8p",
"email": "alice@example.com",
"name": "Alice",
"timezone": "UTC",
"language": "en",
"created_at": "2024-09-15T10:30:00Z",
"updated_at": "2024-11-02T08:15:44Z"
}
| Field | Type | Description |
|---|
id | string | usr_ prefix |
email | string | |
name | string | |
timezone | string | IANA timezone |
language | string | ISO 639-1 |
created_at | string | ISO 8601 |
updated_at | string | ISO 8601 |
Asset
{
"ticker": "BTC",
"name": "Bitcoin",
"symbol": "₿",
"decimals": 8,
"network": "Bitcoin",
"active": true
}
| Field | Type | Description |
|---|
ticker | string | Asset ticker |
name | string | Full name |
symbol | string | Display glyph |
decimals | integer | Decimal precision |
network | string | Underlying blockchain |
active | boolean | Availability |
Wallet
{
"id": "wal_01hy2c4n8j5r3d6e",
"name": "Main BTC",
"asset": "BTC",
"balance": 500000000,
"active": true,
"created_at": "2024-09-15T10:30:00Z",
"updated_at": "2024-11-01T09:00:00Z"
}
| Field | Type | Description |
|---|
id | string | wal_ prefix |
name | string | Display name |
asset | string | Asset ticker |
balance | integer | Smallest unit (satoshis, wei, lamports…) |
active | boolean | false = archived |
created_at | string | ISO 8601 |
updated_at | string | ISO 8601 |
Operation
{
"id": "op_01hz8f3k9m2p6q7r",
"wallet_id": "wal_01hy2c4n8j5r3d6e",
"type": "expense",
"status": "completed",
"amount": 150000,
"asset": "BTC",
"description": "Hardware wallet purchase",
"category": "equipment",
"reference": "ORD-8821",
"metadata": {},
"created_at": "2024-09-15T10:30:00Z",
"completed_at": "2024-09-15T10:30:02Z"
}
| Field | Type | Description |
|---|
id | string | op_ prefix |
wallet_id | string | Owning wallet |
type | string | income / expense / transfer |
status | string | pending / completed / failed |
amount | integer | Smallest unit |
asset | string | Asset ticker |
description | string|null | |
category | string|null | |
reference | string|null | External ID |
metadata | object | Arbitrary key/value |
created_at | string | ISO 8601 |
completed_at | string|null | Set when status → completed |
Webhook
{
"id": "wh_01jz1b2k4n7p9q0r",
"url": "https://yourapp.com/hooks/sertexity",
"events": ["operation.completed"],
"active": true,
"created_at": "2024-09-15T10:30:00Z"
}
| Field | Type | Description |
|---|
id | string | wh_ prefix |
url | string | Delivery endpoint |
events | array | Subscribed event types |
active | boolean | |
created_at | string | ISO 8601 |
