Get all wallet balances
Changed onThis endpoint is used to fetch the various balances for your different currency wallets.
get/wallets?businessID={businessId}
Request
- Base URLhttps://sandboxapi.fincra.com
- AuthAPI key in header api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
businessIdstring required
Your business ID. This can be retrieved by calling the GET Business info endpoint here: https://docs.fincra.com/reference/get-business-information
Query parameters
dateFromstring date
start date of range
dateTostring date
End date of range
currencystring
specific currency you wish to get balances for. To get all wallets' balances, do not pass this field.
Response
200
Example response
{
"success": true,
"message": "Wallets fetched successfully",
"data": [
{
"id": 12470,
"_id": "12470",
"business": "6321e754fd67117e4466f306",
"businessId": 2919,
"ledgerBalance": 5.635,
"availableBalance": 5.635,
"walletNumber": 100000129190001,
"currency": "NGN",
"status": "enabled",
"createdAt": "2022-09-14T14:38:13.000Z",
"updatedAt": "2023-10-17T16:04:15.000Z",
"closingAvailableBalance": 5.635,
"closingLedgerBalance": 5.635
}
]
}Changes
- info
endpoint added
- info