Skip to main content

FUNDS REPORT​

This API allows users to fetch the Funds Report, including deposit and withdrawal transaction records for a specified date range.

🔍 Query Parameters​

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters​

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

📑 Request Body Parameters​

FieldTypeRequiredDescriptionExample
FromDatestringYesStart date for the report"04-01-2022"
ToDatestringYesEnd date for the report"04-01-2022"
StatusintegerNoFilter by transaction type1 = Deposit, 2 = Withdrawal
bankIdstringNoBank ID filter"HDFC"
fund_typestringNoFund type filter"ONLINE"

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Funds report fetched successfully"
dataarrayList of funds transactions matching the specified criteriaTransaction records