Obtener plan de ahorro

Para obtener el detalle de un plan de ahorro se debe realizar el siguiente request:

GET/v1/savings/investment-plans/{plan_id}

Request

Headers

Campo	Tipo	Requerido	Descripción
Authorization	string	Sí	Token de acceso en formato Bearer ACCESS_TOKEN

Path Parameters

Campo	Tipo	Requerido	Descripción
plan_id	number	Sí	Identificador del plan.

No aplica: Query Parameters, Body.

Response

2XX Éxito

Campo	Tipo	Descripción
plan_id	number	Identificador del plan.
code	string	Código del plan.
name	string	Nombre del plan.
currency	string	Moneda del plan.
year_variation	number	Variación anual proyectada del plan.
horizon	string	Horizonte de inversión. Valores permitidos: SHORT_TERM, MEDIUM_TERM, LONG_TERM.
risk	string	Nivel de riesgo del plan. Valores permitidos: LOW, MEDIUM, HIGH.
minimum_investment	number	Monto mínimo de inversión.
funds	array	Lista de fondos que componen el plan.
funds[].code	string	Código del fondo.
funds[].name	string	Nombre del fondo.
funds[].percentage	number	Porcentaje de participación del fondo en el plan.

Códigos de error

Los errores devuelven el siguiente body:

{
  "code": "invalid_request",
  "description": "Descripción del error."
}

Status	Code	Condición
400	plan_not_accessible	El plan especificado no es accesible para el merchant autenticado.
403	—	El token no tiene el rol requerido para operar este endpoint.

Ejemplo de código

cURL

curl -X GET https://b2b.allaria.dev/v1/savings/investment-plans/1 \
  -H "Authorization: Bearer ACCESS_TOKEN"

JavaScript

const planId = 1;

const response = await fetch(
  `https://b2b.allaria.dev/v1/savings/investment-plans/${planId}`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer ACCESS_TOKEN'
    }
  }
);

const data = await response.json();
console.log(data);

Python

import requests

plan_id = 1

response = requests.get(
  f'https://b2b.allaria.dev/v1/savings/investment-plans/{plan_id}',
  headers={
    'Authorization': 'Bearer ACCESS_TOKEN'
  }
)

data = response.json()
print(data)

Node.js

const axios = require('axios');

const planId = 1;

const response = await axios.get(
  `https://b2b.allaria.dev/v1/savings/investment-plans/${planId}`,
  {
    headers: {
      Authorization: 'Bearer ACCESS_TOKEN'
    }
  }
);

console.log(response.data);

2XX Éxito

{
  "plan_id": 1,
  "code": "MEDIUM_ARS",
  "name": "Plan Mediano Plazo en ARS",
  "currency": "ARS",
  "year_variation": 0.45,
  "horizon": "MEDIUM_TERM",
  "risk": "LOW",
  "minimum_investment": 10000.00,
  "funds": [
    {
      "code": "FCI_001",
      "name": "Fondo Común de Inversión ARS",
      "percentage": 100.00
    }
  ]
}