Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

1. Data Source Import

...

Drawio
zoom1
simple0
inComment0
pageId1542193157
custContentId1653637261
lbox1
diagramDisplayNameAccess
contentVer78
revision89
baseUrlhttps://finapi.jira.com/wiki
diagramNameAccess
pCenter0
width1023.0000000000001
links
tbstyle
height1103.4999999999998

To create a data source (bank connection) in DI:

  1. Import the Bank Connection with the help of finAPI Web Form 2.0 (POST / webForms/bankConnectionImport).

  2. Upon successful completion of the SCA (web form), make a call to the DI POST / dataSources / bankConnections / synchronizationwith included callbackUrl (optional) and retrieve the imported bank connection with the DI dataSourceId. To ensure that the data source import has been finalized, poll POST

3a. In case the callbackUrl has been provided, DI will send notification to the client once the Data Source synchronization is finalized (with SUCCESSFUL or ERROR)

3b. In case the callbackUrl has not been provided, poll GET / dataSources / {dataSourceId} / status until the data source status isSUCCESSFUL or ERROR.

NOTE: The bank connection is not considered as imported until the SCA (webform) is completed successfully.

...

  1. Data source synchronization call returned bank connection in status FAILED

  2. Calling GET/dataSources/{dataSourceId}/status resulted in status FAILEDand codeUPDATE_REQUIRED.

...

To create a report of a particular type (Chargebacks, Gambling, B2B Balances, Insurance) and of particular category (Risk, Cash Flow, B2B, Contracts ) , make a call to POST/cases/{caseId}/reports/ <report_category>/<report_type>.

NOTE: If there is a need for report to be re-generated automatically in particular time periods without additional user interaction, the interval and intervalPeriod fields need to be specified. Such a report will be considered continuous and will have associated with it child reports, created automatically inside of the same case file.

...

To get a report of a particular type (Chargebacks, Gambling, B2B Balances, Insurance) and of particular category (Risk, Cash Flow, B2B, Contracts) , make a call to GET/cases/{caseId}/reports/ <report_category>/<report_type>.

NOTE: Every case file may have maximum one report of a particular type: e.g. 1 case file may have 1 Chargebacks report, 1 Gambling report and 1 Insurance Report (child reports are not taken into account for this count).

...

The case file id returned in the response of the call should be used as an input path parameter for GET cases/{caseId}/reports to retrieve the DAC report results.

...

  1. Select one of the pre-defined triggers via POST /reports/{reportId}/triggers/cashFlow

  2. Create your own trigger via POST /reports/{reportId}/triggers

Pre-defined triggers

For example, if the client wants to get notified, when the user’s salary amount will change, he can use SALARYAMOUNTCHANGE pre-defined trigger. For this make a call to POST /reports/{reportId}/triggers/cashFlow with the triggerType = SALARYAMOUNTCHANGE and reportId of the created by the client continuous Income Report, that contains salary transactions.

...

For example, if the client wants to get notified once the user concluded a new health insurance contract, the following trigger for continuous Contracts Report for Insurances can be set via POST /reports/{reportId}/triggers. To do this the client should find the contracts of contractType= HEALTHINSURANCE AND newContract=true, to ensure that the contract is new for the user.

...

In case it is needed to remove the DI data of the user, such as the created Data Sources, Reports, Cases, theDELETE/ user endpoint can be used.

To delete the user’s data it is mandatory to pass a valid user access_token.

...

To ensure whether the deletion process has been finalized for the user, the obtained deletionId should be used for GET /user/status/delete/{deletionId} call. The response of the call is aimed at providing the detailed data on the status of data deletion at each DI module (application).

...