DataResponse_WalletBalanceResponse
Generic API response wrapper with optional pagination This wrapper provides a consistent structure for all API responses, making it easier for clients to handle responses uniformly. It supports both single resources and collections, with optional pagination metadata. # Response Structure ```json { "data": T, "pagination": { ... } // optional } ``` # Examples ## Single Resource ```rust use seren_core::http::DataResponse; use serde::Serialize; #[derive(Serialize)] struct Project { id: String, name: String, } let project = Project { id: "123".to_string(), name: "My Project".to_string(), }; let response = DataResponse::new(project); // Serializes to: {"data": {"id": "123", "name": "My Project"}} ``` ## Collection with Pagination ```rust use seren_core::http::DataResponse; use seren_core::pagination::PaginationMeta; use serde::Serialize; #[derive(Serialize)] struct Project { id: String, name: String, } let projects: Vec<Project> = Vec::new(); let pagination = PaginationMeta { total: 0, count: 0, limit: 20, offset: 0, has_more: false, }; let response = DataResponse::with_pagination(projects, pagination); // Serializes to: {"data": [...], "pagination": {"total": 0, "count": 0, "limit": 20, "offset": 0, "has_more": false}} ```
Properties
| Property | Type | Required | Description |
|---|---|---|---|
data |
object | Yes | Wallet balance response (funded + promotional) |
pagination |
any | No |
View JSON Schema
{
"type": "object",
"description": "Generic API response wrapper with optional pagination\n\nThis wrapper provides a consistent structure for all API responses,\nmaking it easier for clients to handle responses uniformly. It supports\nboth single resources and collections, with optional pagination metadata.\n\n# Response Structure\n\n```json\n{\n \"data\": T,\n \"pagination\": { ... } // optional\n}\n```\n\n# Examples\n\n## Single Resource\n\n```rust\nuse seren_core::http::DataResponse;\nuse serde::Serialize;\n\n#[derive(Serialize)]\nstruct Project {\n id: String,\n name: String,\n}\n\nlet project = Project {\n id: \"123\".to_string(),\n name: \"My Project\".to_string(),\n};\n\nlet response = DataResponse::new(project);\n// Serializes to: {\"data\": {\"id\": \"123\", \"name\": \"My Project\"}}\n```\n\n## Collection with Pagination\n\n```rust\nuse seren_core::http::DataResponse;\nuse seren_core::pagination::PaginationMeta;\nuse serde::Serialize;\n\n#[derive(Serialize)]\nstruct Project {\n id: String,\n name: String,\n}\n\nlet projects: Vec<Project> = Vec::new();\nlet pagination = PaginationMeta {\n total: 0,\n count: 0,\n limit: 20,\n offset: 0,\n has_more: false,\n};\n\nlet response = DataResponse::with_pagination(projects, pagination);\n// Serializes to: {\"data\": [...], \"pagination\": {\"total\": 0, \"count\": 0, \"limit\": 20, \"offset\": 0, \"has_more\": false}}\n```",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Wallet balance response (funded + promotional)",
"required": [
"wallet_address",
"balance_atomic",
"balance_usd",
"funded_balance_atomic",
"funded_balance_usd",
"promotional_balance_atomic",
"promotional_balance_usd",
"by_source",
"total_purchases_cents",
"total_purchases_usd",
"has_recovery"
],
"properties": {
"balance_atomic": {
"type": "integer",
"format": "int64",
"description": "Total wallet balance in atomic units"
},
"balance_usd": {
"type": "string"
},
"by_source": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WalletSourceBalance"
},
"description": "Breakdown by source"
},
"funded_balance_atomic": {
"type": "integer",
"format": "int64",
"description": "Total funded balance (fiat purchases + tier bonuses)"
},
"funded_balance_usd": {
"type": "string"
},
"has_recovery": {
"type": "boolean",
"description": "Whether recovery is set up for this account"
},
"promotional_balance_atomic": {
"type": "integer",
"format": "int64",
"description": "Total promotional balance (bonuses, daily claims, referrals, admin grants)"
},
"promotional_balance_usd": {
"type": "string"
},
"recovery_warning": {
"type": [
"string",
"null"
],
"description": "Warning if funds exist but no recovery is set up"
},
"total_purchases_cents": {
"type": "integer",
"format": "int64",
"description": "Total lifetime SerenBucks purchases in cents (for plan upgrade tracking)"
},
"total_purchases_usd": {
"type": "string"
},
"wallet_address": {
"type": "string"
}
}
},
"pagination": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/PaginationMeta",
"description": "Optional pagination metadata"
}
]
}
}
}