Generate Payment History

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

Payment history report analyzes up to 12-months of transactions and predicts the probability that a SMB will experience a payment risk event, such as NSF/Overdraft or missed recurring payments, in the near future when making a payment. The Risk Score provided in the report is a 2-digit ranking with four levels of risk going from low to high.

Some of the highlights of calculated risk present in the report include: * Risk Score representing the likelihood of a missed payment based on analysis of permissioned open-banking data

• Monthly average balance for all accounts by month in the requested time period

• Total deposit amount by month for all accounts in the requested time period

• Total withdrawal amounts by month for all accounts in the requested time period

• Number of NSF counts and aggregate amount per month in the requested time period

• Recurring loan payment amounts per month in the requested time period

• Insurance payment amount per month in the requested time period

• Tax payment amounts per month in the requested time period

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

Note: this is a premium service, billable per every successful API call for non-testing customers.

A successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get OBB Analytics Report (operation: GetObbAnalyticsReport). Note: this is a premium service, billable per every successful API call for non-testing customers.

Supported regions:

Request Params

HEADERS

RESPONSES

status: OK

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