Skip to main content
POST
/
v1
/
loans
/
{applicationId}
/
offer
/
decline
Decline Offer
curl --request POST \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/offer/decline \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>' \
  --data '
{
  "decline_reason": "HIGH_INTEREST"
}
'
{
  "status": "success",
  "message": "Offer declined"
}

​
Overview

Declines the loan offer. The application status transitions to OFFER_DECLINED. A reason must be provided from the allowed enum.

​
Request

Method: POST
URL: /v1/loans/:applicationId/offer/decline

​
Parameters

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

​
Request Body

{
  "decline_reason": "HIGH_INTEREST"
}
FieldTypeRequiredAllowed values
decline_reasonstringYesHIGH_INTEREST · OFFER_SMALL · REPAYMENT_PERIOD · CHECKING · OTHERS

​
Response

​
200 OK

{
  "status": "success",
  "message": "Offer declined"
}

​
Error Responses

StatusMessageCause
400decline_reason is requiredField missing
400decline_reason must be one of: ...Invalid enum value
400Application not foundInvalid applicationId

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
applicationId
string
required

Body

application/json

Provide the required values for the request body.

​
decline_reason
string
required
Example:

"HIGH_INTEREST"

Response

200 - application/json

Successful response

The response is of type object.