Onetime Income Report

Create a widget link to initiate the income report generation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

An opaque value provided by the partner in order to maintain state between this request and the eventual callback. The widget UI includes this value when redirecting the user-agent back to the partner and allows to identify the initiated Widget flow.

url
required

After completing its interaction with the user, the Widget UI directs the user's user-agent to this redirection endpoint. The callback includes state, success and flow_id as query parameters.

  • state: This value is provided upon flow initiation and can be used to track state on the partner side.
  • success: Indicates if the flow was successfully finished.
  • flow_id: A unique ID to identify a specific Widget flow.
string

The display language used in the Widget UI.

string
enum
required

A SAMA use-case to specify the purpose of fetching the data.

Allowed:
provider_id
object
deprecated

Deprecated in favour of accounts, which can be used to preselect a financial provider.
Used to skip the bank search and selection, if not given the user is able to search and select a financial provider. See catalog on how to obtain a provider_id.

accounts
array of objects
Defaults to []

List of identifiers that will auto select the appropriate accounts.

accounts
account_types
array of strings
Defaults to []

Limits the type of accounts that can be selected throughout the flow. Use this field if you only want to allow your users to select/connect certain types of accounts (i.e Current accounts).

account_types
boolean
Defaults to true

Indicates whether to allow multiple accounts to be selected. Ignored if accounts is set.

integer
Defaults to 90

Defines the number of days of transaction history that is requested from the financial provider.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json