Crego APIs
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
  1. Loans
  • Back to home
  • LMS
  • EMIs
    • List EMI
      GET
    • List Settlements
      GET
    • Restructure
      POST
    • Calculate EMI
      POST
    • Run EOD
      POST
    • Request Tranche
      POST
    • Outstanding data
      PUT
  • 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
    • Initiate Loan Params
    • Create Account
    • Close Loan Account
    • Refresh Limit
    • Get Loan Params
    • Get Summary
    • Reset RPS
    • Update Loan Params
  • Payouts
    • Retry Failed Payout
    • Create Payout
    • Payout Callback
    • Process Payout
    • Unmatched Payouts
    • List Payouts
    • Export Payout for Bank
  • Loans
    • Export Cashback
      GET
    • Get Emi Amount
      GET
    • Get Loan Summary
      GET
    • List Loans with Excess Balance
      GET
    • Initiate Adjustment
      POST
    • Initiate Refund
      POST
    • List Loans
      GET
  • 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. Loans

Initiate Refund

preprod
https://preprod.api.crego.io
preprod
https://preprod.api.crego.io
POST
/v1/lms/loans/{id}/refunds/
Last modified:2025-02-12 13:01:23

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Example:
4541ca25-cf98-4b75-a2c8-db7d5a6b9e69
Body Params application/json
amount
integer 
required
type
string 
required
Example
{
    "amount": 1,
    "type": "cashback_refund" // options: cashback_refund/holdback_refund
}

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/loans/4541ca25-cf98-4b75-a2c8-db7d5a6b9e69/refunds/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1,
    "type": "cashback_refund" // options: cashback_refund/holdback_refund
}'

Responses

🟢201Created
application/json
Body
id
string 
required
created_at
number 
required
updated_at
number 
required
type
string 
required
ref_id
string 
required
numeric_ref_id
string 
required
index
integer 
required
amount
integer 
required
method
string 
required
status
string 
required
payout_service_id
null 
required
processed_at
null 
required
bank_date
null 
required
date
null 
required
failed_remark
null 
required
utr
null 
required
debit_bank
null 
required
credit_bank
object 
required
program_ids
array[string]
required
account_type
string 
required
account_no
string 
required
account_holder_name
string 
required
ifsc
string 
required
is_verified
boolean 
required
tags
array[string]
required
banking_id
string 
required
created_at
number 
required
updated_at
number 
required
id
string 
required
payout_to
string 
required
is_downloaded
boolean 
required
is_imported
boolean 
required
sent_to_gl
boolean 
required
account
string 
required
topup
string 
required
loan
null 
required
record
null 
required
transaction
null 
required
Example
{"id":"3247f6a9-c244-4c4c-a46f-2afbbf05454c","created_at":1739365123.7255921,"updated_at":1739365123.801989,"type":"cashback_refund","ref_id":"PAY0ERXD","numeric_ref_id":"4449","index":4449,"amount":1.0,"method":"manual","status":"pending_approval","payout_service_id":null,"processed_at":null,"bank_date":null,"date":null,"failed_remark":null,"utr":null,"debit_bank":null,"credit_bank":{"program_ids":[],"account_type":"Current","account_no":"100010203920","account_holder_name":"HDFC BANK","ifsc":"HDFC000384748","is_verified":false,"tags":[],"banking_id":"a7680d00-2b0d-4f60-aa4a-8b237790efe9","created_at":1715602859.95,"updated_at":1715602859.95,"id":"f8a5a165-8fe7-43ec-9575-c27654fa7a83"},"payout_to":"borrower","is_downloaded":false,"is_imported":false,"sent_to_gl":false,"account":"69fd0af6-3310-4fed-9bf8-1ad4ef612e31","topup":"5dbe9d3b-62b6-410d-b83e-63c63d03fecb","loan":null,"record":null,"transaction":null}
Modified at 2025-02-12 13:01:23
Previous
Initiate Adjustment
Next
List Loans
Built with