Retrieve Investment Account

Obtiene una cuenta comitente por investment_account_id y permite incluir sus mercados asociados.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Consultá una cuenta comitente por investment_account_id y, si lo necesitás, incluí la información de los mercados asociados.

Antes de empezar

  1. Tené a mano el investment_account_id de la cuenta que querés consultar.
  2. Agregá with_market_data=true si también necesitás recuperar los mercados asociados a la cuenta.
  3. Usá este endpoint después de crear la cuenta o cuando necesites validar su estado antes de asociar productos o cuentas bancarias.

Cómo consultar una cuenta comitente

La ruta requiere el path parameter investment_account_id.

GET /api/accounts/investment-accounts/{investment_account_id}

Si querés incluir la información de mercados asociados, agregá el query parameter with_market_data=true.

GET /api/accounts/investment-accounts/{investment_account_id}?with_market_data=true

Parámetros

Path parameters

ParámetroTipoRequeridoDescripción
investment_account_idintegerSíIdentificador de la cuenta comitente que querés consultar.

Query parameters

ParámetroTipoRequeridoDefaultDescripción
with_market_databooleanNofalseSi enviás true, la respuesta incluye el objeto market_types con los mercados asociados.

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa una cuenta comitente e incluye:

  • external_id: identificador externo informado al crear la cuenta
  • investment_account_id: identificador interno de la cuenta
  • investment_risk_profile: perfil de riesgo calculado
  • owners: personas vinculadas a la cuenta y su rol
  • market_types: mercados asociados, cuando la cuenta tiene mercados creados o cuando consultás con with_market_data=true
  • referral_code: código comercial de referencia, si fue informado al dar de alta la cuenta

Objeto owners

CampoTipoDescripción
person_idstringIdentificador de la persona vinculada a la cuenta.
person_role_idstringRol de la persona dentro de la cuenta.

Objeto market_types

Cada elemento del arreglo market_types representa un mercado asociado a la cuenta.

CampoTipoDescripción
market_typestringTipo de mercado. Ejemplo: stock_market.
is_createdbooleanIndica si la cuenta para ese mercado fue creada correctamente.
dataobjectInformación específica de la cuenta creada en ese mercado.
is_enabledbooleanIndica si el mercado asociado está habilitado.

Objeto data dentro de market_types

Para mercados como stock_market, data puede incluir estos campos:

CampoTipoDescripción
market_account_idintegerIdentificador de la cuenta creada en el mercado.
market_account_numberintegerNúmero de cuenta en el mercado.

Respuesta esperada

{
  "items": [
    {
      "external_id": "ext_001",
      "investment_account_id": "2",
      "investment_risk_profile": "MODERATE",
      "owners": [
        {
          "person_id": "F-a157cf7d-fd11-496d-83ef-47e83407b95c",
          "person_role_id": "TIT"
        }
      ],
      "market_types": [
        {
          "market_type": "stock_market",
          "is_created": true,
          "data": {
            "market_account_number": 1
          },
          "is_enabled": true
        }
      ],
      "referral_code": "CLIENT"
    }
  ]
}

Errores frecuentes

  • 404 Not Found: no existe una cuenta comitente para el investment_account_id enviado.
  • 422 Validation Error: el investment_account_id o el query parameter with_market_data tienen un formato inválido.

Siguiente paso

Usá esta respuesta para validar los titulares de la cuenta, revisar sus mercados asociados o continuar con operaciones relacionadas, como agregar un nuevo mercado o asociar una cuenta bancaria.

Path Params
integer
required
Query Params
boolean
Defaults to false
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json