# Obter detalhes sobre uma inscrição

Obtenha detalhes sobre um registro específico de dispositivo.

Endpoint: GET /payments/br/enrollments/{enrollment_id}/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `enrollment_id` (string, required)
    O enrollment.id para o qual você deseja obter detalhes.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Response 200 fields (application/json):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `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 400 fields (application/json):

  - `code` (string, required)
    Um código de erro único (null, does_not_exist, required, already_registered, invalid_choice, max_length, min_length, blank, null, cancellation_error, idempotency_key_invalid) que permite classificar e tratar o erro de forma programática.
    Example: "required"

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

A descrição pode ser (entre outras):

  - Este campo é obrigatório.
  - Objeto com nome=narnia não existe.
  - Este campo não pode ser nulo.
  - Este campo não pode estar em branco.
  - Este cliente já está registrado.
  - Certifique-se de que este campo tenha pelo menos 2 caracteres.
  - Certifique-se de que este campo não tenha mais de 4 caracteres.
  - O valor inserido não é válido.
  - Você deve definir todos os campos obrigatórios: username, password, username_type.
  - Payment Intent não pode ser cancelado porque não está SCHEDULED.
  - Payment Intent não pode ser cancelado pois o horário limite (23:59:00) já passou.
  - A chave de idempotência fornecida é inválida.
    Example: "This field is required."

  - `request_id` (string, required)
    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"

  - `field` (string,null)
    Nome do campo onde o erro foi encontrado.

> Nota: Este campo só está presente quando o erro está relacionado a um campo específico.
    Example: "institution"

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