# Enumere todas las instituciones de pago.

Enumere todas las instituciones de pago disponibles.

Endpoint: GET /payments/br/institutions/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `name` (string)
    Devuelve una institución con este nombre designado por Belvo.

Nota:

Este filtro admite consultas de búsqueda tanto completas como parciales, con un mínimo de tres caracteres requeridos.

Por ejemplo, buscar itau puede coincidir con los siguientes valores:

  - itau_unibanco_retail
  - itau_unibanco_business
  - itau_retail
  - itau_business
  - superdigital_retail
  - superdigital_business
    Example: "itau"

  - `institution_type` (string)
    Devuelve resultados solo para este tipo de institución. Puede ser INDIVIDUAL o BUSINESS.
    Enum: "INDIVIDUAL", "BUSINESS"

  - `id__in` (array)
    Devuelve información para estos id de institución.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908&page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de institución.

  - `results.id` (string, required)
    ID único de Belvo para referenciar la institución.
    Example: "bbaceead-7b96-46d8-9354-38dec9707004"

  - `results.code` (string)
    El código ISPB de la institución.
    Example: "12345678"

  - `results.active` (boolean, required)
    Indica si esta institución está disponible para su uso o no.
    Example: true

  - `results.institution_type` (string)
    El tipo de institución. Puede ser BUSINESS o INDIVIDUAL.
    Enum: "BUSINESS", "INDIVIDUAL"

  - `results.name` (string, required)
    El nombre de la institución, según lo designado por Belvo.
    Example: "wakanda_national"

  - `results.display_name` (string, required)
    El nombre de cara al cliente de la institución.
    Example: "Wakanda National Bank"

  - `results.legal_entity_name` (string,null, required)
    El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI.
    Example: "Wakanda Bank, National Association"

  - `results.website` (string, required)
    La URL del sitio web de la institución.
    Example: "https://www.wakandanational.com"

  - `results.logo` (string, required)
    La URL del logotipo de la institución.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg"

  - `results.icon_logo` (string, required)
    La URL del logotipo del icono de la institución.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg"

  - `results.text_logo` (string, required)
    La URL del logotipo de texto de la institución.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg"

  - `results.primary_color` (string, required)
    El color primario en el sitio web de la institución.
    Example: "#fdbc24"

  - `results.country` (string, required)
    El país en el que se encuentra la institución. Para Brasil, esto siempre se establece en BRA.
    Example: "BRA"

  - `results.form_fields` (array,null, required)
    Este campo no es aplicable para OFPI y devolverá un array vacío.
    Example: []

  - `results.sort_priority` (integer, required)
    Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto.
    Example: 1

  - `results.description` (string,null, required)
    Una breve descripción de la institución.
    Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America."

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único (not_found) que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"