Skip to main content
POST
/
v1
/
loans
/
{applicationId}
/
disbursement-account
Set Disbursement Account
curl --request POST \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/disbursement-account \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>' \
  --data '
{
  "account_number": "0123456789",
  "bank_code": "058"
}
'
{
  "status": "success",
  "message": "Disbursement account set"
}

​
Overview

Provides the bank account details for loan disbursement. Call this after the customer receives an offer (status = HAS_OFFER).

​
Request

Method: POST
URL: /v1/loans/:applicationId/disbursement-account

​
Parameters

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

​
Request Body

{
  "account_number": "0123456789",
  "bank_code": "058"
}
FieldTypeRequiredDescription
account_numberstringYesExactly 10 digits
bank_codestringYesBank sort code — at least 3 digits

​
Response

​
200 OK

{
  "status": "success",
  "message": "Disbursement account set"
}

​
Error Responses

StatusMessageCause
400account_number must be exactly 10 digitsWrong length or non-numeric
400bank_code must be at least 3 digitsInvalid bank code
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

Body

application/json

Provide the required values for the request body.

​
account_number
string
required
Example:

"0123456789"

​
bank_code
string
required
Example:

"058"

Response

200 - application/json

Successful response

The response is of type object.