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>'const options = {
method: 'GET',
headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans"
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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
}Loans
List Loan Applications
List all loan applications for the authenticated merchant.
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>'const options = {
method: 'GET',
headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans"
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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:GETURL:
/v1/loans
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
x-carbon-key | Header | string | Yes | API key for authentication. |
status | Query | string | No | Filter by application status. |
customer_id | Query | string | No | Filter by customer UUID. |
page | Query | number | No | Page number. Default: 1. |
limit | Query | number | No | Results 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 value | Meaning |
|---|---|
PENDING | Awaiting decisioning |
KYC_PROCESSING | Identity verification in progress |
HAS_OFFER | Offer is ready |
OFFER_ACCEPTED | Customer accepted the offer |
OFFER_DECLINED | Customer declined the offer |
OFFER_EXPIRED | Offer expired before acceptance |
DECLINED | Application rejected by underwriting |
DISBURSEMENT_APPROVED | Approved, pending disbursement |
DISBURSED | Funds disbursed to customer |
⌘I