Skip to main content
GET
/
v1
/
loans
/
external
/
{loan_external_id}
Get a loan
curl --request GET \
  --url https://api-staging.bsa.ai/v1/loans/external/{loan_external_id} \
  --header 'Authorization: Bearer <token>'

Documentation Index

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

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

Two equivalent forms. Prefer the externalId path — it’s a direct LMS lookup (/loans/external-id/{X}), single call, and lets you key off the reference you chose at create time.

​
Path parameters

​
loan_external_id
string
required
The loan’s externalId. On the /v1/loans/{loan_id} form, this is the numeric LMS id instead.

​
Examples

# By loan externalId (recommended)
curl -sf "$BASE/v1/loans/external/halotel-tx-12345" \
  -H "Authorization: Bearer $TOKEN"

# By LMS id
curl -sf "$BASE/v1/loans/501" \
  -H "Authorization: Bearer $TOKEN"

​
Response

200 OK returns the full loan object — including the balance roll-up, nextDueDate / nextDueAmount, and the full repaymentSchedule.

​
Errors

CodeWhen
not_foundNo loan with that id or externalId