Crego APIs
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
  1. Accounts
  • Back to home
  • LMS
  • EMIs
    • List EMI
      GET
    • List Settlements
      GET
    • Restructure
      POST
    • Calculate EMI
      POST
    • Run EOD
      POST
    • Request Tranche
      POST
  • Records
    • Request Approval
      PUT
    • Initiate Excess Payment Refund
      POST
    • Initiate Adjustment for Cashback & Holdback
      POST
    • Get Single Record
      GET
    • Record Listing
      GET
    • Create Record
      POST
    • Mark Processed
      PUT
    • Unmatched
      GET
    • Export record
      PUT
    • Bulk Create Records
      POST
  • Topups
    • List Topups
      GET
    • Unschedule a scheduled topup
      PUT
    • Reinitiate Payout
      POST
    • Check Line Amount
      PUT
    • Create Topup
      POST
    • Update Topup
      PATCH
    • Bulk Topup Create
      POST
    • Re Run Checks
      GET
    • Invoice Parse
      PATCH
  • Accounts
    • Initiate Disbursement
      POST
    • Initiate Loan Params
      POST
    • Create Account
      POST
    • Close Loan Account
      PUT
    • Refresh Limit
      GET
    • Get Loan Params
      GET
    • Get Summary
      GET
    • Reset RPS
      POST
    • Update Loan Params
      PATCH
  • Payouts
    • Retry Failed Payout
    • Create Payout
    • Payout Callback
    • Process Payout
    • Unmatched Payouts
    • List Payouts
    • Export Payout for Bank
  • Loans
    • Export Cashback
    • Get Emi Amount
    • Get Loan Summary
    • List Loans with Excess Balance
    • Initiate Adjustment
    • Initiate Refund
    • List Loans
  • Line Details
    • Filter Line Details
    • Create
    • Update
    • Get by type
    • Bulk Internal
    • Retrieve
  • Loan Data
    • Create
    • Update
    • Retrieve
  • Fee
    • Get Fee Demands
    • Bulk Create Fee
    • Create Fee
    • List Fee
    • Fee Details
    • Delete Fee
  • Extra Data
    • Update Extra Data
    • List Extra Data
  • Topup Group
    • Create Topup Group
    • List Topup Group
    • Update TopupGroup
  1. Accounts

Get Loan Params

preprod
https://preprod.api.crego.io
preprod
https://preprod.api.crego.io
GET
/v1/lms/accounts/get_loan_params/
Last modified:2025-01-06 11:59:08

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
lead_id
string 
required
Example:
abec8f1a-79b8-4ec5-9645-38e83ab8fd8e
program_id
string 
required
Example:
4b67c764-afb3-4570-ac21-025ea3255b6e
Body Params application/json
lead_id
string 
required
program_id
string 
required
line_detail
object 
required
approved_line_amount
integer 
required
operative_line_amount
integer 
required
loan_data
object 
required
Example
{
    "lead_id": "abec8f1a-79b8-4ec5-9645-38e83ab8fd8e",
    "program_id": "4b67c764-afb3-4570-ac21-025ea3255b6e"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://preprod.api.crego.io/v1/lms/accounts/get_loan_params/?lead_id=abec8f1a-79b8-4ec5-9645-38e83ab8fd8e&program_id=4b67c764-afb3-4570-ac21-025ea3255b6e' \
--header 'Content-Type: application/json' \
--data-raw '{
    "lead_id": "abec8f1a-79b8-4ec5-9645-38e83ab8fd8e",
    "program_id": "4b67c764-afb3-4570-ac21-025ea3255b6e"
}'

Responses

🟢200OK
application/json
Body
loan_data
object 
required
id
string 
required
created_at
number 
required
updated_at
number 
required
lead_id
string 
required
program_id
string 
required
type
string 
required
days_in_month
integer 
required
days_in_year
integer 
required
tenure_period
string 
required
tenure_value
integer 
required
tenure_period_type
string 
required
tenure_fix_due_date
boolean 
required
tenure_due_days
array[string]
required
tenure_min_days
integer 
required
tenure_starts_at
string 
required
roi_period
string 
required
roi_slab_based
boolean 
required
roi_value
array [object {2}] 
required
overdue_roi_same_as_roi
boolean 
required
overdue_roi_slab_based
boolean 
required
overdue_roi_value
array [object {2}] 
required
penal_roi_same_as_roi
boolean 
required
penal_roi_slab_based
boolean 
required
penal_tax
integer 
required
penal_roi_value
array [object {2}] 
required
penal_roi_value_type
null 
required
penal_charge_on
null 
required
penal_lag_days_after_due
integer 
required
penal_calculation_type
string 
required
interest_starts
string 
required
interest_lock_in_enabled
boolean 
required
interest_lock_in_days
integer 
required
subvention_is_enabled
boolean 
required
subvention_value_type
string 
required
subvention_value
integer 
required
subvention_days
integer 
required
cashback_is_enabled
boolean 
required
cashback_use_as
string 
required
cashback_payment_to
string 
required
cashback_release_at
string 
required
cashback_deduction_is_enabled
boolean 
required
cashback_deduction_type
string 
required
cashback_deduction_value
integer 
required
holdback_is_enabled
boolean 
required
holdback_rate
integer 
required
holdback_return_is_enabled
boolean 
required
holdback_return_payment_to
null 
required
margin_is_enabled
boolean 
required
margin_value_type
null 
required
margin_value
integer 
required
margin_receive_before_disbursement
boolean 
required
pf_is_enabled
boolean 
required
pf_value_type
null 
required
pf_value
integer 
required
pf_gst
integer 
required
emi_frequency
null 
required
emi_count
integer 
required
emi_days
array[string]
required
is_pre_emi_enabled
boolean 
required
pre_emi_period
integer 
required
broker_period_interest
integer 
required
extend_pre_emi_is_enabled
boolean 
required
co_lending_split
object 
required
topup
null 
required
loan
null 
required
line_detail
object 
required
id
string 
required
created_at
number 
required
updated_at
number 
required
type
string 
required
company_id
null 
required
lead_id
string 
required
program_id
string 
required
is_max_active_drawdowns
boolean 
required
max_active_drawdowns
integer 
required
status
string 
required
approved_line_amount
integer 
required
operative_line_amount
integer 
required
line_activation_date
null 
required
line_expiry_date
null 
required
adhoc_line_amount
integer 
required
adhoc_line_activation_date
null 
required
adhoc_line_expiry_date
null 
required
active_line_amount
integer 
required
principal_paid
integer 
required
principal_outstanding
integer 
required
originator_principal_paid
integer 
required
originator_principal_outstanding
integer 
required
co_lender_principal_paid
integer 
required
co_lender_principal_outstanding
integer 
required
interest_paid
integer 
required
interest_outstanding
integer 
required
originator_interest_paid
integer 
required
originator_interest_outstanding
integer 
required
co_lender_interest_paid
integer 
required
co_lender_interest_outstanding
integer 
required
overdue_paid
integer 
required
overdue_outstanding
integer 
required
originator_overdue_paid
integer 
required
originator_overdue_outstanding
integer 
required
co_lender_overdue_paid
integer 
required
co_lender_overdue_outstanding
integer 
required
penal_paid
integer 
required
penal_outstanding
integer 
required
originator_penal_paid
integer 
required
originator_penal_outstanding
integer 
required
co_lender_penal_paid
integer 
required
co_lender_penal_outstanding
integer 
required
subvention_ack
integer 
required
originator_subvention_ack
integer 
required
co_lender_subvention_ack
integer 
required
cashback_available
integer 
required
originator_cashback_available
integer 
required
co_lender_cashback_available
integer 
required
cashback_adjusted
integer 
required
cashback_released
integer 
required
holdback_available
integer 
required
holdback_adjusted
integer 
required
holdback_released
integer 
required
partner_interest_outstanding
integer 
required
partner_overdue_outstanding
integer 
required
partner_penal_outstanding
integer 
required
partner_interest_ack
integer 
required
partner_overdue_ack
integer 
required
partner_penal_ack
integer 
required
due_amount
integer 
required
total_paid
integer 
required
total_outstanding
integer 
required
invoice_amount
integer 
required
disbursal_amount
integer 
required
loan_amount
integer 
required
payout_amount
integer 
required
subvention_amount
integer 
required
holdback_amount
integer 
required
active_accounts
integer 
required
excess_payment
integer 
required
loan_count
integer 
required
topup_count
integer 
required
due_loan_count
integer 
required
pending_disbursal_amount
integer 
required
pending_disbursal_count
integer 
required
dpd
integer 
required
peak_dpd
integer 
required
Example
{
    "loan_data": {
        "id": "string",
        "created_at": 0,
        "updated_at": 0,
        "lead_id": "string",
        "program_id": "string",
        "type": "string",
        "days_in_month": 0,
        "days_in_year": 0,
        "tenure_period": "string",
        "tenure_value": 0,
        "tenure_period_type": "string",
        "tenure_fix_due_date": true,
        "tenure_due_days": [
            "string"
        ],
        "tenure_min_days": 0,
        "tenure_starts_at": "string",
        "roi_period": "string",
        "roi_slab_based": true,
        "roi_value": [
            {
                "days": "string",
                "value": 0
            }
        ],
        "overdue_roi_same_as_roi": true,
        "overdue_roi_slab_based": true,
        "overdue_roi_value": [
            {
                "days": "string",
                "value": 0
            }
        ],
        "penal_roi_same_as_roi": true,
        "penal_roi_slab_based": true,
        "penal_tax": 0,
        "penal_roi_value": [
            {
                "days": "string",
                "value": 0
            }
        ],
        "penal_roi_value_type": null,
        "penal_charge_on": null,
        "penal_lag_days_after_due": 0,
        "penal_calculation_type": "string",
        "interest_starts": "string",
        "interest_lock_in_enabled": true,
        "interest_lock_in_days": 0,
        "subvention_is_enabled": true,
        "subvention_value_type": "string",
        "subvention_value": 0,
        "subvention_days": 0,
        "cashback_is_enabled": true,
        "cashback_use_as": "string",
        "cashback_payment_to": "string",
        "cashback_release_at": "string",
        "cashback_deduction_is_enabled": true,
        "cashback_deduction_type": "string",
        "cashback_deduction_value": 0,
        "holdback_is_enabled": true,
        "holdback_rate": 0,
        "holdback_return_is_enabled": true,
        "holdback_return_payment_to": null,
        "margin_is_enabled": true,
        "margin_value_type": null,
        "margin_value": 0,
        "margin_receive_before_disbursement": true,
        "pf_is_enabled": true,
        "pf_value_type": null,
        "pf_value": 0,
        "pf_gst": 0,
        "emi_frequency": null,
        "emi_count": 0,
        "emi_days": [
            "string"
        ],
        "is_pre_emi_enabled": true,
        "pre_emi_period": 0,
        "broker_period_interest": 0,
        "extend_pre_emi_is_enabled": true,
        "co_lending_split": {},
        "topup": null,
        "loan": null
    },
    "line_detail": {
        "id": "string",
        "created_at": 0,
        "updated_at": 0,
        "type": "string",
        "company_id": null,
        "lead_id": "string",
        "program_id": "string",
        "is_max_active_drawdowns": true,
        "max_active_drawdowns": 0,
        "status": "string",
        "approved_line_amount": 0,
        "operative_line_amount": 0,
        "line_activation_date": null,
        "line_expiry_date": null,
        "adhoc_line_amount": 0,
        "adhoc_line_activation_date": null,
        "adhoc_line_expiry_date": null,
        "active_line_amount": 0,
        "principal_paid": 0,
        "principal_outstanding": 0,
        "originator_principal_paid": 0,
        "originator_principal_outstanding": 0,
        "co_lender_principal_paid": 0,
        "co_lender_principal_outstanding": 0,
        "interest_paid": 0,
        "interest_outstanding": 0,
        "originator_interest_paid": 0,
        "originator_interest_outstanding": 0,
        "co_lender_interest_paid": 0,
        "co_lender_interest_outstanding": 0,
        "overdue_paid": 0,
        "overdue_outstanding": 0,
        "originator_overdue_paid": 0,
        "originator_overdue_outstanding": 0,
        "co_lender_overdue_paid": 0,
        "co_lender_overdue_outstanding": 0,
        "penal_paid": 0,
        "penal_outstanding": 0,
        "originator_penal_paid": 0,
        "originator_penal_outstanding": 0,
        "co_lender_penal_paid": 0,
        "co_lender_penal_outstanding": 0,
        "subvention_ack": 0,
        "originator_subvention_ack": 0,
        "co_lender_subvention_ack": 0,
        "cashback_available": 0,
        "originator_cashback_available": 0,
        "co_lender_cashback_available": 0,
        "cashback_adjusted": 0,
        "cashback_released": 0,
        "holdback_available": 0,
        "holdback_adjusted": 0,
        "holdback_released": 0,
        "partner_interest_outstanding": 0,
        "partner_overdue_outstanding": 0,
        "partner_penal_outstanding": 0,
        "partner_interest_ack": 0,
        "partner_overdue_ack": 0,
        "partner_penal_ack": 0,
        "due_amount": 0,
        "total_paid": 0,
        "total_outstanding": 0,
        "invoice_amount": 0,
        "disbursal_amount": 0,
        "loan_amount": 0,
        "payout_amount": 0,
        "subvention_amount": 0,
        "holdback_amount": 0,
        "active_accounts": 0,
        "excess_payment": 0,
        "loan_count": 0,
        "topup_count": 0,
        "due_loan_count": 0,
        "pending_disbursal_amount": 0,
        "pending_disbursal_count": 0,
        "dpd": 0,
        "peak_dpd": 0
    }
}
Previous
Refresh Limit
Next
Get Summary
Built with