# Liste todas as instituições de pagamento

Liste todas as instituições de pagamento disponíveis.

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

## Query parameters:

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

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

  - `name` (string)
    Retorne uma instituição com este nome designado pela Belvo.

Nota:

Este filtro suporta consultas de pesquisa completas e parciais, com um mínimo de três caracteres necessários.

Por exemplo, ao pesquisar por itau, os seguintes valores podem ser correspondidos:

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

  - `institution_type` (string)
    Retorne resultados apenas para este tipo de instituição. Pode ser INDIVIDUAL ou BUSINESS.
    Enum: "INDIVIDUAL", "BUSINESS"

  - `id__in` (array)
    Retorne informações para esses ids de instituição.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908&page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Array de objetos de instituição.

  - `results.id` (string, required)
    ID único do Belvo para referenciar a instituição.
    Example: "bbaceead-7b96-46d8-9354-38dec9707004"

  - `results.code` (string)
    O código ISPB da instituição.
    Example: "12345678"

  - `results.active` (boolean, required)
    Indica se esta instituição está disponível para uso ou não.
    Example: true

  - `results.institution_type` (string)
    O tipo de instituição. Pode ser BUSINESS ou INDIVIDUAL.
    Enum: "BUSINESS", "INDIVIDUAL"

  - `results.name` (string, required)
    O nome da instituição, conforme designado pela Belvo.
    Example: "wakanda_national"

  - `results.display_name` (string, required)
    O nome da instituição voltado para o cliente.
    Example: "Wakanda National Bank"

  - `results.legal_entity_name` (string,null, required)
    O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI.
    Example: "Wakanda Bank, National Association"

  - `results.website` (string, required)
    A URL do site da instituição.
    Example: "https://www.wakandanational.com"

  - `results.logo` (string, required)
    A URL do logotipo da instituição.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg"

  - `results.icon_logo` (string, required)
    A URL do logotipo do ícone da instituição.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg"

  - `results.text_logo` (string, required)
    A URL do logotipo de texto da instituição.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg"

  - `results.primary_color` (string, required)
    A cor primária no site da instituição.
    Example: "#fdbc24"

  - `results.country` (string, required)
    O país onde a instituição está localizada. Para o Brasil, isso é sempre definido como BRA.
    Example: "BRA"

  - `results.form_fields` (array,null, required)
    Este campo não é aplicável para OFPI e retornará um array vazio.
    Example: []

  - `results.sort_priority` (integer, required)
    Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto.
    Example: 1

  - `results.description` (string,null, required)
    Uma breve descrição da instituição.
    Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America."

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

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

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - 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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"