📓Debt

Our API provides flexible and powerful debt classification to support your financial assessments.

The Debt Report focuses exclusively on Obligation Expenses — recurring financial commitments and liabilities that impact an individual's affordability and risk profile.

Debt

POST {{baseUrl}}/bank-accounts/:bank_account_id/transaction-reports/debt

Generate a summary report of debt repayments for a defined period of time.

API Request

Path Parameters

Name	Type	Description
bank_account_id*	String	The UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response.

Request Body

Name	Type	Description
start_date*	String	This field indicates the start date from which you would like to generate the summary report. In the following format: "yyyy-mm-dd"
end_date*	String	This field indicates the end date up until which you would like to generate the summary report. In the following format: "yyyy-mm-dd"

API Responses

200 - OK

{
    "data": [
        {
            "id": "e445332f-fccf-41e0-b40d-0bbcef4de5ac",
            "report": {
                "months": {
                    "year": 2024,
                    "month": "October",
                    "full_month": true,
                    "debit_order_day": [
                        1,
                        26,
                        28
                    ],
                    "debt_repayments": "18152.46",
                    "amount_deducted_by_day": [
                        3018,
                        4400,
                        4725,
                        4157.47,
                        1851.99
                    ],
                    "number_of_debt_repayments": 5
                }
            },
            "startDate": "2024-10-01",
            "endDate": "2024-10-31",
            "type": "debt"
        },
        {
            "id": "c087d4c1-cd4f-441b-9a3d-24261bb92fc8",
            "report": {
                "months": {
                    "year": 2024,
                    "month": "November",
                    "full_month": true,
                    "debit_order_day": [
                        1,
                        26,
                        27
                    ],
                    "debt_repayments": "13752.46",
                    "amount_deducted_by_day": [
                        3018,
                        4725,
                        4157.47,
                        1851.99
                    ],
                    "number_of_debt_repayments": 4
                }
            },
            "startDate": "2024-11-01",
            "endDate": "2024-11-30",
            "type": "debt"
        }
    ]
}

400 - Bad Request

Inactive Online Session

{
    "data": "Online Banking Login Session has not been activated."
}

Incomplete Online Session

{
    "data": "Online Banking Login Session Incomplete."
}

Failed Online Session

{
    "data": "Online Banking Login Session Failed."
}

Expired Online Session

{
    "data": "Online Banking Login Session Link has expired."
}

Debt Obligation Categorisation

Only transactions classified under obligation-related categories are considered. These represent fixed expenses tied to financial products, contracts, or policies.

Categorisation Engine	Included Categories
Gathr (Default)	debt, loans
X-Finch (Advanced)	funeral_insurance, general_insurance, health_insurance, home_loan_finance, life_insurance, loan_repayments, mobile_contract, recurring_debit_order, vehicle_insurance, vehicle_loan_finance