Initiate Excess Payment Refund

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:

13ff2000-7edb-4d7c-8833-579e4766b477

Body Params multipart/form-data

amount

string

required

Required. System will round-off upto configured decimal points.

Example:

100.2347

payout_to

string

required

Optional if configured in program. Values: custom_bank, anchor, borrower

Example:

borrower

credit_bank

string

optional

Mandatory if payout_to is custom_bank. Object with keys (account_holder_name, account_no, ifsc)

method

string

optional

Optional. Values: manual, automatic

Example:

manual

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://preprod.api.crego.io/v1/lms/records/13ff2000-7edb-4d7c-8833-579e4766b477/refunds/' \
--form 'amount="100.2347"' \
--form 'payout_to="borrower"' \
--form 'credit_bank=""' \
--form 'method="manual"'

Responses

🟢200Success

application/json

Body

object {0}

Example

{"id":"13ff2000-7edb-4d7c-8833-579e4766b477","created_at":1738915810.0947723,"updated_at":1739344723.91873,"type":"repayment","ref_id":"REC07RYO","index":2667,"received_amount":63260.0,"tds_amount":0.0,"amount":63260.0,"remaining_amount":-100.2347,"payment_mode":null,"pg_service_id":null,"utr":"Repayment UTR 10","settlement_utr":null,"settlement_order":"due_date_first","component_order":"PI-OI-NI-P","uploaded_by":null,"uploaded_by_id":null,"date":1704451413.696916,"settled_at":1704451413.667609,"revert_date":null,"revert_value_date":null,"revert_sent_to_gl":false,"bank_date":1704451413.667625,"remark":"","status":"processed","collection_bank":{"id":"324c4826-1729-4682-8770-f388b6e7e6b7","ifsc":"YESB0000104","tags":[],"company":"59ecf94e-054d-43ee-83db-b158ab9d7f67","account_no":"000000000000","created_at":1729663373.4807174,"updated_at":1729663373.4946673,"is_verified":false,"account_type":"current","name_at_bank":null,"account_holder_name":"Aerem Collection Account"},"back_date_found":false,"back_date_marked_on":null,"sent_to_gl":true,"settlement_sent_to_gl":false,"is_processed":false,"account":"860bd919-1070-43b9-9099-699235217ac0","topup":null,"transaction":null,"loans":[]}