### Belvo API - Get List all institutions

Source: https://developers.belvo.com/products/employments_mexico/prerequisites-get-started-in-10-minutes

This API endpoint retrieves a list of all available institutions that Belvo supports for data aggregation. It is used to verify your API key and Postman environment setup. Ensure your Postman environment is set to 'Belvo - sandbox (xxx)' before sending the request.

```APIDOC
Belvo API Docs -> Core Aggregation Resources -> Institutions -> Get List all institutions

Method: GET

Request:
- Ensure the correct Postman environment (e.g., 'Belvo - sandbox (xxx)') is selected.
- Click 'Send'.

Response:
- On success, returns a JSON array of institution objects, each containing details like ID, name, country, and type.
- Example successful response snippet:
```json
[
  {
    "id": "institutions_uuid_1",
    "name": "Example Bank A",
    "country": "XX",
    "type": "bank"
  },
  {
    "id": "institutions_uuid_2",
    "name": "Example Bank B",
    "country": "YY",
    "type": "bank"
  }
]
```

Error Conditions:
- 401 Unauthorized: Invalid or missing API keys.
- 404 Not Found: If the endpoint path is incorrect (unlikely via Postman collection).
```

--------------------------------

### Monitor Consent Status Example Response

Source: https://developers.belvo.com/products/payments_mexico/direct-debit-direct-api-setup

An example JSON response from a GET request to check the status of a Direct Debit Consent, showing the current state of the consent.

```JSON
{
  "consentId": "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c",
  "status": "submitted",
  "paymentMethodId": "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c",
  "isBankNotified": false
}
```

--------------------------------

### Example Startup Query String

Source: https://developers.belvo.com/docs/hosted-widget-ofda

An extended URL example demonstrating additional configuration parameters for the hosted widget, such as integration type, institution details, and access mode.

```URL
https://widget.belvo.io/
	?access_token={access_code}
	&locale=pt
	&mode=webapp
	&integration_type=openfinance
	&institution_types=retail
	&institutions=ofbradesco_br_retail
	&country_codes=BR
	&access_mode=recurrent
	&external_id=HJLSI-897809
	&resources=OWNERS,ACCOUNTS
```

--------------------------------

### Start Belvo Widget with Callbacks

Source: https://developers.belvo.com/developer_resources/web-widget-for-web

This snippet demonstrates how to initiate the Belvo Connect widget. It includes functions for handling successful links, user exits, and general events. It also shows how to retrieve an access token from a server endpoint and then build the widget.

```javascript
// Code to be included within your <script type="text/javascript">

function successCallbackFunction(link, institution) {
	// Do something with the link and institution,
	// such as associate it with your registered user in your database.
}

function onExitCallbackFunction(data) {
	// Do something with the exit data.
}

function onEventCallbackFunction(data) {
	// Do something with the event data.
}

// Function to call your server-side to generate the access_token and retrieve the your access token
function getAccessToken () {
  // Make sure to change /get-access-token to point to your server-side.
  return fetch('/get-access-token', { method: 'GET' })
    .then(response => response.json())
    .then((data) => data.access)
    .catch(error => console.error('Error:', error))
}

function openBelvoWidget(accessToken) {
	belvoSDK.createWidget(accessToken, {

		// Add your startup configuration here.

		callback: (link, institution) => successCallbackFunction(link, institution),

	}).build();
}

getAccessToken().then(openBelvoWidget) // Once the access token is retrieved, the widget is started.

```

--------------------------------

### Start Belvo Widget with Callbacks

Source: https://developers.belvo.com/docs/connect-widget

This snippet demonstrates how to initiate the Belvo Connect widget. It includes functions for handling successful links, user exits, and general events. It also shows how to retrieve an access token from a server endpoint and then build the widget.

```javascript
// Code to be included within your <script type="text/javascript">

function successCallbackFunction(link, institution) {
	// Do something with the link and institution,
	// such as associate it with your registered user in your database.
}

function onExitCallbackFunction(data) {
	// Do something with the exit data.
}

function onEventCallbackFunction(data) {
	// Do something with the event data.
}

// Function to call your server-side to generate the access_token and retrieve the your access token
function getAccessToken () {
  // Make sure to change /get-access-token to point to your server-side.
  return fetch('/get-access-token', { method: 'GET' })
    .then(response => response.json())
    .then((data) => data.access)
    .catch(error => console.error('Error:', error))
}

function openBelvoWidget(accessToken) {
	belvoSDK.createWidget(accessToken, {

		// Add your startup configuration here.

		callback: (link, institution) => successCallbackFunction(link, institution),

	}).build();
}

getAccessToken().then(openBelvoWidget) // Once the access token is retrieved, the widget is started.

```

--------------------------------

### Belvo API Pagination Example

Source: https://developers.belvo.com/docs/searching-and-filtering

Demonstrates how to make a paginated GET request to the Belvo API using `curl`. It shows the initial request with `page_size` and the subsequent response containing navigation links.

```curl
curl --request GET \
     --url 'https://sandbox.belvo.com/api/transactions/?link=link_id&page_size=1000' \
     --header 'accept: application/json'
```

--------------------------------

### Fork Belvo Postman Collection

Source: https://developers.belvo.com/products/employments_mexico/prerequisites-get-started-in-10-minutes

Instructions and link to fork the official Belvo Postman collection into your workspace. This action automatically sets up your Postman environment with necessary credentials and base URLs for interacting with the Belvo API.

```Postman
https://app.getpostman.com/run-collection/14658306-af823740-067a-410a-8c71-b75166c08dc8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D14658306-af823740-067a-410a-8c71-b75166c08dc8%26entityType%3Dcollection%26workspaceId%3D0bde4a5f-99cd-4338-bd44-81289fa974e0
```

--------------------------------

### Belvo API Pagination Example

Source: https://developers.belvo.com/docs/belvo-pagination-tips

Demonstrates how to make a paginated GET request to the Belvo API using `curl`. It shows the initial request with `page_size` and the subsequent response containing navigation links.

```curl
curl --request GET \
     --url 'https://sandbox.belvo.com/api/transactions/?link=link_id&page_size=1000' \
     --header 'accept: application/json'
```

--------------------------------

### Belvo API Pagination Example

Source: https://developers.belvo.com/developer_resources/resources-pagination-and-filtering

Demonstrates how to make a paginated GET request to the Belvo API using `curl`. It shows the initial request with `page_size` and the subsequent response containing navigation links.

```curl
curl --request GET \
     --url 'https://sandbox.belvo.com/api/transactions/?link=link_id&page_size=1000' \
     --header 'accept: application/json'
```

--------------------------------

### Load Belvo SDK and Create Widget

Source: https://developers.belvo.com/developer_resources/web-widget-for-web

This example shows how to dynamically load the Belvo SDK script and then create the widget. It defines callback functions and retrieves an access token from a specified local server endpoint before building the widget.

```javascript
// Insert the following code after AppComponent() class from Step 1.
async function createWidget() {
	// Function to call your server-side to generate the access_token and retrieve the your access token
	function getAccessToken() {
		// Make sure to change /get-access-token to point to your server-side.
		return fetch('http://localhost:3001/auth/token', {
				method: 'GET'
			})
			.then(response => response.json())
			.then((data) => data)
			.catch(error => console.error('Error:', error))
	}
	const successCallbackFunction = (link, institution) => {
		// Do something with the link and institution,
		// such as associate it with your registered user in your database.
	}
	const onExitCallbackFunction = (data) => {
		// Do something with the exit data.
	}
	const onEventCallbackFunction = (data) => {
		// Do something with the exit data.
	}

	const config = {

		// Add your startup configuration here.

		callback: (link, institution) => successCallbackFunction(link, institution),
		onExit: (data) => onExitCallbackFunction(),
		onEvent: (data) => onEventCallbackFunction()
	}
	const { access } = await getAccessToken();
	// @ts-ignore
	window.belvoSDK.createWidget(access, config).build();
}

function loadScript(src: string) {
	let node = document.createElement('script');
	node.src = src;
	node.type = 'text/javascript';
	node.async = true;
	// Assign the callback which will create the Widget
	node.onload = createWidget;
	document.getElementsByTagName('head')[0].appendChild(node);
}

```

--------------------------------

### Load Belvo Widget Script and Handle Events

Source: https://developers.belvo.com/developer_resources/web-widget-for-web

Demonstrates how to dynamically load the Belvo SDK script and set up an event handler for widget interactions. Includes script creation, source assignment, and callback assignment for widget creation.

```javascript
const { access } = await getAccessToken();
window.belvoSDK.createWidget(access, config).build()
},
loadScript(src) {
	const node = document.createElement('script');
	node.src = src;
	node.type = 'text/javascript';
	node.async = true;
	// Assign the callback which will create the Widget
	node.onload = this.createWidget;
	// Add script to document body
	document.body.appendChild(node);
}
```

--------------------------------

### Get Link Details - R Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using R, demonstrating an HTTP GET request.

```r
# R example for fetching link details would go here.
```

--------------------------------

### Load Belvo SDK and Create Widget

Source: https://developers.belvo.com/docs/connect-widget

This example shows how to dynamically load the Belvo SDK script and then create the widget. It defines callback functions and retrieves an access token from a specified local server endpoint before building the widget.

```javascript
// Insert the following code after AppComponent() class from Step 1.
async function createWidget() {
	// Function to call your server-side to generate the access_token and retrieve the your access token
	function getAccessToken() {
		// Make sure to change /get-access-token to point to your server-side.
		return fetch('http://localhost:3001/auth/token', {
				method: 'GET'
			})
			.then(response => response.json())
			.then((data) => data)
			.catch(error => console.error('Error:', error))
	}
	const successCallbackFunction = (link, institution) => {
		// Do something with the link and institution,
		// such as associate it with your registered user in your database.
	}
	const onExitCallbackFunction = (data) => {
		// Do something with the exit data.
	}
	const onEventCallbackFunction = (data) => {
		// Do something with the exit data.
	}

	const config = {

		// Add your startup configuration here.

		callback: (link, institution) => successCallbackFunction(link, institution),
		onExit: (data) => onExitCallbackFunction(),
		onEvent: (data) => onEventCallbackFunction()
	}
	const { access } = await getAccessToken();
	// @ts-ignore
	window.belvoSDK.createWidget(access, config).build();
}

function loadScript(src: string) {
	let node = document.createElement('script');
	node.src = src;
	node.type = 'text/javascript';
	node.async = true;
	// Assign the callback which will create the Widget
	node.onload = createWidget;
	document.getElementsByTagName('head')[0].appendChild(node);
}

```

--------------------------------

### Get Link Details - Ruby Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using Ruby, demonstrating an HTTP GET request.

```ruby
# Ruby example for fetching link details would go here.
```

--------------------------------

### Start Hosted Widget URL Configuration

Source: https://developers.belvo.com/products/fiscal_mexico/hosted-widget-introduction

This describes the structure of the URL used to launch the Belvo hosted widget within a webview. It requires an `access_token` and supports various optional parameters to customize the widget's behavior, appearance, and data fetching.

```APIDOC
Widget URL Structure:
https://widget.belvo.io/

Required Parameter:
- access_token: The access token obtained from the /api/token/ endpoint.

Optional Parameters:
- locale: Language for the widget interface (e.g., 'es', 'en', 'pt').
- institution_types: Filter institutions by type (e.g., 'retail', 'erp').
- institutions: Specify particular institution IDs to display (e.g., 'ofbradesco_br_retail').
- country_codes: Filter institutions by country codes (e.g., 'BR', 'MX').
- access_mode: Type of access (e.g., 'recurrent', 'one-time').
- external_id: A unique identifier for the session or user.
- resources: Resources to fetch after link creation (e.g., 'OWNERS', 'ACCOUNTS').
- integration_type: Specifies the integration flow (e.g., 'openfinance').

Example:
https://widget.belvo.io/
	?access_token={access_code}
  &locale=es
  &institution_types=retail
  &institutions=ofbradesco_br_retail
  &country_codes=BR
  &access_mode=recurrent
  &external_id=HJLSI-897809
  &resources=OWNERS,ACCOUNTS
  &integration_type=openfinance

Note: For a comprehensive list of parameters and implementation details, refer to the 'Startup Configuration' article.
```

--------------------------------

### Get Link Details - Go Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using Go, demonstrating an HTTP GET request.

```go
// Go example for fetching link details would go here.
```

--------------------------------

### Get Link Details - PHP Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using PHP, demonstrating an HTTP GET request.

```php
// PHP example for fetching link details would go here.
```

--------------------------------

### Start Hosted Widget (URL Configuration)

Source: https://developers.belvo.com/products/employments_brazil/hosted-widget-introduction

Initiates the Belvo hosted widget by loading a specific URL in a webview. The URL includes the generated access token and optional configuration parameters like locale, institution types, country codes, access mode, external ID, resources, and integration type.

```URL
https://widget.belvo.io/
	?access_token={access_code}
  &locale=es
  &institution_types=retail
  &institutions=ofbradesco_br_retail
  &country_codes=BR
  &access_mode=recurrent
  &external_id=HJLSI-897809
  &resources=OWNERS,ACCOUNTS
  &integration_type=openfinance
```

--------------------------------

### Configure Widget: Display Institutions by Supported Resources (URL)

Source: https://developers.belvo.com/products/fiscal_mexico/hosted-widget-startup-configuration

Filters institutions based on the Belvo API resources they support. Pass a comma-separated list of resource names (e.g., ACCOUNTS, OWNERS) to the `resources` query parameter. The widget will only display institutions supporting ALL specified resources.

```URL
https://widget.belvo.io/
    ?access_token={access_code}
    &resources=ACCOUNTS,OWNERS,TRANSACTIONS
```

--------------------------------

### Get Link Details - C# Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using C#, demonstrating an HTTP GET request.

```csharp
// C# example for fetching link details would go here.
```

--------------------------------

### Belvo API Introduction and Support

Source: https://developers.belvo.com/apis/belvoopenapispec/section/introduction

Documentation related to the Belvo API introduction, environments, response codes, error handling, and retry policies.

```APIDOC
Introduction:
  - Overview of Belvo's capabilities and API usage.

Data Dictionaries:
  - Provides detailed descriptions of data fields and structures.

Environments:
  - Information on sandbox and production environments.

Sandbox:
  - Details on using the sandbox environment for testing.

Production:
  - Information regarding the production environment.

Response codes:
  - Lists and explains HTTP response codes used by the API.

Error handling:
  - Guidelines on how to handle API errors.

Request identifier:
  - Explanation of the request ID for tracking and debugging.

Error codes and troubleshooting:
  - Comprehensive list of error codes and troubleshooting steps.

Retry policy:
  - Information on the recommended retry policy for API requests.

50x errors:
  - Specific guidance for handling server-side errors.

40x errors:
  - Specific guidance for handling client-side errors.

Deprecated fields:
  - Lists fields and endpoints that are deprecated.

OpenAPI: required and nullable fields:
  - Explains the concepts of required and nullable fields in the OpenAPI specification.
```

--------------------------------

### Get Link Details - Java Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using Java, demonstrating an HTTP GET request.

```java
// Java example for fetching link details would go here.
```

--------------------------------

### Start Hosted Widget URL Configuration

Source: https://developers.belvo.com/products/employments_mexico/hosted-widget-introduction

Constructs the URL to initiate the Belvo hosted widget within a webview. The `access_token` is mandatory, and various optional parameters can be appended to configure the widget's behavior, such as locale, institution types, country codes, access mode, external identifiers, and resources to fetch.

```APIDOC
https://widget.belvo.io/
	?access_token={access_code}
  &locale=es
  &institution_types=retail
  &institutions=ofbradesco_br_retail
  &country_codes=BR
  &access_mode=recurrent
  &external_id=HJLSI-897809
  &resources=OWNERS,ACCOUNTS
  &integration_type=openfinance
```

--------------------------------

### Get Link Details - Python Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using Python, demonstrating an HTTP GET request.

```python
# Python example for fetching link details would go here.
```

--------------------------------

### Get Link Details - JavaScript Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/modifylinkdataretrieval

Example of how to fetch the details of a specific Belvo Link using JavaScript, demonstrating an HTTP GET request.

```javascript
// JavaScript example for fetching link details would go here.
```

--------------------------------

### Belvo API GET /api/links/ Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links

Example of how to make a GET request to the /api/links/ endpoint using curl, demonstrating authentication and basic request structure.

```curl
curl -i -X GET \
  -u <username>:<password> \
  "https://sandbox.belvo.com/api/links/"
```

--------------------------------

### Select Specific Institutions

Source: https://developers.belvo.com/products/employments_mexico/hosted-widget-startup-configuration

Choose to display only specific institutions or start the widget at a particular institution's login page. Accepts a comma-separated list of institution IDs.

```APIDOC
## To display just one institution:
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=erebor_mx_retail

## To display more than on institution:
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=erebor_mx_retail,gringotts_mx_retail
```

--------------------------------

### Belvo API GET /api/links/ Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/registerlink

Example of how to make a GET request to the /api/links/ endpoint using curl, demonstrating authentication and basic request structure.

```curl
curl -i -X GET \
  -u <username>:<password> \
  "https://sandbox.belvo.com/api/links/"
```

--------------------------------

### Belvo API Introduction and Support

Source: https://developers.belvo.com/apis/belvoopenapispec/section/introduction/sandbox

Documentation related to the Belvo API introduction, environments, response codes, error handling, and retry policies.

```APIDOC
Introduction:
  - Overview of Belvo's capabilities and API usage.

Data Dictionaries:
  - Provides detailed descriptions of data fields and structures.

Environments:
  - Information on sandbox and production environments.

Sandbox:
  - Details on using the sandbox environment for testing.

Production:
  - Information regarding the production environment.

Response codes:
  - Lists and explains HTTP response codes used by the API.

Error handling:
  - Guidelines on how to handle API errors.

Request identifier:
  - Explanation of the request ID for tracking and debugging.

Error codes and troubleshooting:
  - Comprehensive list of error codes and troubleshooting steps.

Retry policy:
  - Information on the recommended retry policy for API requests.

50x errors:
  - Specific guidance for handling server-side errors.

40x errors:
  - Specific guidance for handling client-side errors.

Deprecated fields:
  - Lists fields and endpoints that are deprecated.

OpenAPI: required and nullable fields:
  - Explains the concepts of required and nullable fields in the OpenAPI specification.
```

--------------------------------

### Belvo API GET /api/links/ Example

Source: https://developers.belvo.com/apis/belvoopenapispec/links/listlinks

Example of how to make a GET request to the /api/links/ endpoint using curl, demonstrating authentication and basic request structure.

```curl
curl -i -X GET \
  -u <username>:<password> \
  "https://sandbox.belvo.com/api/links/"
```

--------------------------------

### Configure Widget: Display Institutions by Supported Resources (URL)

Source: https://developers.belvo.com/products/employments_brazil/hosted-widget-startup-configuration

Filters institutions based on the Belvo API resources they support. Pass a comma-separated list of resource names (e.g., ACCOUNTS, OWNERS) to the `resources` query parameter. The widget will only display institutions supporting ALL specified resources.

```URL
https://widget.belvo.io/
    ?access_token={access_code}
    &resources=ACCOUNTS,OWNERS,TRANSACTIONS
```

--------------------------------

### Fork Belvo Postman Collection

Source: https://developers.belvo.com/products/fiscal_mexico/prerequisites-get-started-in-10-minutes

Instructions and link to fork the official Belvo Postman collection into your workspace. This action automatically sets up your Postman environment with necessary credentials and base URLs for interacting with the Belvo API.

```Postman
https://app.getpostman.com/run-collection/14658306-af823740-067a-410a-8c71-b75166c08dc8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D14658306-af823740-067a-410a-8c71-b75166c08dc8%26entityType%3Dcollection%26workspaceId%3D0bde4a5f-99cd-4338-bd44-81289fa974e0
```

--------------------------------

### Curl Example: Get Tax Retention

Source: https://developers.belvo.com/apis/belvoopenapispec/tax-retentions/retrievetaxretentions

Example of how to make a GET request to retrieve tax retention details using curl, including authentication and query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/tax-retentions/{id}/?omit=string&fields=string'
```

--------------------------------

### Select Institutions to Display

Source: https://developers.belvo.com/products/aggregation_brazil/ofda-widget-startup-configuration

Choose to pre-select a specific institution or display only a select list of institutions. Defaults to showing all supported institutions. Use 'institution' for a single ID or 'institutions' for multiple.

```APIDOC
https://widget.belvo.io/
    ?access_token={access_code}
    &institution=some_institution_id
```

```APIDOC
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=institution_id_1,institution_id_2
```

--------------------------------

### Curl Example: Get Tax Retention

Source: https://developers.belvo.com/apis/belvoopenapispec/tax-retentions/detailtaxretentions

Example of how to make a GET request to retrieve tax retention details using curl, including authentication and query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/tax-retentions/{id}/?omit=string&fields=string'
```

--------------------------------

### Configure Belvo Hosted Widget URL Parameters

Source: https://developers.belvo.com/products/employments_brazil/hosted-widget-startup-configuration

Examples of configuring the Belvo Hosted Widget URL to customize its behavior. This includes setting the link creation mode, associating an external identifier, and specifying which countries are available for users to select institutions from.

```APIDOC
https://widget.belvo.io/
    ?access_token={access_code}
    &access_mode=single
```

```APIDOC
https://widget.belvo.io/
	?access_token={access_code}
    &external_id=HJLSI-897809
```

```APIDOC
https://widget.belvo.io/
    ?access_token={access_code}
    &country_codes=MX
```

--------------------------------

### Belvo API Bills GET Request Example

Source: https://developers.belvo.com/apis/belvoopenapispec/bills

Example of a cURL command to retrieve bills using a GET request to the Belvo API. Demonstrates authentication and common query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/bills/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&account__in=85b77707-90ef-46fd-9059-5a757f24247a&due_date=2022-05-01&due_date__gt=2022-05-05&due_date__gte=2022-05-05&due_date__lt=2022-05-05&due_date__lte=2022-05-05&due_date__range=2022-05-04&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03'
```

--------------------------------

### Belvo API Bills GET Request Example

Source: https://developers.belvo.com/apis/belvoopenapispec/bills/retrievebills

Example of a cURL command to retrieve bills using a GET request to the Belvo API. Demonstrates authentication and common query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/bills/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&account__in=85b77707-90ef-46fd-9059-5a757f24247a&due_date=2022-05-01&due_date__gt=2022-05-05&due_date__gte=2022-05-05&due_date__lt=2022-05-05&due_date__lte=2022-05-05&due_date__range=2022-05-04&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03'
```

--------------------------------

### Configure Widget: Display Specific Institution Types (URL)

Source: https://developers.belvo.com/products/fiscal_mexico/hosted-widget-startup-configuration

Enables filtering institutions based on their type (e.g., retail, business, fiscal). Pass a comma-separated list of institution types to the `institution_types` query parameter. The widget will then only show institutions matching these types.

```URL
https://widget.belvo.io/
    ?access_token={access_code}
    &institution_types=retail,business
```

--------------------------------

### Belvo API Bills GET Request Example

Source: https://developers.belvo.com/apis/belvoopenapispec/bills/listbills

Example of a cURL command to retrieve bills using a GET request to the Belvo API. Demonstrates authentication and common query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/bills/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&account__in=85b77707-90ef-46fd-9059-5a757f24247a&due_date=2022-05-01&due_date__gt=2022-05-05&due_date__gte=2022-05-05&due_date__lt=2022-05-05&due_date__lte=2022-05-05&due_date__range=2022-05-04&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03'
```

--------------------------------

### Belvo API Introduction and General Information

Source: https://developers.belvo.com/apis/belvoopenapispec/section/introduction/environments

Provides an overview of the Belvo API, including sections on Introduction, Available Information and Payment Methods, Data Dictionaries, Environments, Sandbox, Production, Response Codes, Error Handling, Request Identifiers, Error Codes, Retry Policy, and specific error categories (50x, 40x), deprecated fields, and OpenAPI field specifications.

```APIDOC
API Section: Introduction
  Description: Overview of Belvo's capabilities and how to connect to financial data and enable payments.

API Section: Available Information and Payment Methods
  Description: Details the types of financial data and payment methods accessible via the API.

API Section: Data Dictionaries
  Description: Provides definitions and structures for the data returned by the API.

API Section: Environments
  Description: Information on accessing different API environments (Sandbox, Production).

API Section: Sandbox
  Description: Details on using the Sandbox environment for testing.

API Section: Production
  Description: Information regarding the Production environment for live operations.

API Section: Response codes
  Description: Explains the HTTP status codes returned by the API.

API Section: Error handling
  Description: Guidance on how to handle errors and exceptions.

API Section: Request identifier
  Description: Information on the unique identifier for tracking requests.

API Section: Error codes and troubleshooting
  Description: A catalog of error codes and steps for troubleshooting.

API Section: Retry policy
  Description: Guidelines on implementing retry mechanisms for API requests.

API Section: 50x errors
  Description: Specific handling for server-side errors.

API Section: 40x errors
  Description: Specific handling for client-side errors.

API Section: Deprecated fields
  Description: Lists fields that are no longer recommended for use.

API Section: OpenAPI: required and nullable fields
  Description: Explains how required and nullable fields are defined in the OpenAPI specification.
```

--------------------------------

### Belvo API Bills GET Request Example

Source: https://developers.belvo.com/apis/belvoopenapispec/bills/bill

Example of a cURL command to retrieve bills using a GET request to the Belvo API. Demonstrates authentication and common query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/bills/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&account__in=85b77707-90ef-46fd-9059-5a757f24247a&due_date=2022-05-01&due_date__gt=2022-05-05&due_date__gte=2022-05-05&due_date__lt=2022-05-05&due_date__lte=2022-05-05&due_date__range=2022-05-04&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03'
```

--------------------------------

### Belvo Widget General Configuration Parameters

Source: https://developers.belvo.com/products/employments_mexico/hosted-widget-startup-configuration

Details various configuration options for the Belvo Hosted Widget, including country selection, institution filtering, localization, and disabling interactive elements like the close dialog or abandonment survey.

```APIDOC
country_codes: string[]
  - Specifies which countries to display institutions for in the widget.
  - Example: ["MX", "BR"]

institutions: string[]
  - Filters the displayed institutions to only those provided in the list.
  - Example: ["instituition_id_1", "instituition_id_2"]

institution_types: string[]
  - Filters the displayed institutions based on their type.
  - Example: ["bank", "credit_union"]

locale: string
  - Sets the language of the widget interface.
  - Example: "en", "es", "pt-BR"

show_close_dialog: boolean
  - Disables or enables the exit dialog when the user attempts to close the widget.
  - Default: true (dialog is shown).
  - Example: false

show_abandon_survey: boolean
  - Disables or enables the exit survey shown to users who abandon the widget flow.
  - Default: true (survey is shown).
  - Example: false
```

--------------------------------

### Fork Belvo Postman Collection

Source: https://developers.belvo.com/products/employments_brazil/prerequisites-get-started-in-10-minutes

Instructions and link to fork the official Belvo Postman collection into your workspace. This action automatically sets up your Postman environment with necessary credentials and base URLs for interacting with the Belvo API.

```Postman
https://app.getpostman.com/run-collection/14658306-af823740-067a-410a-8c71-b75166c08dc8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D14658306-af823740-067a-410a-8c71-b75166c08dc8%26entityType%3Dcollection%26workspaceId%3D0bde4a5f-99cd-4338-bd44-81289fa974e0
```

--------------------------------

### Curl Example for Get Investment Transaction

Source: https://developers.belvo.com/apis/belvoopenapispec/investment-transactions-brazil/destroyinvestmenttransactionbrazil

Example cURL command to fetch investment transaction details. It includes the GET method, authentication, the endpoint with a placeholder ID, and optional query parameters for filtering.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/br/investment-transactions/{id}/?omit=string&fields=string'
```

--------------------------------

### Get Investment Details - cURL Example

Source: https://developers.belvo.com/apis/belvoopenapispec/investments-brazil/destroyinvestmentbrazil

Demonstrates how to call the Belvo API to get investment details using cURL. It includes authentication, the GET method, and URL parameters for filtering.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/br/investments/{id}/?omit=string&fields=string'
```

--------------------------------

### Create Widget in Mounted Function

Source: https://developers.belvo.com/developer_resources/web-widget-for-web

This example shows how to integrate the Belvo widget creation within a `mounted()` lifecycle function. It includes fetching an access token and setting up success, exit, and event callbacks for the widget.

```javascript
// Insert the following code after mounted() function from Step 1.
async createWidget() {
		// Function to call your server-side to generate the access_token and retrieve the your access token
		function getAccessToken() {
			// Make sure to change /get-access-token to point to your server-side.
			return fetch('/get-access-token', {
					method: 'GET'
				})
				.then(response => response.json())
				.then((data) => data)
				.catch(error => console.error('Error:', error))
		}
		const successCallbackFunction = (link, institution) => {
			// Do something with the link and institution,
			// such as associate it with your registered user in your database.
		}
		const onExitCallbackFunction = (data) => {
			// Do something with the exit data.
		}
		const onEventCallbackFunction = (data) => {
			// Do something with the exit data.
		}

		const config = {

			// Add your startup configuration here.

			callback: (link, institution) => successCallbackFunction(link, institution),
			onExit: (data) => onExitCallbackFunction(),

```

--------------------------------

### Curl Example: Get Invoice Details

Source: https://developers.belvo.com/apis/belvoopenapispec/invoices-chile/retrieveinvoiceschile

Example of how to fetch invoice details using curl, including authentication and optional query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/cl/invoices/{id}/?omit=string&fields=string'
```

--------------------------------

### Fork Belvo Postman Collection

Source: https://developers.belvo.com/products/aggregation_brazil/prerequisites-get-started-in-10-minutes

Instructions and link to fork the official Belvo Postman collection into your workspace. This action automatically sets up your Postman environment with necessary credentials and base URLs for interacting with the Belvo API.

```Postman
https://app.getpostman.com/run-collection/14658306-af823740-067a-410a-8c71-b75166c08dc8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D14658306-af823740-067a-410a-8c71-b75166c08dc8%26entityType%3Dcollection%26workspaceId%3D0bde4a5f-99cd-4338-bd44-81289fa974e0
```

--------------------------------

### Configure Widget: Display Specific Institutions (URL)

Source: https://developers.belvo.com/products/employments_brazil/hosted-widget-startup-configuration

Allows users to specify which institutions are displayed in the Belvo widget. This is achieved by passing a comma-separated list of institution IDs to the `institutions` query parameter. The widget will then only show these selected institutions.

```URL
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=erebor_mx_retail
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=erebor_mx_retail,gringotts_mx_retail
```

--------------------------------

### Curl Example: Get Invoice Details

Source: https://developers.belvo.com/apis/belvoopenapispec/invoices-chile/detailinvoicechile

Example of how to fetch invoice details using curl, including authentication and optional query parameters.

```curl
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/cl/invoices/{id}/?omit=string&fields=string'
```