Skip to main content
POST
/
v1
/
loans
/
{loan_id}
/
repayments
/
recover
Record a recovery payment
curl --request POST \
  --url https://api-dev.bsa.ai/v1/loans/{loan_id}/repayments/recover \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.api.bsa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Records a recovery payment against a loan that has been written off. The amount is logged as a recovery transaction; the loan itself remains in Closed (written off) status.

Path parameters

loan_id
string
required

Request body

See the common repayment body.

Example

curl -sf -X POST "$BASE/v1/loans/501/repayments/recover" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactionDate": "2027-04-12",
    "transactionAmount": 200,
    "note": "Partial recovery via collection agency"
  }'

Response

200 OK returns the repayment object with type="Recovery Repayment".

Errors

CodeWhen
not_foundNo loan with that ID
abortedLoan has not been written off