Fetch active drawdown

GET /v1/draw-downs/customer-partner/{{customer_partner_id}}/active

Returns an object containing the active drawdown information.

Response

This is the expected response if the request is completed successfully.

JSON

{
    "status": "success",
    "message": "Active drawdown fetched successfully",
    "data": {
        "id": "9VNctnqvtgGyb3vS",
        "customer_partner_id": "9B3JCLPfimy4Kijv",
        "country_id": "BmR31Of0hnPCkva2",
        "amount_drawn": 10000,
        "expected_payoff_date": "2023-05-13T00:00:00.000Z",
        "status": "pending",
        "created_at": "2023-04-13T17:52:36.000Z",
        "updated_at": "2023-04-13T17:52:36.000Z",
        "deleted_at": null,
        "user_id": "sSmqvc8BfY5W5dtH",
        "settlement_date": "2023-04-13T00:00:00.000Z",
        "tenor": 30,
        "maturity_date": "2023-05-13T00:00:00.000Z",
        "actual_payment_date": null,
        "interest_type": "compound",
        "annualised_tenor": 0.08,
        "annualised_coupon_rate": null,
        "tenor_coupon_rate": 0.83,
        "expected_coupon_payment": "83.67",
        "implied_yield": "0.83",
        "loan_par_value": "10000.00",
        "loan_present_value": "10000.00",
        "yield_to_maturity": 0.83,
        "channel": null,
        "narration": null,
        "no_of_interest_payments": 1,
        "financing_cycle": 1,
        "credit_limit_id": "kOph874knXQPYshi",
        "amount_expected": "10083.67",
        "amount_recollected": "0.00",
        "amount_outstanding": "10083.67",
        "collateral_deducted": null,
        "disbursement_date": "2023-04-13T00:00:00.000Z",
        "amount_drawn_in_dollars_initial": 20,
        "amount_drawn_in_dollars_current": 20,
        "expected_coupon_payment_in_dollars_initial": 0.17,
        "expected_coupon_payment_in_dollars_current": 0.17,
        "loan_par_value_in_dollars_initial": 20,
        "loan_par_value_in_dollars_current": 20,
        "loan_present_value_in_dollars_initial": 20,
        "loan_present_value_in_dollars_current": 20,
        "buffer_period": 7,
        "disbursement_status": "recurring",
        "score": "100.00"
    }
}

---

The response object

---

status _^string
This is the status of the request. It can be either success or error

---

message _^string
This is a message describing the outcome of the request sent to the server.

---

data _^object

---

        customer_partner_id _^string

         This is the ID of the customer partner.

        country_id _^string

         This is the ID of the country the business is operating.

        amount_drawn _^float

         This is the drawdown amount in the currency of the country the business is operating.

        expected_payoff_date _^string

         This is the expected payoff date for the drawdown.

        status _^string

         This is the status of the drawdown.

---