settlements
Get detailed settlement analysis
Get detailed settlement analysis including metrics and validation
get/groups/{groupId}/settlement/analysis
Request
- Base URL: http://localhost:3001
- URL: http://localhost:3001/groups/{groupId}/settlement/analysis
- Auth: HTTP bearer
Path parameters
groupIdstring required
Group UUID
Response
Settlement analysis retrieved successfully
Example response
{
"data": {
"settlement": {
"groupId": "550e8400-e29b-41d4-a716-446655440000",
"transactionsByCurrency": {
"USD": [
{
"from": "user-a",
"to": "user-b",
"amount": 20,
"currency": "USD"
},
{
"from": "user-c",
"to": "user-a",
"amount": 10,
"currency": "USD"
}
]
},
"totalTransactions": 3,
"currenciesUsed": [
"USD",
"EUR"
],
"defaultCurrency": "USD"
},
"metrics": {
"totalDebt": 125.5,
"transactionCount": 3,
"averageTransactionAmount": 41.83,
"maxTransactionAmount": 75.25,
"minTransactionAmount": 15,
"efficiencyRating": 0.85
},
"isValid": true,
"originalBalances": [
{
"userId": "550e8400-e29b-41d4-a716-446655440000",
"balance": -25.5,
"userName": "John Doe"
}
]
},
"success": true,
"message": "Success"
}Changes
No recorded changes to this operation across all 1 revision of this API.