Biapi

Budgea API Documentation

Budgea Development Guides Welcome to Budgea's documentation. This documentation is intended to get you up-and-running with our APIs and advise on the…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Budgea Development Guides

Welcome to Budgea's documentation.

This documentation is intended to get you up-and-running with our APIs and advise on the implementation of some regulatory aspects of your application, following the DSP2's guidelines.

Getting Started

IMPORTANT
Depending on your status with regard of the DSP2 regulation, agent or partner, you may call our APIs or simply use our Webview and callbacks to get the financial data of your users.
As an agent, you are allowed to call directly our APIs and implement your own form to get the user's credentials.
As a partner, you cannot manipulate the credentials, and have to delegate this step to us through our webview.

The sections below will document how to use our APIs, make sure you have the agent status to do so.
For the partner, please refer to the section Webview and Callbacks of this documentation.

Overview

Your API is a REST API which requires a communication through https to send and receive JSON documents.
During your tests, we recommend to make calls to the API with curl or any other HTTP client of your choice.
You can watch a video demonstration on this URL.
For the examples we'll use the demo API with address https://demo.biapi.pro, you should change that name to your API's name.

Hello World

Let's start by calling the service /banks which lists all available banks.

curl https://demo.biapi.pro/2.0/banks/

To log in to a bank webpage, you'll need to know for a given bank, the fields your user should fill in the form.
Let's call a specific bank and ask for an additional resource fields.

curl https://demo.biapi.pro/2.0/banks/59?expand=fields

The response here concerns only 1 bank (since we specified an id) and the resource _Fields_ is added to the response thanks to the query parameter expand.

To get more interesting things done, you'll need to send authenticated requests.

Authentication

The way to authenticate is by passing the Authorization: Bearer header in your request.
At the setup a _manage token_ have been generated, you can use this token for now, when creating your user we'll see how to generate a user's token.

curl https://demo.biapi.pro/2.0/config \
  -H 'Authorization: Bearer  '

This endpoint will list all the parameters you can change to adapt Budgea to your needs.

We've covered the very first calls. Before diving deeper, let's see some general information about the APIs.

Abstract

API URL

https://demo.biapi.pro/2.0

Requests format

Data format: application/x-www-form-urlencoded or application/json (suggested)

Additional headers: Authorization: User's token (private)

Responses format

Data format: application/json (http://www.json.org)
Charset: UTF-8

Resources

Each call on an endpoint will return resources. The main resources are:

ResourceDescription
UsersRepresent a user
ConnectionA set of data used to authenticate on a website (usually a login and password). There is 1 connection for each website
AccountA bank account contained in a connection
TransactionAn entry in a bank account
InvestmentAn asset in a bank account

The chain of resources is as follow: Users ∈ Connections ∈ Accounts ∈ Transactions or Investments

RESTful API

This API is RESTful, which means it is stateless and each resource is accessed with an unique URI.

Several HTTP methods are available:

MethodDescription
GET /resourcesList resources
GET /resources/{ID}Get a resource from its ID
POST /resourcesCreate a new resource
POST /resources/{ID}Update a resource
PUT /resources /{ID}Update a resource
DELETE /resourcesRemove every resources
DELETE /resources/{ID}Delete a resource

Each resource can contain sub-resources, for example:
/users/me/connections/2/accounts/23/transactions/48

HTTP response codes

CodeMessageDescription …

Endpoints 167

Administration

  • GETList clients/clients?expand=string
  • POSTCreate a client/clients?expand=string
  • GETGet information about a client/clients/:id_client?expand=stringIf you use the manage_token or a configuration token, you will get also the client secret.<br><br>
  • PUTUpdate a client/clients/:id_client?expand=string
  • DELETEDelete a client/clients/:id_client?expand=string
  • POSTUpdate the client logo/clients/:id_client/logo?expand=string
  • DELETEDelete the client logo/clients/:id_client/logo?expand=string
  • GETGet configuration of the API./config?search=string<br><br>
  • POSTInsert/update configuration key(s)/value(s) on the API./config
  • GETGet configuration change history of the API./config/logs?search=string&type=string&min_date=2024-01-01&max_date=2024-01-01&expand=string<br><br>
  • GETget performances stats on this instance/monitoring?period=0
  • GETGet public encryption key of the API./publickey
  • POSTTest synchronization on a random connection./test/syncIt can be used to test receiving data on your webhooks.<br><br>
  • POSTTest synchronization on a random connection./test/webhooksIt can be used to test receiving data on your webhooks.<br><br>
  • GETGet webhooks/webhooks?expand=string
  • POSTAdds a new webhook/webhooks?expand=string
  • DELETEDeletes all webhooks/webhooks?expand=stringUpdates the deleted field with the date of the deletion<br><br>
  • GETGet webhooks authentication types/webhooks/auth?expand=string
  • POSTAdds a new webhook authentication type/webhooks/auth?expand=string
  • DELETEDeletes all webhook authentication types/webhooks/auth?expand=string
  • PUTUpdates the webhook authentication type/webhooks/auth/:id_auth?expand=string
  • POSTUpdates the webhook authentication type/webhooks/auth/:id_auth?expand=string
  • DELETEDeletes the webhook authentication type/webhooks/auth/:id_auth?expand=stringUpdates the deleted field with the date of the deletion<br><br>
  • PUTUpdates a webhook/webhooks/:id_webhook?expand=string
  • POSTUpdates a webhook/webhooks/:id_webhook?expand=string
  • DELETEDeletes a webhook/webhooks/:id_webhook?expand=stringUpdates the deleted field with the date of the deletion<br><br>
  • GETretrieve the list of the value to add in webhooks when sending the requested webhook/webhooks/:id_webhook/add_to_data?expand=string
  • POSTSetup a field to store in user config when calling the endpoint/webhooks/:id_webhook/add_to_data?expand=stringFor each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the…
  • DELETEdelete all entries/webhooks/:id_webhook/add_to_data?expand=string
  • GETretrieve the value to add in the requested webhook for the requested name/webhooks/:id_webhook/add_to_data/:key?expand=string
  • POSTupate the requested field to store in user config when calling the endpoint/webhooks/:id_webhook/add_to_data/:key?expand=stringFor each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the…
  • DELETEdelete the requested entry/webhooks/:id_webhook/add_to_data/:key?expand=string
  • GETGet webhooks logs./webhooks/:id_webhook/logs?id_user=0&limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&expand=stringGet logs of the webhooks.<br><br>By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.<br><br>

Authentication

  • POSTGenerate a jwt manage token/admin/jwtThis endpoint generates a new jwt manage token. It requires an admin manage token to be used<br><br>
  • POSTCreate a new anonymous user/auth/initThis endpoint creates a new temporary token related to a new anonymous user.<br><br>It will expire 30 minutes after.<br><br>Note: if you supply client_id and…
  • POSTGenerate a user jwt token/auth/jwtThis endpoint generates a new jwt token for the user. This token will last the time in minutes given by the config key auth.default_token_expire (permanent if…
  • POSTGet a new access token given an user id and client credentials/auth/renew
  • DELETERemove user access/auth/tokenThis endpoint removes the token in use.<br><br>
  • POSTTransform a temporary code to a access_token/auth/token/accessIn order to register a new user with the OAuth 2 process, the client has to call this endpoint to request a granted access_token with the received temporary…
  • GETGenerate a user temporary token/auth/token/codeThis endpoint generates a new temporary token for the user.<br><br>In case the access_token is used by a trusted device, and you want to let another one (for…
  • GETGet the latest certificate of a type/certificate/:type?expand=string
  • DELETEDelete the user/users/:id_user?expand=stringThis endpoint deletes the user.<br><br>
  • GETFirst step to establish an oAuth2 connection./webauthThe route encapsulate 2 functionalities: 1. Create or update a connection through oAuth2 session.<br><br>2. Execute a transfer through OAuth2 session.

Banks

  • GETGet account types/account_types?expand=string
  • GETGet an account type/account_types/:id_account_type?expand=string
  • POSTCreate bank categories/banks/categories?expand=stringIt requires the name of the category to be created<br><br>
  • POSTEdit a bank categories/banks/categories/:id_category?expand=stringEdit the name for the supplied category.<br><br>
  • DELETEDelete the supplied category/banks/categories/:id_category?expand=string
  • GETGet a subset of id_connection for a given bank. Different selection methode are possible/banks/:id_connector/connections?method=string&n=0&type=0&occurences=0&source=string&minutes_without_sync=0&expand=stringBy default, it selects a set of 3 connections with the 'diversity' method<br><br>
  • GETGet all links to the files associated with this connector./banks/:id_connector/logos?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet all links to the files associated with this connector./banks/:id_connector/logos/main?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet all links to the files associated with this connector./banks/:id_connector/logos/thumbnail?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet all categories/categories?expand=stringRessource to get all existing categories<br><br>
  • POSTAdd a new keyword associated with a category in the database./categories/keywords?expand=stringIf the keyword already exists the keyword is not added. Used for the categorization of transactions.<br><br>Form params: - id_category (integer): a reference…
  • DELETEDelete a particular key-value pair on a transaction./categories/keywords/:id_keyword?expand=string
  • POSTcategorize transactions without storing them/categorizeIt requires an array of transaction dictionaries. Any fields of transactions that are not required will be kept in the response. The response contains the…
  • PUTEnable/disable several connectors/connectors?expand=string
  • PUTEdit the provided connector/connectors/:id_connector?expand=string<br><br>
  • GETGet all links to the files associated with this connector./connectors/:id_connector/logos?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • PUTCreate or Update a connector Logo/connectors/:id_connector/logos?expand=stringThis endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider…
  • POSTCreate a connector Logo/connectors/:id_connector/logos?expand=stringThis endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a…
  • GETGet all links to the files associated with this connector./connectors/:id_connector/logos/main?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet all links to the files associated with this connector./connectors/:id_connector/logos/thumbnail?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • PUTCreate or Update a connector Logo./connectors/:id_connector/logos/:id_logo?expand=stringThis endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider…
  • DELETEDelete a single Logo object./connectors/:id_connector/logos/:id_logo?expand=string
  • GETGet invoicing data for a given period (default is the current month)./invoicing?min_date=2024-01-01&max_date=2024-01-01&users_synced=string&users_bank=string&users_bill=string&accounts_synced=string&subscriptions_synced=string&connections_synced=string&connections_account=string&transfers_synced=string&payments_synced=string&all=string&detail=stringYou can get all the invoicing data or just specific ones by using the available parameters.<br><br>If no parameters are specified, no invoicing data is…
  • GETGet a random subset of provider's id_connection/providers/:id_connector/connections?range=0&expand=stringBy default, it selects a set of 3 connections.<br><br>
  • GETGet all links to the files associated with this connector./providers/:id_connector/logos?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet all links to the files associated with this connector./providers/:id_connector/logos/main?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet all links to the files associated with this connector./providers/:id_connector/logos/thumbnail?expand=stringThis endpoint returns all links to files associated with this connector.<br><br>
  • GETGet details on all psd2 registrations/psd2-registrations?expand=string
  • GETGet details for a given psd2 registration/psd2-registrations/:id_psd2-registration?expand=string
  • GETGet psd2 registration logs./psd2-registrations/:id_psd2registration/logs?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&expand=stringGet logs of psd2 registration. By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.<br><br>
  • GETGet account types/users/:id_user/account_types?expand=string
  • GETGet an account type/users/:id_user/account_types/:id_account_type?expand=string
  • GETGet the category/users/:id_user/accounts/:id_account/categoriesRessource to get categories for the user's transactions<br><br>
  • GETGet clustered transactions/users/:id_user/accounts/:id_account/transactionsclusters?expand=string
  • POSTCreate clustered transaction/users/:id_user/accounts/:id_account/transactionsclusters?expand=stringForm params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction…
  • PUTEdit a clustered transaction/users/:id_user/accounts/:id_account/transactionsclusters/:id_transactionscluster?expand=stringForm params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related…
  • DELETEDelete a clustered transaction/users/:id_user/accounts/:id_account/transactionsclusters/:id_transactionscluster?expand=string
  • GETGet alerts/users/:id_user/alerts?expand=string
  • GETGet the category/users/:id_user/categoriesRessource to get categories for the user's transactions<br><br>
  • GETGet the category/users/:id_user/categories/full?expand=stringRessource to get categories<br><br>
  • POSTCreate a new transaction category/users/:id_user/categories/full?expand=string
  • PUTModify a user-created category/users/:id_user/categories/full/:id_full?expand=string
  • DELETEDelete a user-created transaction category/users/:id_user/categories/full/:id_full?expand=string
  • GETGet accounts list./users/:id_user/connections/:id_connection/accounts?expand=string
  • PUTUpdate many accounts at once/users/:id_user/connections/:id_connection/accounts?expand=string
  • POSTCreate an account/users/:id_user/connections/:id_connection/accounts?expand=stringThis endpoint creates an account related to a connection or not.<br><br>
  • DELETEDelete all accounts/users/:id_user/connections/:id_connection/accounts?expand=string
  • PUTUpdate an account/users/:id_user/connections/:id_connection/accounts/:id_account?expand=stringIt updates a specific account<br><br>
  • DELETEDelete an account./users/:id_user/connections/:id_connection/accounts/:id_account?expand=stringIt deletes a specific account.<br><br>
  • GETGet the category/users/:id_user/connections/:id_connection/accounts/:id_account/categoriesRessource to get categories for the user's transactions<br><br>
  • GETGet deltas of accounts/users/:id_user/connections/:id_connection/accounts/:id_account/delta?min_date=2024-01-01&max_date=2024-01-01&period=stringGet account delta between sums of transactions and difference of account balance for the given period.<br><br>
  • GETGet accounts logs./users/:id_user/connections/:id_connection/accounts/:id_account/logs?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&expand=stringGet logs of account. By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.<br><br>
  • GETGet account sources/users/:id_user/connections/:id_connection/accounts/:id_account/sources?expand=string
  • GETGet transactions/users/:id_user/connections/:id_connection/accounts/:id_account/transactions?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&income=true&deleted=true&all=true&last_update=2024-01-01T00:00:00Z&wording=string&min_value=0.0&max_value=0.0&search=string&value=string&id_category=0&expand=stringGet list of transactions.<br><br>By default, it selects transactions for the last month. You can use "min_date" and "max_date" to change boundary dates.<br><br>
  • POSTCreate transactions/users/:id_user/connections/:id_connection/accounts/:id_account/transactions?expand=stringCreate transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction…
  • DELETEDelete transactions/users/:id_user/connections/:id_connection/accounts/:id_account/transactions?expand=string
  • PUTEdit a transaction meta-data/users/:id_user/connections/:id_connection/accounts/:id_account/transactions/:id_transaction?expand=string
  • GETList all arbitrary key-value pairs on a transaction/users/:id_user/connections/:id_connection/accounts/:id_account/transactions/:id_transaction/informations?expand=string
  • PUTAdd or edit transaction arbitrary key-value pairs/users/:id_user/connections/:id_connection/accounts/:id_account/transactions/:id_transaction/informations?expand=string
  • DELETEDelete all arbitrary key-value pairs of a transaction/users/:id_user/connections/:id_connection/accounts/:id_account/transactions/:id_transaction/informations?expand=string
  • GETGet a particular arbitrary key-value pair on a transaction/users/:id_user/connections/:id_connection/accounts/:id_account/transactions/:id_transaction/informations/:id_information?expand=string
  • DELETEDelete a particular key-value pair on a transaction./users/:id_user/connections/:id_connection/accounts/:id_account/transactions/:id_transaction/informations/:id_information?expand=string
  • GETGet clustered transactions/users/:id_user/connections/:id_connection/accounts/:id_account/transactionsclusters?expand=string
  • POSTCreate clustered transaction/users/:id_user/connections/:id_connection/accounts/:id_account/transactionsclusters?expand=stringForm params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction…
  • PUTEdit a clustered transaction/users/:id_user/connections/:id_connection/accounts/:id_account/transactionsclusters/:id_transactionscluster?expand=stringForm params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related…
  • DELETEDelete a clustered transaction/users/:id_user/connections/:id_connection/accounts/:id_account/transactionsclusters/:id_transactionscluster?expand=string
  • GETGet clustered transactions/users/:id_user/connections/:id_connection/transactionsclusters?expand=string
  • POSTCreate clustered transaction/users/:id_user/connections/:id_connection/transactionsclusters?expand=stringForm params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction…
  • PUTEdit a clustered transaction/users/:id_user/connections/:id_connection/transactionsclusters/:id_transactionscluster?expand=stringForm params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related…
  • DELETEDelete a clustered transaction/users/:id_user/connections/:id_connection/transactionsclusters/:id_transactionscluster?expand=string
  • GETGet forecast/users/:id_user/forecast
  • GETGet clustered transactions/users/:id_user/transactionsclusters?expand=string
  • POSTCreate clustered transaction/users/:id_user/transactionsclusters?expand=stringForm params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction…
  • PUTEdit a clustered transaction/users/:id_user/transactionsclusters/:id_transactionscluster?expand=stringForm params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related…
  • DELETEDelete a clustered transaction/users/:id_user/transactionsclusters/:id_transactionscluster?expand=string

Connections

  • GETGet list of connectors/banks?expand=string
  • GETGet a connector/banks/:id_bank?expand=string
  • GETGet list of connector sources/banks/:id_connector/sources?expand=string
  • GETGet fields specific to a domain and a source/banks/:id_connector/sources/:id_connector_source/fields?expand=string
  • GETGet the connector source/banks/:id_connector/sources/:id_source?expand=string
  • GETGet connections without a user/connections?expand=string
  • GETGet connection logs/connections/:id_connection/logs?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&period=string&id_user=0&id_connection=0&id_connector=0&connector_uuid=string&error=string&id_source=0&id_max=0&expand=stringGet logs about connections.<br><br>
  • GETGet connection sources/connections/:id_connection/sources?expand=string
  • PUTUpdate connection source/connections/:id_connection/sources/:id_source?background=true&expand=stringThis endpoint is used to enable a source or force a synchronization on it.<br><br>
  • POST"/connections/:id_connection/sources/:id_source?background=true&expand=stringThis endpoint is used to enable a source or force a synchronization on it.<br><br>
  • DELETEDisable a connection source/connections/:id_connection/sources/:id_source?expand=stringThis will make it so the specified source will not be synchronized anymore.<br><br>
  • GETGet list of connectors/connectors?expand=string
  • POSTRequest a new connector/connectors?expand=stringSend a request to add a new connector<br><br>
  • GETGet a connector/connectors/:id_connector?expand=string
  • GETGet list of connector sources/connectors/:id_connector/sources?expand=string
  • PUTEdit several connector sources/connectors/:id_connector/sources?expand=string
  • GETGet fields specific to a domain and a source/connectors/:id_connector/sources/:id_connector_source/fields?expand=string
  • GETGet the connector source/connectors/:id_connector/sources/:id_source?expand=string
  • PUTEdit the provided connector source/connectors/:id_connector/sources/:id_source?expand=string
  • GETGet connection logs/logs?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&period=string&id_user=0&id_connection=0&id_connector=0&connector_uuid=string&error=string&id_source=0&id_max=0&expand=stringGet logs about connections.<br><br>
  • GETGet list of connectors/providers?expand=string
  • GETGet list of connector sources/providers/:id_connector/sources?expand=string
  • GETGet fields specific to a domain and a source/providers/:id_connector/sources/:id_connector_source/fields?expand=string
  • GETGet the connector source/providers/:id_connector/sources/:id_source?expand=string
  • GETGet a connector/providers/:id_provider?expand=string
  • GETGet connections/users/:id_user/connections?expand=string
  • POSTAdd a new connection./users/:id_user/connections?source=string&expand=stringCreate a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).<br><br>
  • DELETEDelete all connections/users/:id_user/connections?expand=string
  • PUTForce synchronisation of a connection./users/:id_user/connections/:id_connection?last_update=2024-01-01T00:00:00Z&background=true&psu_requested=true&expand=stringWe suggest to pass parameter expand=accounts[transactions] to get all *new* and *updated* transactions.<br><br>
  • POSTUpdate a connection./users/:id_user/connections/:id_connection?background=true&psu_requested=true&refresh_psd2_auth=true&expand=stringGive new parameters to change on the configuration of this connection (for example "password").<br><br>It tests connection to website, and if it fails, a 400…
  • DELETEDelete a connection./users/:id_user/connections/:id_connection?expand=stringThis endpoint deletes a connection and all related accounts and transactions.<br><br>
  • GETGet connection additionnal informations/users/:id_user/connections/:id_connection/informations?expand=string<br><br>
  • GETGet connection logs/users/:id_user/connections/:id_connection/logs?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&period=string&id_user=0&id_connection=0&id_connector=0&connector_uuid=string&error=string&id_source=0&id_max=0&expand=stringGet logs about connections.<br><br>
  • GETGet connection sources/users/:id_user/connections/:id_connection/sources?expand=string
  • PUTUpdate connection source/users/:id_user/connections/:id_connection/sources/:id_source?background=true&expand=stringThis endpoint is used to enable a source or force a synchronization on it.<br><br>
  • POST"/users/:id_user/connections/:id_connection/sources/:id_source?background=true&expand=stringThis endpoint is used to enable a source or force a synchronization on it.<br><br>
  • DELETEDisable a connection source/users/:id_user/connections/:id_connection/sources/:id_source?expand=stringThis will make it so the specified source will not be synchronized anymore.<br><br>
  • GETGet connection logs/users/:id_user/logs?limit=0&offset=0&min_date=2024-01-01&max_date=2024-01-01&period=string&id_user=0&id_connection=0&id_connector=0&connector_uuid=string&error=string&id_source=0&id_max=0&expand=stringGet logs about connections.<br><br>

PFM

  • POSTLogin to API with credentials/auth/tokenRequest a new user token by giving an username and a password. Or a manage payment token by giving a client<br><br><br><br>

Timeline

  • GETGet incidents logs./incidents?state=string&id=0&weboob_id=string&start_date=string&end_date=string&page=0&size=0By default, provide all incidents. Results are paginated. Some filters can be set via query parameters.<br><br>

Users management

  • GETGet users/users?search=string&expand=string
  • GETGet a user/users/:id_user?expand=string
  • GETGet configuration of a user./users/:id_user/config<br><br>
  • POSTChange configuration of a user. modifications on keys prefixed by 'biapi.' (except callback_url) are ignored/users/:id_user/config
  • DELETEDelete the given user configurations. deletions on keys prefixed by 'biapi.' (except callback_url) are ignored/users/:id_user/configkeys (string): list of coma separated keys to be deleted.<br><br>
  • GETGet profiles/users/:id_user/profiles?expand=string
  • GETGet the main profile/users/:id_user/profiles/main?expand=string
  • GETGet a profile/users/:id_user/profiles/:id_profile?expand=string
  • POSTCreate a token/users/:id_user/tokenCreate an access_token for this user and get it.<br><br>

API details

Authentication
None declared in the description
Operations
167 operations on 110 pathsGET 82POST 36DELETE 28PUT 21
Main resources
Banks 113Providers 48Connections 40Administration 33Authentication 12Users management 10PFM 7Timeline 1Transfer 1
Response formats
application/json access_token jwt_token payload
Description format
OpenAPI 3.0.0, API version 2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Budgea API Documentation in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Budgea API Documentation collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List clients” (GET /clients?expand=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Budgea API Documentation?

Budgea Development Guides Welcome to Budgea's documentation. This documentation is intended to get you up-and-running with our APIs and advise on the… It is listed under Finance & banking and has 167 endpoints.

Who publishes the Budgea API Documentation?

It is listed from Biapi's public API description (an OpenAPI document), not published by Biapi on Swastik Codes. Anyone who controls biapi.pro can claim the profile by adding a DNS TXT record.

How do I authenticate with the Budgea API Documentation?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Budgea API Documentation have?

167 operations on 110 paths (82 GET, 36 POST, 28 DELETE, 21 PUT). The largest groups are Banks, Providers, Connections, Administration.

Is forking the Budgea API Documentation free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.