Purchase account balance
Get purchase account balance
POST /selling/api/loans/purchase/balance
Get the current balance of the purchase account that would be used for the specified purchase parameters. Use this to verify sufficient funds before executing a purchase.
Request body
{
"date": "2026-08-05",
"loanType": 1,
"issuingBank": "CRB",
"mplId": "ABC",
"investorId": "Investor Name"
}
Field | Type | Required | Description |
|---|---|---|---|
date | String | Yes | Purchase date in YYYY-MM-DD format. Must be a fed day. |
loanType | Integer | Yes | Loan type: 1 = HFS, 2 = LTHFS |
issuingBank | String | Yes | Issuing bank identifier (e.g., "CRB") |
mplId | String | Yes | MPL identifier |
investorId | String | No | Investor identifier (optional) |
Response
200 OK - Returns a number (decimal) representing the account balance
2500000.00
Example request
POST /selling/api/loans/purchase/balance
Content-Type: application/json
{
"date": "2026-08-05",
"loanType": 1,
"issuingBank": "CRB",
"mplId": "ABC",
"investorId": "XYZ Investor"
}
Use cases
- Pre-purchase validation: Ensure sufficient funds before calling the purchase API
- Insufficient funds detection: Alert when balance is too low
- Multi-purchase planning: Calculate if account can handle multiple purchase batches