TransactionSummaryResponse
Summary statistics for transactions in a date range
Properties
| Property | Type | Required | Description |
|---|---|---|---|
ending_balance_atomic |
integer | Yes | Wallet balance at the end of the selected period |
ending_balance_usd |
string | Yes | |
net_change_atomic |
integer | Yes | Net change (credits - debits, can be negative) |
net_change_usd |
string | Yes | |
period_end |
string,null | No | |
period_start |
string,null | No | |
starting_balance_atomic |
integer | Yes | Wallet balance immediately before the period start |
starting_balance_usd |
string | Yes | |
total_credits_atomic |
integer | Yes | Total credits received in the period (positive) |
total_credits_usd |
string | Yes | |
total_debits_atomic |
integer | Yes | Total debits spent in the period (positive number representing absolute spend) |
total_debits_usd |
string | Yes | |
transaction_count |
integer | Yes | Total number of transactions in the period |
View JSON Schema
{
"type": "object",
"description": "Summary statistics for transactions in a date range",
"required": [
"starting_balance_atomic",
"starting_balance_usd",
"total_credits_atomic",
"total_credits_usd",
"total_debits_atomic",
"total_debits_usd",
"net_change_atomic",
"net_change_usd",
"ending_balance_atomic",
"ending_balance_usd",
"transaction_count"
],
"properties": {
"ending_balance_atomic": {
"type": "integer",
"format": "int64",
"description": "Wallet balance at the end of the selected period"
},
"ending_balance_usd": {
"type": "string"
},
"net_change_atomic": {
"type": "integer",
"format": "int64",
"description": "Net change (credits - debits, can be negative)"
},
"net_change_usd": {
"type": "string"
},
"period_end": {
"type": [
"string",
"null"
]
},
"period_start": {
"type": [
"string",
"null"
]
},
"starting_balance_atomic": {
"type": "integer",
"format": "int64",
"description": "Wallet balance immediately before the period start"
},
"starting_balance_usd": {
"type": "string"
},
"total_credits_atomic": {
"type": "integer",
"format": "int64",
"description": "Total credits received in the period (positive)"
},
"total_credits_usd": {
"type": "string"
},
"total_debits_atomic": {
"type": "integer",
"format": "int64",
"description": "Total debits spent in the period (positive number representing absolute spend)"
},
"total_debits_usd": {
"type": "string"
},
"transaction_count": {
"type": "integer",
"format": "int64",
"description": "Total number of transactions in the period"
}
}
}