v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Payment Institutions (Brazil)

List all payment institutions

List all available payment institutions.

get/payments/br/institutions/

Query parameters

pageinteger

Example:1

A page number within the paginated result set.

page_sizeinteger

Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

namestring

Example:itau

Return an institution with this Belvo-designated name.

Note:

This filter supports both full and partial search queries, with a minimum of three characters required.

For example, searching for itau may match the following values:

itau_unibanco_retail
itau_unibanco_business
itau_retail
itau_business
superdigital_retail
superdigital_business

institution_type'INDIVIDUAL' | 'BUSINESS'

Example:INDIVIDUAL

Return results only for this institution type. Can be either INDIVIDUAL or BUSINESS.

id__instring[]

Return information for these institution ids.

[
  "6b3dea0f-be29-49d1-aabe-1a6d588642e6"
]

Response

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "id": "bbaceead-7b96-46d8-9354-38dec9707004",
      "code": "12345678",
      "active": true,
      "institution_type": "INDIVIDUAL",
      "name": "wakanda_national",
      "display_name": "Wakanda National Bank",
      "legal_entity_name": "Wakanda Bank, National Association",
      "website": "https://www.wakandanational.com",
      "logo": "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg",
      "icon_logo": "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg",
      "text_logo": "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg",
      "primary_color": "#fdbc24",
      "country": "BRA",
      "form_fields": [],
      "sort_priority": 1,
      "description": "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America."
    }
  ]
}