Retrieve a statement

Retrieve a statement

GET https://sandbox-api.stilt.com/v1/users/{user_id}/loc/{loc_id}/statements

Returns a statement object including the LOC's balance, due dates and statement documents. This endpoint should not return an error as long as the LOC exists.

Path Parameters

Name	Type	Description
user_id*	string	The uuid of the user
loc_id*	string	The uuid of the LOC

200: OK Successfully retrieved a LOC statement

{
    "next_billing_date": "2022-09-07",
    "principal_balance": 0.0,
    "interest_balance": 0.0,
    "payoff_balance": 0.0,
    "days_past_due": 0,
    "past_due_balance": 0.0,
    "payment_amount_due": 0,
    "payment_due_date": null,
    "suspense_balance": 0.0,
    "statements": [
        {
            "billing_date": "2022-06-07",
            "url": "https://storage.googleapis.com/stilt-sandbox-loan-statements/loan_statement_33b41175-ea54-4a5b-8616-abc482fcce9f_2022-06-07.pdf"
        },
        {
            "billing_date": "2022-08-07",
            "url": "https://storage.googleapis.com/stilt-sandbox-loan-statements/loan_statement_33b41175-ea54-4a5b-8616-abc482fcce9f_2022-08-07.pdf"
        }
    ],
    "credit_limit": 2500.0,
    "available_credit": 2500.0,
    "current_credit": 2500.0
}

401: Unauthorized

{
    // Response
}

403: Forbidden

{
    // Response
}

400 Attempted to retrieve statement for LOC that does not exist, or has not been activated

{
    "message": "BUILD_CREDIT not found"
}

Be sure to omit `Content-Type': 'application/json' from the header of this request to avoid a 500 error