Loan Details with Payment History

Retrieves comprehensive loan application details including payment history and installment schedule.

GET /api/v1/services/user/loan-details-with-payment-history/{loan-application-id}

cURL GET

[https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id}](https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id})

200

{
  "status": "<string>",
  "data": {
    "loanApplicationId": "<string>",
    "customerId": "<string>",
    "customerName": "<string>",
    "customerEmail": "<string>",
    "loanProductName": "<string>",
    "loanApplicationStatus": "<string>",
    "accountState": "<string>",
    "loanAmount": 123,
    "interestRate": 123,
    "totalRepaymentAmount": 123,
    "totalBalance": 123,
    "principalBalance": 123,
    "interestBalance": 123,
    "feesBalance": 123,
    "penaltyBalance": 123,
    "totalAmountPaid": 123,
    "principalPaid": 123,
    "interestPaid": 123,
    "feesPaid": 123,
    "penaltyPaid": 123,
    "applicationDate": "<string>",
    "disbursementDate": "<string>",
    "firstInstallmentDate": "<string>",
    "maturityDate": "<string>",
    "nextPaymentDueDate": "<string>",
    "totalInstallments": 123,
    "installmentsPaid": 123,
    "installmentsRemaining": 123,
    "loanDuration": 123,
    "durationCounter": "<string>",
    "loanRepaymentMethod": "<string>",
    "isThirdPartyPayment": true,
    "repaymentBankName": "<string>",
    "repaymentAccountNumber": "<string>",
    "repaymentAccountName": "<string>",
    "loanFullyRepaid": true,
    "currencyCode": "<string>",
    "paymentHistory": [
      {
        "installmentNumber": 123,
        "dueDate": "<string>",
        "installmentAmount": 123,
        "principalAmount": 123,
        "interestAmount": 123,
        "feesAmount": 123,
        "penaltyAmount": 123,
        "amountPaid": 123,
        "outstandingAmount": 123,
        "paymentStatus": "<string>",
        "paymentDate": "<string>",
        "daysOverdue": 123
      }
    ]
  }
}

Fetches detailed information about a loan application including all installments, payment history, outstanding balances, and repayment schedule.

cURL GET

[https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id}](https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id})

Request Headers

X-Auth-Token · string · required

The JWT Access Token obtained from the /login or /refresh-token endpoint.

x-idempotency-key · string · required

Unique idempotency key for the request to prevent duplicate processing.

x-fapi-auth-date · string · required

The date and time at which the request was initiated (ISO 8601 format).

x-fapi-customer-ip-address · string · required

The IP address of the customer making the request.

x-fapi-interaction-id · string · required

Unique identifier for the interaction/session.

Path Parameters

loan-application-id · string · required

The unique identifier (UUID) of the loan application for which to retrieve details.

Response

Returns comprehensive loan details including installment schedule and payment history.

status · string · default: "SUCCESS"

Overall status of the API request.

data · object

Loan application details with payment history.

Show data object

loanApplicationId · string

Unique identifier of the loan application.

customerId · string

Unique identifier of the customer.

customerName · string

Name of the customer.

customerEmail · string

Email address of the customer.

loanProductName · string

Name of the loan product.

loanApplicationStatus · string

Current status of the loan application (e.g., REQUESTED, APPROVED, DISBURSED).

accountState · string

Account state (e.g., ACTIVE, CLOSED, ACTIVE_IN_ARREARS).

loanAmount · number

Original loan amount (principal).

interestRate · number

Interest rate applicable to the loan.

totalRepaymentAmount · number

Total repayment amount (principal + total interest + fees).

totalBalance · number

Total outstanding balance.

principalBalance · number

Outstanding principal balance.

interestBalance · number

Outstanding interest balance.

feesBalance · number

Outstanding fees balance.

penaltyBalance · number

Outstanding penalty balance.

totalAmountPaid · number

Total amount paid so far.

principalPaid · number

Principal amount paid.

interestPaid · number

Interest amount paid.

feesPaid · number

Fees amount paid.

penaltyPaid · number

Penalty amount paid.

applicationDate · string

Date when the loan application was created.

disbursementDate · string

Date when the loan was disbursed.

firstInstallmentDate · string

Date of the first installment.

maturityDate · string

Loan maturity date.

nextPaymentDueDate · string

Next payment due date.

totalInstallments · number

Total number of installments.

installmentsPaid · number

Number of installments paid.

installmentsRemaining · number

Number of installments remaining.

loanDuration · number

Loan duration.

durationCounter · string

Duration counter unit (e.g., MONTH, WEEK, DAY).

loanRepaymentMethod · string

Loan repayment method (e.g., External Bank Transfer, Internal Bank Transfer).

isThirdPartyPayment · boolean

Whether the loan uses third-party payment collection (e.g., Remita).

repaymentBankName · string

Bank name for manual repayments.

repaymentAccountNumber · string

Account number for manual repayments.

repaymentAccountName · string

Account name for manual repayments.

loanFullyRepaid · boolean

Whether the loan is fully repaid.

currencyCode · string

Currency code.

paymentHistory · array

List of all installments with payment details.

Show paymentHistory array item (InstallmentDto)

installmentNumber · number

Installment number (1, 2, 3, etc.).

dueDate · string

Due date for this installment.

installmentAmount · number

Total installment amount (principal + interest + fees).

principalAmount · number

Principal amount for this installment.

interestAmount · number

Interest amount for this installment.

feesAmount · number

Fees amount for this installment.

penaltyAmount · number

Penalty amount (if any).

amountPaid · number

Amount paid for this installment.

outstandingAmount · number

Outstanding amount for this installment.

paymentStatus · string

Payment status (e.g., PENDING, PAID, PARTIAL, OVERDUE).

paymentDate · string

Date when payment was made (if paid).

daysOverdue · number

Number of days overdue (if applicable).

Code Examples

cURL

curl --location 'https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/123e4567-e89b-12d3-a456-426614174000' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'x-idempotency-key: unique-key-12345' \
--header 'x-fapi-auth-date: 2024-01-15T10:30:00Z' \
--header 'x-fapi-customer-ip-address: 192.168.1.1' \
--header 'x-fapi-interaction-id: interaction-12345'