v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Enrollments (Brazil)

List enrollments

▶️ Usage

With the List Enrollments method, you can:

(Recommended) List enrollments related to a specific CPF (using the customer__identifier query parameter).
List enrollments related to a specific customer.id and institution.id (using the customer and institution query parameters).
List enrollments according to a specific status (using the status query parameter).
[Not Recommended] List all enrollements related to your Belvo account (without using any query parameters).

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

get/payments/br/enrollments/

Query parameters

customer__identifierstring

The CPF of the customer you want to get results for.

customerstring uuid

Example:24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d

The customer.id you want to get results for.

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"
]

institutionstring

Example:planet_mx_retail

Return results only for this institution (use the Belvo-designated name, such as planet_mx_employment).

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

statusstring

Example:PENDING

Return enrollments with the given status. Can be either:

PENDING
SUCCEEDED
CANCELED
FAILED

status__instring[]

Return enrollments with these statuses:

PENDING
SUCCEEDED
CANCELED
FAILED

[
  "PENDING"
]

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": "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0",
      "created_by": "dbdce1e9-d089-4b7d-804b-51dd07748202",
      "created_at": "2024-11-26T11:20:57.389056Z",
      "updated_at": "2024-11-26T11:20:57.389058Z",
      "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
      "type": "open_finance_biometric_pix",
      "status": "PENDING",
      "status_reason_code": "biometric_registration_failed",
      "status_reason_message": "Enrollment rejected because the biometric registration was not completed successfully within the allowed time.",
      "details": {
        "status": "AWAITING_ACCOUNT_HOLDER_VALIDATION",
        "customer": "c860809f-e96d-4d50-9588-f40ffab77302",
        "institution": "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0",
        "platform": "ANDROID",
        "name": "600f1b4a-Mobile",
        "callback_url": "https://example.com/enrollment-in-progress",
        "redirect_url": "https://www.acmecorp.com/checkout/3487321",
        "risk_signals": "******",
        "expires_at": "2026-12-26T11:20:57.389056Z"
      },
      "metadata": {
        "internal_reference_id": "GGq73487w2"
      }
    }
  ]
}