v1
latestOpenAPI 3.0.02026-07-26224386470.0 KBEndUserCalculations
Get EndUser debt candidates
Identify potential debt candidates.
get/api/end_users/{end_user_id_or_heron_id}/debt_candidates
Path parameters
end_user_id_or_heron_idstring required
Response
OK
Example response
{
"by_merchant_summary": [
{
"inflow_metrics": {
"amount": {
"currency": "USD"
},
"estimated_monthly_amount": {
"currency": "USD"
},
"max_amount": {
"currency": "USD"
},
"mean_amount": {
"currency": "USD"
},
"median_amount": {
"currency": "USD"
},
"min_amount": {
"currency": "USD"
},
"mode_amount": {
"currency": "USD"
},
"std_dev_amount": {
"currency": "USD"
}
},
"net_metrics": {
"amount": {
"currency": "USD"
},
"estimated_monthly_amount": {
"currency": "USD"
},
"max_amount": {
"currency": "USD"
},
"mean_amount": {
"currency": "USD"
},
"median_amount": {
"currency": "USD"
},
"min_amount": {
"currency": "USD"
},
"mode_amount": {
"currency": "USD"
},
"std_dev_amount": {
"currency": "USD"
}
},
"outflow_metrics": {
"amount": {
"currency": "USD"
},
"estimated_monthly_amount": {
"currency": "USD"
},
"max_amount": {
"currency": "USD"
},
"mean_amount": {
"currency": "USD"
},
"median_amount": {
"currency": "USD"
},
"min_amount": {
"currency": "USD"
},
"mode_amount": {
"currency": "USD"
},
"std_dev_amount": {
"currency": "USD"
}
},
"transactions": [
{
"amount": {
"currency": "USD"
}
}
]
}
]
}