Skip to main content
GET
/
v1
/
loans
/
active
Get Active Loan
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/active \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "Active loan fetched",
  "data": {
    "loanId": "LOAN_ABC123",
    "outstandingBalance": 150000000,
    "loanStatus": "ACTIVE",
    "nextRepaymentDate": "2025-02-15",
    "nextRepaymentAmount": 7199999
  }
}

​
Overview

Returns the active disbursed loan for a customer. Use this to check outstanding balance, next repayment date, and current loan status.

​
Request

Method: GET
URL: /v1/loans/active

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
customer_idQuerystringYesUUID of the customer.

​
Response

​
200 OK

{
  "status": "success",
  "message": "Active loan fetched",
  "data": {
    "loanId": "LOAN_ABC123",
    "outstandingBalance": 150000000,
    "loanStatus": "ACTIVE",
    "nextRepaymentDate": "2025-02-15",
    "nextRepaymentAmount": 7199999
  }
}
loanStatusMeaning
ACTIVELoan is active and in good standing
ACTIVE_IN_ARREARSLoan is active but overdue
CLOSEDLoan is fully repaid

​
Error Responses

StatusMessageCause
400customer_id query param is requiredMissing customer_id query parameter
400Customer not enrolled for lendingCustomer not found or not enrolled

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Query Parameters

​
customer_id
string
required

Response

200 - application/json

Successful response

The response is of type object.