# Listar inscripciones

## ▶️ Uso

Con el método List Enrollments, puedes:

1. (Recomendado) Listar inscripciones relacionadas con un CPF específico (usando el parámetro de consulta customer__identifier).
2. Listar inscripciones relacionadas con un customer.id y institution.id específicos (usando los parámetros de consulta customer e institution).
3. Listar inscripciones según un estado específico (usando el parámetro de consulta status).
4. [No Recomendado] Listar todas las inscripciones relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta).

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

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

## Query parameters:

  - `customer__identifier` (string)
    El CPF del cliente para el que deseas obtener resultados.
    Example: 23100299900

  - `customer` (string)
    El customer.id para el que deseas obtener resultados.
    Example: "24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d"

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

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

  - `institution` (string)
    Devuelve resultados solo para esta institución (usa el nombre designado por Belvo, como planet_mx_employment).
    Example: "planet_mx_retail"

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `status` (string)
    Devuelve las inscripciones con el estado dado. Puede ser uno de los siguientes:
  - PENDING
  - SUCCEEDED
  - CANCELED
  - FAILED
    Example: "PENDING"

  - `status__in` (array)
    Devuelve las inscripciones con estos estados:
  - PENDING
  - SUCCEEDED
  - CANCELED
  - FAILED
    Example: ["PENDING"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908&page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de enrollment.

  - `results.id` (string)
    Identificador único de Belvo de la inscripción.
    Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0"

  - `results.created_by` (string)
    El Belvo ID del comerciante que creó la inscripción.
    Example: "dbdce1e9-d089-4b7d-804b-51dd07748202"

  - `results.created_at` (string)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2024-11-26T11:20:57.389056Z"

  - `results.updated_at` (string)
    La marca de tiempo ISO-8601 de cuándo se actualizó por última vez la inscripción.
    Example: "2024-11-26T11:20:57.389058Z"

  - `results.external_id` (string)
    Un identificador único adicional para el recurso con fines internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para almacenar su propio identificador único para cada recurso (cliente, cuenta bancaria, intención de pago o inscripción). Esto puede ser útil para rastrear el recurso en su sistema y para fines de depuración.
{% /admonition %}
    Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"

  - `results.type` (string)
    El tipo de inscripción. Para la OFPI de 🇧🇷 Brasil, puede ser:

  - open_finance_biometric_pix: Para pagos biométricos utilizando la red PIX.
    Enum: "open_finance_biometric_pix"

  - `results.status` (string)
    El estado de la inscripción del dispositivo. Puede ser:

- PENDING: La inscripción está pendiente.
- SUCCEEDED: La inscripción fue exitosa.
- CANCELED: La inscripción fue cancelada.
- FAILED: La inscripción falló.
    Enum: "PENDING", "SUCCEEDED", "CANCELED", "FAILED"

  - `results.status_reason_code` (string,null)
    Un código legible por máquina que proporciona la razón de una inscripción fallida. Solo está presente cuando status es FAILED.

Valores posibles:
  - send_risk_signals_failed: Inscripción rechazada debido a un tiempo de espera al enviar señales de riesgo.
  - redirection_to_institution_failed: Inscripción rechazada porque la redirección a la institución no se completó con éxito.
  - biometric_registration_failed: Inscripción rechazada porque el registro biométrico no se completó con éxito dentro del tiempo permitido.
  - too_many_device_registration_attempts: Inscripción rechazada debido a demasiados intentos fallidos de registro de dispositivo.
  - rejected_by_user: La inscripción fue cancelada manualmente por el usuario.
  - device_not_supports_biometric_authentication: Inscripción rechazada porque el dispositivo no es compatible con la autenticación biométrica.
  - institution_infra_failed: Inscripción rechazada debido a problemas de infraestructura en la institución.
  - blocked_by_institution_security_policy: Inscripción rechazada debido a decisiones de la política de seguridad de la institución basadas en la evaluación de riesgos.
  - redirection_back_from_institution_failed: Inscripción rechazada porque la redirección de regreso desde la institución no se completó con éxito.
  - biometric_validation_error: Inscripción fallida debido a problemas de validación biométrica o de registro de clave pública.
  - rejected_other: Inscripción rechazada por una razón no especificada.
  - canceled_due_to_expiration: Inscripción cancelada debido a la expiración del período de validez.
    Example: "biometric_registration_failed"

  - `results.status_reason_message` (string,null)
    Un mensaje legible para humanos que proporciona más detalles sobre la razón de una inscripción fallida. Solo se presenta cuando el status es FAILED. Consulte status_reason_code para ver mensajes de ejemplo para cada código de razón.
    Example: "Enrollment rejected because the biometric registration was not completed successfully within the allowed time."

  - `results.details` (object)
    Detalles sobre la inscripción

  - `results.details.status` (string)
    El estado de la inscripción de pagos biométricos. Puede ser:

  - AWAITING_ACCOUNT_HOLDER_VALIDATION: El titular de la cuenta necesita validar la inscripción enviando sus datos biométricos.
  - AWAITING_ENROLLMENT: La información de inscripción ha sido enviada a la institución y está siendo evaluada.
  - AUTHORIZED: La inscripción ha sido autorizada.
  - REJECTED: La institución ha rechazado la inscripción.
  - REVOKED: El usuario o la institución ha revocado la inscripción.
    Enum: "AWAITING_ACCOUNT_HOLDER_VALIDATION", "AWAITING_ENROLLMENT", "AUTHORIZED", "REJECTED", "REVOKED"

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

  - `results.details.institution` (string)
    El ID único de Belvo para referenciar la institución en la que el dispositivo está registrado.
    Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0"

  - `results.details.platform` (string)
    La plataforma del dispositivo que se va a inscribir. Puede 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)
    Un nombre interno para este registro de dispositivo.
    Example: "600f1b4a-Mobile"

  - `results.details.callback_url` (string)
    La URL a la que se redirigirá a su usuario después de completar el proceso de inscripción.
    Example: "https://example.com/enrollment-in-progress"

  - `results.details.redirect_url` (string)
    La URL para redirigir al usuario a completar su inscripción en la institución.
    Example: "https://www.acmecorp.com/checkout/3487321"

  - `results.details.risk_signals` (string)
    Una cadena ofuscada () utilizada para indicar que se han proporcionado señales de riesgo.
    Example: "******"

  - `results.details.expires_at` (string)
    La marca de tiempo ISO-8601 de cuándo expirará la inscripción. Después de este tiempo, la inscripción ya no será válida y el status cambiará a CANCELED y el status_reason_code se establecerá en canceled_due_to_expiration.
    Example: "2026-12-26T11:20:57.389056Z"

  - `results.metadata` (object)
    Objeto opcional y personalizable donde puedes proporcionar cualquier par clave-valor adicional para tus propósitos internos. Por ejemplo, un número de referencia interno para la inscripción.

⚠️ Nota: Solo puedes proporcionar hasta 50 claves (las claves pueden tener hasta 50 caracteres cada una y cada valor puede tener hasta 500 caracteres). No admitimos objetos anidados, solo valores ASCII.
    Example: {"internal_reference_id":"GGq73487w2"}

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único (not_found) que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - 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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    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)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"