v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Customers (Brazil)

List all customers

List all customers associated with your Belvo account.

get/payments/br/customers/

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).

id__instring[]

Return information for these resource ids.

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

created_atstring date

Example:2022-05-05

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

created_at__gtstring date

Example:2022-05-05

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

created_at__gtestring date

Example:2022-05-04

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

created_at__ltstring date

Example:2022-04-01

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

created_at__ltestring date

Example:2022-03-30

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

created_at__rangestring[]

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]

customer__type'INDIVIDUAL' | 'BUSINESS'

Example:INDIVIDUAL

Return results only for this customer type (either INDIVIDUAL or BUSINESS).

external_idstring uuid

Example:295ebb46-65b8-47de-85cd-34ffbc327c09

Return objects with this external ID.

external_id__instring[]

Return objects with these external IDs.

[
  "446bdd9f-5b3e-4c05-9159-7a5c87cfc810"
]

searchstring

Example:trai

Return results that match the description you searched for.

Note:

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

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

Awesome training sneakers
Training equipment

Searching for car may match the following values:

    - `Carlos Vives`
    - `Carmen Domínguez` 
    - `carlos.vives@musicabrazil.br`

Headers

X-Belvo-API-Resource-Version'Payments-BR.V2'

Example:Payments-BR.V2

Header indicating which version of the Payment API you want to use. Currently this is only applicable for Bank Accounts, Customers, and Payment Authorizations in Brazil. In the case that you are using our Payment Authorizations product, then you must send through this header set to Payments-BR.V2.

{% admonition type="warning" name="Coming Soon" %} This version is in Coming Soon. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %}

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": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "updated_at": "2022-02-09T08:45:50.406032Z",
      "name": "Frangos Enlatados",
      "identifier": "12345678901122",
      "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73"
    }
  ]
}