Fetch current credit limit

GET /v1/customer-partner/{{customer_partner_id}}/credit-limit/current

Returns an object containing the current credit limit information.

Response

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

JSON

{
    "status": "success",
    "message": "Current credit limit fetched successfully",
    "data": {
        "id": "kOph874knXQPYshi",
        "limit": 200000,
        "currency": "NGN",
        "is_deleted": false,
        "created_at": "2023-04-13T17:37:47.000Z",
        "updated_at": "2023-04-25T18:43:40.000Z",
        "customer_partner": "9B3JCLPfimy4Kijv",
        "score": 100,
        "drawn": 10000,
        "status": "active",
        "threshold": 50,
        "trigger_points": null,
        "coupon_rate": 10,
        "tenure_in_months": 3,
        "financing_cycle": 1,
        "expired": false,
        "country_id": "BmR31Of0hnPCkva2",
        "amount_available": 190000,
        "interest_period": null,
        "drawdown_threshold": 80,
        "amount_funded": 5000,
        "maturity_date": "2023-07-12T00:00:00.000Z",
        "collateral_interest": 10,
        "collateral_percentage": 15,
        "payment_status": "pending",
        "payment_date": null,
        "limit_in_dollars_initial": 400,
        "limit_in_dollars_current": 400,
        "late_interest_charge_percentage": 10,
        "interest_type": "compound",
        "drawn_in_dollars_initial": 20,
        "drawn_in_dollars_current": 20,
        "issue_date": "2023-04-13T00:00:00.000Z",
        "debt_type": null,
        "lien_term": "first",
        "leverage_ratio": null,
        "senior_leverage_ratio": null,
        "interest_coverage_ratio": null,
        "debt_service_coverage_ratio": null,
        "fixed_charge_coverage_ratio": null,
        "financial_reports": null,
        "check_covenant": false,
        "default_check": true
    }
}

---

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

---

        limit _^string

         This is the credit limit assigned to the customer partner.

        currency _^string

         This is the currency code for the credit limit based on the country the business is operating.

        drawn _^float

         This is the amount drawn from the credit limit in the currency of the country the business is operating.

        status _^string

         This is the status of the credit limit.

---