Skip to main content
GET
/
v1
/
loans
/
{applicationId}
/
offer
Get Offer
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/offer \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "data": {
    "offered_amount": 2000000,
    "tenure": 3,
    "interest_rate": 8,
    "monthly_repayment": 719999,
    "total_repayment": 2159997,
    "expires_at": "2024-06-15T10:00:00Z",
    "schedule": [
      {
        "dueDate": "2024-06-15",
        "principalDue": 666666,
        "interestDue": 53333,
        "totalDue": 719999
      }
    ]
  }
}

​
Overview

Returns the loan offer including amount, interest rate, tenure, and repayment schedule. Only available after the application status reaches HAS_OFFER.

​
Request

Method: GET
URL: /v1/loans/:applicationId/offer

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
applicationIdPathstringYesApplication ID.

​
Response

​
200 OK

{
  "status": "success",
  "message": "Offer fetched",
  "data": {
    "id": 42,
    "offerAmount": 200000000,
    "tenure": 3,
    "interestRate": 8.0,
    "repaymentSchedule": [
      {
        "dueDate": "2025-02-15",
        "principalDue": 6666666,
        "interestDue": 533333,
        "totalDue": 7199999
      },
      {
        "dueDate": "2025-03-15",
        "principalDue": 6666666,
        "interestDue": 480000,
        "totalDue": 7146666
      }
    ],
    "offerStatus": "PENDING",
    "expiresAt": "2025-01-22T10:00:00.000Z"
  }
}
FieldDescription
offerAmountApproved loan amount in kobo
tenureRepayment period in months
interestRateAnnual interest rate as a percentage
repaymentScheduleMonthly breakdown of principal, interest, and total
offerStatusPENDING until customer accepts or declines
expiresAtUTC timestamp when the offer expires

​
Error Responses

StatusMessageCause
400Application not foundInvalid applicationId
422Application has no loan IDApplication not yet registered

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
applicationId
string
required

Response

200 - application/json

Successful response

The response is of type object.