Failed payment detail
The /reports/cashflow-failed-payments-detail endpoint returns individual failed payment records for a given period, with optional filtering by recovery status.
GET /reports/cashflow-failed-payments-detail
Query parameters
| Parameter | Type | Description |
|---|
selected-date | string | Period start date to show failed payments for. Required. |
selected-type | string | Filter by status: still_unpaid, recovered, or churned. |
baseCurrency | string | Target currency for conversion. |
interval | string | Aggregation interval. Defaults to month. |
region | string | Filter by region or country codes (space-separated). |
currency | string | Filter by currency codes (space-separated). |
plan | string | Filter by plan group IDs (space-separated). |
data_source | string | Filter by data source ID (space-separated). |
Example response
200 OK
{
"result": {
"list": [
{
"date": "2025-01-05",
"invoice_ref": "in_failed_001",
"customer_id": "cus_123",
"customer_name": "Acme Corp",
"customer_email": "[email protected]",
"amount": 9900,
"amount_base_currency": 9900,
"currency": "usd",
"payment_method": "card",
"description": "Pro Plan - Jan 2025",
"attempt_count": 3,
"recovery_status": "recovered"
}
]
}
}
Response fields
| Field | Type | Description |
|---|
date | string | Date of the failed payment |
invoice_ref | string | Invoice reference ID |
customer_id | string | Customer external ID |
customer_name | string | Customer name |
customer_email | string | Customer email |
amount | number | Failed amount in original currency (cents) |
amount_base_currency | number | Failed amount in base currency (cents) |
currency | string | Original payment currency |
payment_method | string | Payment method used |
description | string | Payment description |
attempt_count | integer | Number of payment attempts |
recovery_status | string | Status: recovered, still_unpaid, or churned |
