Generate Cash Flow Analytics

POST {{baseUrl}}/analytics/cashflow/v1/customer/{{customerId}}?reference-number=abc123

Cash Flow Analytics for Business analyzes cash flow over time to report metrics and identify behavior that may indicate risk.

Calculated metrics include: * Average transaction value by month over the requested time period * Net cash flow over the requested time period and broken down by month * Count and report of weeks in the requested time period where there were zero transactions posted to the customer's accounts

• Minimum/maximum/average/sum/count of deposits by month
• Minimum/maximum/average/sum/count of withdrawals by month

• Estimated amount of deposits that can be classified as business revenue

• Number of transactions posted incurring a non-sufficient funds (NSF) fee, and net amount charged in NSF fees

This version of the API is intended for piloting and integration testing your application with the Cash Flow Analytics product. It does not adhere to FCRA requirements, and should not be used for production/lending purposes. See Generate Cash Flow Analytics - FCRA for the FCRA compliant version of this API.

A successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get Cash Flow Analytics Report (operation: GetCashFlowAnalyticsReport).

Supported regions:

Request Params

HEADERS

RESPONSES

status: OK

{"accountIds":[10001,10002,10003],"businessId":123,"createdDate":"2022-02-10T05:00:00-07:00","customerId":10001,"reportId":"145cabe0-2b38-4175-9b7e-115431359839","reportPin":"qert","requesterName":"Mortage ABC LLC","title":"Finicity Cashflow Analytics"}