Skip to main content

Budget Insight

Budget Insight is an aggregator of banking data and an essential B2B partner for financial services aggregation in Europe. You can use Budget Insight to fetch open banking information (accounts, transactions) from your users bank accounts.

This provider supports these data types:

info

To use Budget Insight, your user's bank account has to be listed in the provider's supprted contries list

Connect your Budget Insight account​

To retrieve open banking data from your users bank accounts, you have to connect your Budget Insight account with Qard. To do that, you'll have to:

  1. Create a Budget Insight account.
  2. Connect your account to Qard API using your credentials (domain, clientId, clientSecret).
  3. Test your integration by creating a new synchronization using Budget Insight provider.

Create a new account:​

  1. Go to the Budget Insight register page and fill out the form to create a new account.
  2. Create a new domain via domains page
  3. Create a new application
    https://console.budget-insight.com/domains/{YOUR_DOMAIN_NAME}.biapi.pro/client-applications/new and put Qard redirection URI (https://api.qardfinance.com/callback/budgea) in redirection URIs field.
  4. Get your application credentials (Client ID & Client secret).

1. Update Budget Insight provider credentials:​

  • domain: Your domain name (ex: your-domain-name.biapi.pro)
  • client_id: Application client ID
  • clien_secret: Application client secret
(PUT) /api/v6/providers/budget_insight/credentials
{
  "credentials": {
    "domain": "BUDGET_INSIGHT_CUSTOM_DOMAIN",
    "client_id": "BUDGET_INSIGHT_CLIENT_ID",
    "client_secret": "BUDGET_INSIGHT_CLIENT_SECRET"
  }
}

2. Settings Budget Insight provider:​

(PUT) /api/v6/providers/budget_insight/settings
{
  "auto_connect": true
}

3. Enable Budget Insight provider:​

(PUT) /api/v6/providers/budget_insight
{
  "enable": true
}

Test Budget Insight integration:​

You can test Budget Insight integration by creating a new data connection for your user.

(POST) /api/v6/users/{userId}/data-connections
{
  "provider_name": "budget_insight",
  "requested_data_types": [
    "BANK_ACCOUNT",
    "BANK_TRANSACTION",
    "CASHFLOW",
    "CREDIT_INSIGHTS"
  ]
}

After finishing the connecting process by your user, and after validating that the data connection status is CONNECTED, you can run a new synchronization.

(POST) /api/v6/users/{userId}/sync
{
  "data_types": [
    "BANK_ACCOUNT",
    "BANK_TRANSACTION",
    "CASHFLOW",
    "CREDIT_INSIGHTS"
  ]
}

To verify that you are receiving your user's open banking data, check out these endpoints:

  • GET /api/v6/users/{userId}/banking-accounts
  • GET /api/v6/users/{userId}/banking-accounts/{bankAccountId}/transactions
  • GET /api/v6/users/{userId}/banking-credit-insights
  • GET /api/v6/users/{userId}/banking-cashflow