# Listar matrículas

## ▶️ Uso

Com o método List Enrollments, você pode:

1. (Recomendado) Listar inscrições relacionadas a um CPF específico (usando o parâmetro de consulta customer__identifier).
2. Listar inscrições relacionadas a um customer.id e institution.id específicos (usando os parâmetros de consulta customer e institution).
3. Listar inscrições de acordo com um status específico (usando o parâmetro de consulta status).
4. [Não Recomendado] Listar todas as inscrições relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, veja nosso artigo Filtrando respostas.

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados para um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, veja nosso artigo Dicas de Paginação.

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

## Query parameters:

  - `customer__identifier` (string)
    O CPF do cliente para o qual você deseja obter resultados.
    Example: 23100299900

  - `customer` (string)
    O customer.id para o qual você deseja obter resultados.
    Example: "24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d"

  - `external_id` (string)
    Retornar objetos com este ID externo.
    Example: "295ebb46-65b8-47de-85cd-34ffbc327c09"

  - `external_id__in` (array)
    Retorne objetos com esses IDs externos.
    Example: ["446bdd9f-5b3e-4c05-9159-7a5c87cfc810"]

  - `institution` (string)
    Retorne resultados apenas para esta instituição (use o nome designado pela Belvo, como planet_mx_employment).
    Example: "planet_mx_retail"

  - `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

  - `status` (string)
    Retorne as inscrições com o status fornecido. Pode ser:
  - PENDING
  - SUCCEEDED
  - CANCELED
  - FAILED
    Example: "PENDING"

  - `status__in` (array)
    Retornar inscrições com os seguintes status:
  - PENDING
  - SUCCEEDED
  - CANCELED
  - FAILED
    Example: ["PENDING"]

## 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 enrollment.

  - `results.id` (string)
    Identificador único da inscrição da Belvo.
    Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0"

  - `results.created_by` (string)
    O ID Belvo do comerciante que criou a inscrição.
    Example: "dbdce1e9-d089-4b7d-804b-51dd07748202"

  - `results.created_at` (string)
    O carimbo de data/hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2024-11-26T11:20:57.389056Z"

  - `results.updated_at` (string)
    O carimbo de data e hora ISO-8601 de quando a inscrição foi atualizada pela última vez.
    Example: "2024-11-26T11:20:57.389058Z"

  - `results.external_id` (string)
    Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
    Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"

  - `results.type` (string)
    O tipo de inscrição. Para o OFPI do 🇧🇷 Brasil, pode ser:

  - open_finance_biometric_pix: Para pagamentos biométricos usando a rede PIX.
    Enum: "open_finance_biometric_pix"

  - `results.status` (string)
    O status do registro do dispositivo. Pode ser:

- PENDING: O registro está pendente.
- SUCCEEDED: O registro foi bem-sucedido.
- CANCELED: O registro foi cancelado.
- FAILED: O registro falhou.
    Enum: "PENDING", "SUCCEEDED", "CANCELED", "FAILED"

  - `results.status_reason_code` (string,null)
    Um código legível por máquina que fornece o motivo para uma inscrição falhada. Presente apenas quando status é FAILED.

Valores possíveis:
  - send_risk_signals_failed: Inscrição rejeitada devido a tempo esgotado ao enviar sinais de risco.
  - redirection_to_institution_failed: Inscrição rejeitada porque o redirecionamento para a instituição não foi concluído com sucesso.
  - biometric_registration_failed: Inscrição rejeitada porque o registro biométrico não foi concluído com sucesso dentro do tempo permitido.
  - too_many_device_registration_attempts: Inscrição rejeitada devido a muitas tentativas falhas de registro de dispositivo.
  - rejected_by_user: Inscrição foi cancelada manualmente pelo usuário.
  - device_not_supports_biometric_authentication: Inscrição rejeitada porque o dispositivo não é compatível com autenticação biométrica.
  - institution_infra_failed: Inscrição rejeitada devido a problemas de infraestrutura na instituição.
  - blocked_by_institution_security_policy: Inscrição rejeitada devido a decisões da política de segurança da instituição baseadas na avaliação de risco.
  - redirection_back_from_institution_failed: Inscrição rejeitada porque o redirecionamento de volta da instituição não foi concluído com sucesso.
  - biometric_validation_error: Inscrição falhou devido a problemas de validação biométrica ou registro de chave pública.
  - rejected_other: Inscrição rejeitada por um motivo não especificado.
  - canceled_due_to_expiration: Inscrição cancelada devido à expiração do período de validade.
    Example: "biometric_registration_failed"

  - `results.status_reason_message` (string,null)
    Uma mensagem legível por humanos que fornece mais detalhes sobre o motivo de uma inscrição falhada. Presente apenas quando o status é FAILED. Consulte status_reason_code para ver mensagens de exemplo para cada código de motivo.
    Example: "Enrollment rejected because the biometric registration was not completed successfully within the allowed time."

  - `results.details` (object)
    Detalhes sobre a inscrição

  - `results.details.status` (string)
    O status do cadastro de pagamentos biométricos. Pode ser:

  - AWAITING_ACCOUNT_HOLDER_VALIDATION: O titular da conta precisa validar o cadastro enviando seus dados biométricos.
  - AWAITING_ENROLLMENT: As informações de cadastro foram enviadas para a instituição e estão sendo avaliadas.
  - AUTHORIZED: O cadastro foi autorizado.
  - REJECTED: A instituição rejeitou o cadastro.
  - REVOKED: O usuário ou a instituição revogou o cadastro.
    Enum: "AWAITING_ACCOUNT_HOLDER_VALIDATION", "AWAITING_ENROLLMENT", "AUTHORIZED", "REJECTED", "REVOKED"

  - `results.details.customer` (string)
    ID único da Belvo para referenciar o cliente.
    Example: "c860809f-e96d-4d50-9588-f40ffab77302"

  - `results.details.institution` (string)
    ID único da Belvo para referenciar a instituição na qual o dispositivo está registrado.
    Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0"

  - `results.details.platform` (string)
    A plataforma do dispositivo a ser registrado. Pode ser:

  - ANDROID: Para dispositivos Android.
  - BROWSER: Para navegadores web.
  - CROSS_PLATFORM: Para dispositivos multiplataforma.
  - IOS: Para dispositivos iOS.
    Enum: "ANDROID", "BROWSER", "CROSS_PLATFORM", "IOS"

  - `results.details.name` (string,null)
    Um nome interno para este registro de dispositivo.
    Example: "600f1b4a-Mobile"

  - `results.details.callback_url` (string)
    A URL para redirecionar seu usuário após a conclusão do processo de inscrição.
    Example: "https://example.com/enrollment-in-progress"

  - `results.details.redirect_url` (string)
    A URL para redirecionar o usuário para concluir sua inscrição na instituição.
    Example: "https://www.acmecorp.com/checkout/3487321"

  - `results.details.risk_signals` (string)
    Uma string ofuscada () usada para indicar que sinais de risco foram fornecidos.
    Example: "******"

  - `results.details.expires_at` (string)
    O timestamp ISO-8601 de quando a inscrição expirará. Após esse momento, a inscrição não será mais válida e o status será alterado para CANCELED e o status_reason_code será definido como canceled_due_to_expiration.
    Example: "2026-12-26T11:20:57.389056Z"

  - `results.metadata` (object)
    Objeto opcional e personalizável onde você pode fornecer quaisquer pares de chave-valor adicionais para seus propósitos internos. Por exemplo, um número de referência interno para a inscrição.

⚠️ Nota: Você pode fornecer até 50 chaves (as chaves podem ter até 50 caracteres cada e cada valor pode ter até 500 caracteres). Não suportamos objetos aninhados, apenas valores ASCII.
    Example: {"internal_reference_id":"GGq73487w2"}

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