POST
/
external
/
loans
/
{id}
/
action
Perform Loan Action
curl --request POST \
  --url https://direct-pub-api.directgh.com/api/v1/external/loans/{id}/action \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "ACCEPT",
  "comment": "<string>"
}
'
{
  "id": "660e8400-e29b-41d4-a716-446655440000",
  "reference": "LOAN-2024-001234",
  "amount": 50000,
  "interest": 15000,
  "totalRepayment": 65000,
  "totalAmountPaid": 0,
  "tenure": 6,
  "processingFee": 2500,
  "receivableAmount": 50000,
  "narration": "Business expansion loan",
  "documents": [
    "https://example.com/docs/business-plan.pdf",
    "https://example.com/docs/financial-statement.pdf"
  ],
  "userMonthlyIncome": 150000,
  "userGhanaCard": "GHA-123456789-1",
  "status": "PENDING_APPROVAL",
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "firstName": "John",
    "lastName": "Doe",
    "otherName": "Michael",
    "email": "john.doe@example.com",
    "gender": "male",
    "dateOfBirth": "2026-04-01T10:09:09.886Z",
    "kyc": {
      "occupation": "Engineer",
      "address": "123 High Street, Accra",
      "validFrom": "2024-01-01",
      "validTo": "2025-01-01",
      "refNumber": "KYC-2024-0001"
    },
    "mobileNumber": "+233241234567",
    "ghanaCardNumber": "GHA-123456789-1",
    "ghanaCardImage": "https://example.com/images/ghana-card.jpg",
    "userImage": "https://example.com/images/user-profile.jpg",
    "isGhanaCardVerified": true,
    "documents": [
      "document1.pdf"
    ],
    "account": {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "account_type": "MOMO",
      "account_number": "0241234567",
      "network": "MTN",
      "bank_name": "Ghana Commercial Bank",
      "account_name": "John Doe",
      "created_at": "2026-04-01T10:09:09.886Z"
    },
    "createdAt": "2026-04-01T10:09:09.886Z"
  },
  "product": {
    "id": "prod-123",
    "name": "Standard Loan Product"
  },
  "repaymentDate": "2024-07-20T00:00:00Z",
  "createdAt": "2024-01-20T14:45:00Z"
}

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.

Path Parameters

​
id
string<uuid>
required

Unique identifier of the loan

Body

application/json
​
action
enum<string>
required

Action to perform on the loan (ACCEPT, CANCEL, or REJECT_COUNTER)

Available options:
ACCEPT,
CANCEL,
REJECT_COUNTER
​
comment
string

Optional comment for the action

Response

Action performed successfully

Loan details including status, user information, and repayment terms

​
id
string<uuid>

Unique identifier of the loan

Example:

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

​
reference
string

Human-readable loan reference number

Example:

"LOAN-2024-001234"

​
amount
number<double>

Loan amount

Example:

50000

​
interest
number<double>

Total interest amount for the loan

Example:

15000

​
totalRepayment
number<double>

Total amount to be repaid

Example:

65000

​
totalAmountPaid
number<double>

Total amount paid towards the loan

Example:

0

​
tenure
integer

Loan tenure in months

Example:

6

​
processingFee
number<double>

Processing fee charged for the loan

Example:

2500

​
receivableAmount
number<double>

Total amount receivable by the lender (principal amount)

Example:

50000

​
narration
string | null

Loan description or purpose

Example:

"Business expansion loan"

​
documents
string<uri>[] | null

Array of document URLs supporting the loan request

Example:
[
  "https://example.com/docs/business-plan.pdf",
  "https://example.com/docs/financial-statement.pdf"
]
​
userMonthlyIncome
number<double>

Monthly income of the loan applicant

Example:

150000

​
userGhanaCard
string | null

Ghana Card number of the loan applicant

Example:

"GHA-123456789-1"

​
status
enum<string>

Current status of the loan

Available options:
PROCESSING,
PENDING_APPROVAL,
REJECTED,
DISBURSED,
ACTIVE,
COMPLETED,
DEFAULTED
Example:

"PENDING_APPROVAL"

​
user
object

User information of the loan applicant

​
product
object

Loan product information

​
repaymentDate
string<date-time>

Next repayment date

Example:

"2024-07-20T00:00:00Z"

​
createdAt
string<date-time> | null

Date and time when the loan was created

Example:

"2024-01-20T14:45:00Z"