Skip to main content
GET
/
v1
/
loans
List Loans
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "data": [
    {
      "application_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customer_id": "1732ca47-42b2-4990-a65d-c369e934eed3",
      "amount": 2000000,
      "repayment_period": 3,
      "status": "HAS_OFFER",
      "created_at": "2024-05-15T10:00:00Z"
    }
  ],
  "total": 1
}

​
Overview

Returns a paginated list of all loan applications created under the merchant’s API key. Supports filtering by status and customer.

​
Request

Method: GET
URL: /v1/loans

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
statusQuerystringNoFilter by application status.
customer_idQuerystringNoFilter by customer UUID.
pageQuerynumberNoPage number. Default: 1.
limitQuerynumberNoResults per page. Default: 20.

​
Response

​
200 OK

{
  "status": "success",
  "message": "Loan applications fetched",
  "data": [
    {
      "application_id": "aaaabbbb-cccc-dddd-eeee-ffffffffffff",
      "customer_id": "1732ca47-42b2-4990-a65d-c369e934eed3",
      "amount": 2000000,
      "repayment_period": 3,
      "loan_purpose": "INVENTORY_MGT",
      "status": "HAS_OFFER",
      "offer_status": "PENDING",
      "loan_status": null,
      "loan_id": null,
      "reference": "MERCH_REF_20250115_001",
      "created_at": "2025-01-15T10:10:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "total": 45,
    "page": 1,
    "limit": 20,
    "pages": 3
  }
}
status valueMeaning
PENDINGAwaiting decisioning
KYC_PROCESSINGIdentity verification in progress
HAS_OFFEROffer is ready
OFFER_ACCEPTEDCustomer accepted the offer
OFFER_DECLINEDCustomer declined the offer
OFFER_EXPIREDOffer expired before acceptance
DECLINEDApplication rejected by underwriting
DISBURSEMENT_APPROVEDApproved, pending disbursement
DISBURSEDFunds disbursed to customer

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Query Parameters

​
status
string
​
customer_id
string
​
page
integer
​
limit
integer

Response

200 - application/json

Successful response

The response is of type object.