Obtiene una cuenta comitente por investment_account_id y permite incluir sus mercados asociados.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Consultá una cuenta comitente por investment_account_id y, si lo necesitás, incluí la información de los mercados asociados.
Antes de empezar
- Tené a mano el
investment_account_idde la cuenta que querés consultar. - Agregá
with_market_data=truesi también necesitás recuperar los mercados asociados a la cuenta. - 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=trueParámetros
Path parameters
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
investment_account_id | integer | Sí | Identificador de la cuenta comitente que querés consultar. |
Query parameters
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
with_market_data | boolean | No | false | Si 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 cuentainvestment_account_id: identificador interno de la cuentainvestment_risk_profile: perfil de riesgo calculadoowners: personas vinculadas a la cuenta y su rolmarket_types: mercados asociados, cuando la cuenta tiene mercados creados o cuando consultás conwith_market_data=truereferral_code: código comercial de referencia, si fue informado al dar de alta la cuenta
Objeto owners
owners| Campo | Tipo | Descripción |
|---|---|---|
person_id | string | Identificador de la persona vinculada a la cuenta. |
person_role_id | string | Rol de la persona dentro de la cuenta. |
Objeto market_types
market_typesCada elemento del arreglo market_types representa un mercado asociado a la cuenta.
| Campo | Tipo | Descripción |
|---|---|---|
market_type | string | Tipo de mercado. Ejemplo: stock_market. |
is_created | boolean | Indica si la cuenta para ese mercado fue creada correctamente. |
data | object | Información específica de la cuenta creada en ese mercado. |
is_enabled | boolean | Indica si el mercado asociado está habilitado. |
Objeto data dentro de market_types
data dentro de market_typesPara mercados como stock_market, data puede incluir estos campos:
| Campo | Tipo | Descripción |
|---|---|---|
market_account_id | integer | Identificador de la cuenta creada en el mercado. |
market_account_number | integer | Nú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 elinvestment_account_idenviado.422 Validation Error: elinvestment_account_ido el query parameterwith_market_datatienen 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.
