Crego APIs
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
  1. Topups
  • 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. Topups

Create Topup

preprod
https://preprod.api.crego.io
preprod
https://preprod.api.crego.io
POST
/v1/lms/topups/
Last modified:2025-03-26 07:53:03

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params multipart/form-data
account_ref_id
string 
optional
Optional if account is provided
Example:
CL2POG4B
account
string 
required
Optional if account_ref_id is provided
Example:
15724b84-a39f-4518-8988-424e364edb39
invoice_amount
string 
required
Example:
10000
disbursal_amount
string 
required
Example:
10000
invoice_date
string 
required
Example:
2024-10-22
invoice_no
string 
required
Example:
890222
type
string 
required
Example:
invoice
file
file 
optional
custom_bank_account_no
string 
optional
custom_bank_account_holder_name
string 
optional
custom_bank_ifsc
string 
optional
group
string 
optional

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 POST 'https://preprod.api.crego.io/v1/lms/topups/' \
--form 'account="15724b84-a39f-4518-8988-424e364edb39"' \
--form 'invoice_amount="10000"' \
--form 'disbursal_amount="10000"' \
--form 'invoice_date="2024-10-22"' \
--form 'invoice_no="890222"' \
--form 'type="invoice"' \
--form 'file=@""' \
--form 'custom_bank_account_no=""' \
--form 'custom_bank_account_holder_name=""' \
--form 'custom_bank_ifsc=""' \
--form 'group=""'

Responses

🟢201Created
application/json
Body
id
string 
required
payout_amount
integer 
optional
loan_amount
integer 
required
created_at
number 
required
updated_at
number 
required
ref_id
string 
required
index
integer 
required
status
string 
required
type
string 
required
invoice_date
string 
required
invoice_due_date
null 
optional
invoice_no
string 
optional
vehicle_no
null 
optional
vehicle_data
object 
optional
vehicle_data_vendor
null 
optional
invoice_amount
integer 
required
disbursal_amount
integer 
required
subvention_amount
integer 
optional
holdback_amount
integer 
optional
margin_amount
integer 
required
pf_amount
integer 
optional
pf_gst_amount
integer 
optional
subvention_end_date
null 
optional
invoice_storage_id
null 
optional
invoice_parsed_data
object 
optional
approved_at
null 
optional
custom_bank
object 
required
tags
array[string]
required
scheduled_at
null 
required
disbursement_date
null 
required
is_partial_disbursement
boolean 
required
disbursement_fee
integer 
required
remark
string 
required
hold_remark
null 
required
rejection_remark
string 
required
anomaly_found
boolean 
required
anomaly_approved
boolean 
required
is_check_completed
boolean 
required
uploaded_by
string 
required
uploaded_by_id
string 
required
account
string 
required
same_topup
null 
required
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_fixed_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_min_amount
integer 
required
penal_max_amount
integer 
required
penal_roi_value
array [object {2}] 
required
penal_roi_value_type
null 
required
penal_accrual_frequency
string 
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
null 
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
string 
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
dpd_components
null 
required
topup
string 
required
loan
null 
required
Example
{
    "id": "fc572099-0785-4047-a8bb-a5d024ccba5b",
    "payout_amount": 1002,
    "created_at": 1718451794.301822,
    "updated_at": 1718451795.711252,
    "ref_id": "TOP0000VAZP",
    "status": "rejected",
    "invoice_date": "2024-06-01",
    "invoice_due_date": null,
    "invoice_no": "INV83888",
    "invoice_amount": 10011,
    "disbursal_amount": 1002,
    "subvention_amount": 0,
    "holdback_amount": 0,
    "subvention_end_date": null,
    "invoice_storage_id": null,
    "invoice_parsed_data": {},
    "invoice_approved_at": null,
    "custom_bank": {},
    "tags": [
        "dedupe"
    ],
    "scheduled_at": null,
    "disbursement_date": null,
    "is_partial_disbursement": false,
    "disbursement_fee": 0,
    "remark": "This is duplicate of TOP0000033A",
    "anomaly_found": true,
    "is_check_completed": true,
    "uploaded_by": null,
    "uploaded_by_id": null,
    "account": "a2589953-5b54-4209-b601-5d1cfcc40f5e",
    "same_topup": "2b313a56-b4b8-4d3e-a80c-1065105003d3",
    "loan_data": {
        "id": "b2ac5edb-798b-465c-8532-d37d0e21d688",
        "created_at": 1718283561.935,
        "updated_at": 1718451794.906057,
        "days_in_month": 30,
        "days_in_year": 365,
        "tenure_period": "days",
        "tenure_value": 30,
        "tenure_period_type": "as_per_days",
        "tenure_starts_at": "disbursement_date",
        "roi_period": "years",
        "roi_slab_based": false,
        "roi_value": [
            {
                "value": 15,
                "days": "inf"
            }
        ],
        "overdue_roi_same_as_roi": true,
        "overdue_roi_slab_based": true,
        "overdue_roi_value": [
            {
                "value": 15,
                "days": "inf"
            }
        ],
        "penal_roi_same_as_roi": false,
        "penal_roi_slab_based": false,
        "penal_roi_value": [
            {
                "value": 2,
                "days": "inf"
            }
        ],
        "penal_roi_value_type": null,
        "penal_lag_days_after_due": 0,
        "interest_starts": "same_day",
        "interest_lock_in_enabled": false,
        "interest_lock_in_days": 0,
        "subvention_is_enabled": true,
        "subvention_value_type": "percentage",
        "subvention_value": 15,
        "subvention_days": 30,
        "cashback_is_enabled": true,
        "cashback_use_as": null,
        "cashback_payment_to": "borrower",
        "cashback_release_at": "repayments",
        "cashback_deduction_is_enabled": false,
        "cashback_deduction_type": "fixed",
        "cashback_deduction_value": 0,
        "holdback_is_enabled": false,
        "holdback_rate": 0,
        "holdback_return_is_enabled": false,
        "holdback_return_payment_to": null,
        "topup": "fc572099-0785-4047-a8bb-a5d024ccba5b",
        "loan": null
    }
}
Previous
Check Line Amount
Next
Update Topup
Built with