POST
/
external
/
loan-offer
curl --request POST \
  --url https://direct-pub-api.directgh.com/api/v1/external/loan-offer \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "50000",
  "narration": "Business expansion loan",
  "tenure": "6",
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}
'
{
  "amount": 50000,
  "tenure": 6,
  "interest": 15000,
  "processingFee": 2500,
  "monthlyInstallment": 10833.33,
  "totalRepayment": 65000
}

Authorizations

​
Authorization
string
header
required

HMAC signature authentication. The Authorization header must contain your public key and HMAC signature in the format: public_key:signature

Format: Authorization: public_key:signature

Example: Authorization: pub_abc123xyz:abc123def456ghi789...

The signature is generated by creating an HMAC hash of the request body (JSON stringified) using your secret key for POST/PUT requests. For GET requests, the signature is generated using the query parameters (JSON stringified) instead of the request body. Contact your account manager to obtain your public key and secret key for generating signatures.

Body

application/json
​
amount
string
required

Loan amount requested (must be a positive number)

Example:

"50000"

​
narration
string
required

Description or purpose of the loan

Example:

"Business expansion loan"

​
tenure
string
required

Loan tenure in months (must be a positive integer)

Example:

"6"

​
userId
string<uuid>
required

Unique identifier of the institution member requesting the loan

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Loan offer calculated successfully

Loan offer details including interest, fees, and repayment terms

​
amount
number<double>

Loan amount offered

Example:

50000

​
tenure
integer

Loan tenure in months

Example:

6

​
interest
number<double>

Total interest amount for the loan

Example:

15000

​
processingFee
number<double>

Processing fee charged for the loan

Example:

2500

​
monthlyInstallment
number<double>

Monthly repayment amount

Example:

10833.33

​
totalRepayment
number<double>

Total amount to be repaid (principal + interest + fees)

Example:

65000