MARKET

A través de este servicio podrás:

Enviar órdenes de compra y venta de instrumentos al mercado como suscripciones y rescates de fondos comunes de inversión.
Consultar el estado de una orden realizada.
Cancelar el envio de una orden.

POST/ market-orders

Endpoint para enviar ordenes de compra y venta de distintos instrumentos al mercado.

URL del Endpoint: POST/{{baseUrl}}/api/market/market-order/

Campo	Tipo	Descripción
market_order_id	int	Código identificador de la orden.
investment_account_id	int	Código del comitente en ApiBroker.
market_instrument_id	int	Código del instrumento de mercado.
market_operation_type	str	Tipo de operación: compra o venta.
currency_id	str	Master-tables: currencies.
amount	float	Importe de la transacción.
quantity	int	Cantidad de nominales del instrumento a comprar/vender.
term	int	Plazo de la operación.
instrument_price	float	Precio del instrumento a operar.
by_amount	bool	Indica si la orden se ejecuta es por importe.
include_expenses_in_amount	bool	Indica si se incluyen los gastos de la orden en el importe.
at_market_price	bool	Indica si envía la orden con el precio del instrumento en el mercado.
instrument_type	str	Tipo de instrumento.
trade_date	datetime	Fecha de concertación de la orden.
settlement_date	datetime	Fecha de liquidación de la orden.
created_at	datetime	Fecha de creación de la orden.
updated_at	datetime	Fecha de última actualización de la orden.
market_order_status_id	datetime	Estado de la orden.
executed_quantity	int	Cantidad de nominales ejecutados.
pending_quantity	int	Cantidad de nominales pendientes.
external_id	str	Identificador único de la petición. Lo envía el cliente, y sirve para evitar duplicados

Consideraciones para el envio de ordenes a mercado:

Existen 4 combinaciones posibles para el envio de ordenes:
"by_amount": true y "at_market_price": false: El campo "quantity" debe ser 0 ya que la orden se ejecuta por el importe indicado en "amount", ignorando la cantidad enviada, y al precio enviado en "instrument_price".
"by_amount": false y "at_market_price": false: El campo "amount" debe ser 0, ya que la orden se envía por la cantidad indicada en "quantity" y el precio enviado en "instrument_price".
"by_amount": false y "at_market_price": true: El campo "amount" debe ser 0, ya que la orden se envía por la cantidad indicada en "quantity" y el precio se envía al mercado por el que calcula ApiBroker al enviar la orden.
"by_amount": true y "at_market_price": true: El campo "quantity" debe ser 0 ya que la orden se ejecuta por el importe indicado en "amount", ignorando la cantidad enviada, y el precio se envía al mercado por el que calcula ApiBroker al enviar la orden.
Valores posibles para "market_operation_type": "buy" (compra) o "sell" (venta).
Valores posibles para "term": 0 (contado inmediato). 1 (operaciones a 24hs). 2 (operaciones a 48hs)
Los valores posibles para "market_instrument_id" se pueden obtener en la siguiente url: GET/{{baseUrl}}/api/instruments/market/all

Posibles estados de las ordenes:

market_order_status_id	descripción
SENDING_PENDING	Pendiente de envío. Será enviada tan pronto sea posible.
RETRY	Se intentó enviar pero no fue posible. Será enviada nuevamente tan pronto se pueda.
SENT	Enviada, esperando la confirmación de BYMA.
OFFERED	Ofertada. La orden está ofertada en el mercado. Se ingresó para "buy" o "sell".
COMPLETED	Completada. Se compró o vendió la cantidad indicada. Es un estado FINAL.
CANCELLED	Cancelada. Se canceló manualmente.
REJECTED	Rechazada. El mercado rechazó la orden. Es un estado FINAL.
PARTIALLY_COMPLETED	Parcialmente completada. Se compró o vendió parcialmente. Es un estado temporal si es del día, o un estado FINAL si la orden es de otro día.
PENDING_CANCELLATION	Pendiente de cancelación. Se pidió la cancelación manual al mercado, pero este aún no la confirmó.
NOT_SENT	No enviada. Por algún motivo falló el envío de la orden. Es un estado FINAL.
EXPIRED	Expirada. Las órdenes expiran al cerrar el mercado. Es un estado FINAL.

Request:

{
  "investment_account_id": "int",
  "market_instrument_id": "int",
  "market_operation_type": "str",
  "currency_id": "str",
  "amount": "float",
  "quantity": "int",
  "term": "int",
  "instrument_price": "float",
  "by_amount": "bool",
  "at_market_price": "bool",
  "external_id": "str"
}

Response:

{
  "items": [
    {
      "investment_account_id": "int",
      "market_order_id": "int",
      "market_instrument_id": "int",
      "ticker": "str",
      "market_operation_type": "str",
      "currency_id": "str",
      "amount": "float",
      "net_amount": "float",
      "estimated_expenses": "float",
      "include_expenses_in_amount": "bool",
      "by_amount": "bool",
      "at_market_price": "bool",
      "quantity": "int",
      "term": "int",
      "instrument_price": "float",
      "instrument_type": "str",
      "trade_date": "date",
      "settlement_date": "date",
      "created_at": "datetime",
      "updated_at": "datetime",
      "market_order_status_id": "str",
      "executed_quantity": "int",
      "pending_quantity": "int",
      "external_id": "str"
    }
  ]
}

GET/ market-orders

Endpoint para consultar el estado de una orden.

URL del Endpoint: GET/{{baseUrl}}/api/market/market-order/

Se debe enviar como pathParam el "market_order_id":

URL del Endpoint: GET/{{baseUrl}}/api/market/market-order/{market_order_id}

Response:

{
  "items": [
    {
      "investment_account_id": "int",
      "market_order_id": "int",
      "market_instrument_id": "int",
      "ticker": "str",
      "market_operation_type": "str",
      "amount": "float",
      "net_amount": "float",
      "estimated_expenses": "float",
      "include_expenses_in_amount": "bool",
      "by_amount": "bool",
      "at_market_price": "bool",
      "quantity": "int",
      "currency_id": "str",
      "term": "int",
      "instrument_price": "float",
      "instrument_type": "str",
      "trade_date": "date",
      "created_at": "datetime",
      "settlement_date": "date",
      "updated_at": "datetime",
      "market_order_status_id": "str",
      "executed_quantity": "int",
      "pending_quantity": "int",
      "external_id": "str"
    }
  ]
}

Se pueden consultar todas las ordenes en un rango de fechas especificas para un "investment_account_id":

URL del Endpoint: GET/{{baseUrl}}/api/market/market-order/orders-by-investment-account/{investment_account_id}?from_date=2023-08-01&to_date=2023-08-12

GET/ stock-market-confirmations

URL del Endpoint: GET/{{baseUrl}}/api/market/stock-market-confirmations/confirmations-by-investment-account/{investment_account_id}

Campo	Tipo	Descripción
stock_market_confirmation_id	int	Código identificador de la confirmación.
stock_market_confirmation_num	int	Número de confirmación.
quantity	float	Cantidad de nominales ejecutados.
price	float	Precio del instrumento en la transacción.
gross_amount	float	Importe bruto de la transacción.
net_amount	float	Importe neto de la transacción.
fee	float	Comisión de la transacción.
market_fee	float	Comisión del mercado.
currency_id	str	Identificador de la moneda. Master-tables: currencies.
fee_currency_id	str	Identificador de la moneda de la comisión. Master-tables: currencies.
market_fee_currency_id	str	Identificador de la moneda de la comisión del mercado. Master-tables: currencies.
canceled	bool	Indicador si la transacción fue cancelada.
tax_fee	float	Impuesto sobre la comisión.
tax_market_fee	float	Impuesto sobre la comisión del mercado.
description	str	Descripción de la transacción.

Dentro del objeto stock_market_confirmation_executions:

Campo	Tipo	Descripción
stock_market_confirmation_execution_id	int	Código identificador de la ejecución.
stock_market_confirmation_id	int	Código identificador de la confirmación.
quantity	int	Cantidad de nominales ejecutados en la ejecución.
price	int	Precio del instrumento en la ejecución.
trade_datetime	datetime	Fecha y hora de la ejecución.
market_order_id	int	Código identificador de la orden.

Response:

{
  "items": [
    {
      "stock_market_confirmation_id": "int",
      "investment_account_id": "int",
      "market_instrument_id": "int",
      "market_operation_type": "str",
      "trade_date": "date",
      "settlement_date": "date",
      "stock_market_confirmation_num": "int",
      "quantity": "float",
      "price": "float",
      "gross_amount": "float",
      "fee": "float",
      "market_fee": "float",
      "net_amount": "float",
      "currency_id": "str",
      "fee_currency_id": "str",
      "market_fee_currency_id": "str",
      "canceled": "bool",
      "tax_fee": "float",
      "tax_market_fee": "float",
      "description": "str",
      "stock_market_confirmation_executions": [
        {
          "stock_market_confirmation_execution_id": "int",
          "stock_market_confirmation_id": "int",
          "quantity": "int",
          "price": "int",
          "trade_datetime": "datetime",
          "market_order_id": "int"
        }
      ]
    }
  ],
  "total": "int",
  "page": "int",
  "size": "int"
}

Tambien se pueden consultar todas confirmaciones de ordenes, en un rango de fechas especifico para un "investment_account_id":

URL del Endpoint: GET/{{baseUrl}}/api/market/stock-market-confirmations/confirmations-by-investment-account/{investment_account_id}?from_date=2023-08-01&to_date=2023-08-12

POST/ preview-market-order

Endpoint utilizado para previsualizar una orden de mercado.

URL del Endpoint: POST/{{baseUrl}}/api/market/preview-market-order
Si se envía el parámetro "validate_holding" (bool) en "true", el servicio validará si la cuenta comitente cuenta con la tenencia suficiente en cartera para operar la orden. En caso contrario, no se valida la tenencia, y se puede previsualizar la orden por un importe mayor al disponible.

Request:

{
  "investment_account_id": "int",
  "quantity": "int",
  "amount": "float",
  "currency_id": "str",
  "market_instrument_id": "int",
  "market_operation_type": "str",
  "instrument_price": "float",
  "term": "int",
  "external_id": "str",
  "by_amount": "bool",
  "at_market_price": "bool",
  "validate_holding": "bool"
}

Response:

{
  "items": [
    {
      "investment_account_id": "int",
      "market_instrument_id": "int",
      "ticker": "str",
      "market_operation_type": "str",
      "currency_id": "str",
      "amount": "float",
      "net_amount": "float",
      "estimated_expenses": "float",
      "by_amount": "bool",
      "at_market_price": "bool",
      "quantity": "int",
      "term": "int",
      "instrument_price": "float",
      "instrument_type": "str"
    }
  ]
}

POST/ schedule-market-order

Endpoint para programar órdenes de compra y venta de instrumentos en el mercado.

URL del Endpoint: POST/{{baseUrl}}/api/market/schedule-market-order

Consideraciones:

"scheduled_market_order_id": Código identificador único de la orden programada.
"scheduled_time": Fecha y hora programada para la ejecución de la orden. Este campo especifica cuándo se debe enviar la orden al mercado.
Valores posibles para "status" de una orden programada:

status	Descripción
SCHEDULED	La orden ha sido programada.
CANCELLED	La orden programada ha sido cancelada.
ERROR	Hubo un error al programar la orden.
COMPLETED	La orden programada se ha completado exitosamente.

En caso de que el campo "status" tenga el valor "ERROR", se proporcionará una descripción del error en el campo "message".

Request:

{
  "investment_account_id": "int",
  "quantity": "int",
  "amount": "float",
  "currency_id": "str",
  "market_instrument_id": "int",
  "market_operation_type": "str",
  "instrument_price": "float",
  "term": "int",
  "external_id": "str",
  "by_amount": "bool",
  "at_market_price": "bool",
  "scheduled_time": "datetime"
}

Response:

{
  "items": [
    {
      "scheduled_market_order_id": "int",
      "scheduled_time": "datetime",
      "status": "str",
      "message": "str",
      "error_code": "str",
      "market_order_id": "int",
      "quantity": "int",
      "amount": "float",
      "currency_id": "str",
      "market_instrument_id": "int",
      "market_operation_type": "str",
      "instrument_price": "float",
      "term": "int",
      "investment_account_id": "int",
      "external_id": "str",
      "by_amount": "bool",
      "at_market_price": "bool"
    }
  ]
}

GET/ schedule-market-order

Endpoint para obtener una orden programada específica.

URL del Endpoint: GET/{{baseUrl}}/api/market/schedule-market-order/{scheduled_market_order_id}

Response:

{
  "items": [
    {
      "scheduled_market_order_id": "int",
      "scheduled_time": "datetime",
      "status": "str",
      "message": "str",
      "error_code": "str",
      "market_order_id": "int",
      "quantity": "int",
      "amount": "float",
      "currency_id": "str",
      "market_instrument_id": "int",
      "market_operation_type": "str",
      "instrument_price": "float",
      "term": "int",
      "investment_account_id": "int",
      "external_id": "str",
      "by_amount": "bool",
      "at_market_price": "bool"
    }
  ]
}

POST/ mep-order

Endpoint para realizar compra-venta de dolar MEP. Permite comprar dólares MEP (deshacerse de ARS y obtener USD) y vender dólares (deshacerse de USD y obtener ARS).

URL del Endpoint: POST/{{baseUrl}}/api/market/mep-order

Campo	Tipo	Descripción
mep_market_order_id	int	Código identificador de la solicitud.
investment_account_id	int	Código de cuenta de inversiones en ApiBroker.
base_instrument_id	int	Código identificador del instrumento base. Se obtiene a través de instruments/market.
market_operation_type	str	Tipo de operación: compra USD MEP o venta USD MEP.
amount	float	Importe de la transacción.
market_order_id_1	int	Código identificador de la primer orden.
market_order_id_2	int	Código identificador de la segunda orden.
order_2_scheduled_time	str	Horario UTC en el cual se quiere realizar la segunda orden.
status	str	Estado de la solicitud MEP.
external_id	str	Identificador único de la petición. Lo envía el cliente, y sirve para evitar duplicados.
message	str	Mensaje de la operación.
error_code	obj	Código de error. Si no hay error, este campo es null.
created_at	datetime	Fecha de la creación de la solicitud.
updated_at	datetime	Fecha de última actualización de la solicitud.

Consideraciones:

Todas las órdenes programadas se envían en contado inmediato.
Este endpoint funciona en días habiles
Valores posibles para "market_operation_type": "buy" (Comprar USD MEP) o "sell" (vender USD MEP).
- Si se utiliza "buy", lo que hará el sistema es enviar la primer orden de compra en moneda ARS, y enviará la proxima orden inmediatamente
- Si se utiliza "sell", lo que hará el sistema es enviar la primer orden de compra en moneda USD, y enviará la próxima orden inmediatamente
Los valores posibles para "base_instrument_id" se pueden obtener en la siguiente url: GET/{{BASE_URL}}/api/instruments/market/all
- Esto quiere decir que puede realizar la operatoria de compra-venta con el instrumento que desee, sea éste un CEDEAR, un título público, etc.
El sistema detecta automáticamente en qué moneda debe operar en las órdenes según el "base_instrument_id" y "market_operation_type".
El campo "order_2_scheduled_time" se debe enviar siempre en UTC. Ejemplo de hora: "15:30". Esto, al ser UTC; significa que la segunda orden será enviada a las 11:30 horario Argentina GMT-3.
- Para el caso de que una orden tenga "market_operation_type": "buy", la hora que se pide es para enviar la orden de venta el día siguiente. Si no se envían datos en este campo, se tomará el horario default que es 16:30HS UTC, 13:30HS GMT-3.
- Para el caso de que una orden tenga "market_operation_type": "sell", la hora que se pide es para enviar la orden de venta en el día actual. Si no se envía datos en este campo, se tomará el horario default que es a los 10 minutos de creada la primer orden.

Posibles estados de las solicitudes:

status	descripción
PENDING	Pendientes de envío. Será enviada tan pronto sea posible la primer orden, y quedará en pendiente mientras tanto no esté completada la segunda orden.
CANCELLED	Cancelada manualmente.
NOT_SENT	No enviada.
COMPLETED	Completada.

Request:

{
  "investment_account_id": "int",
  "amount": "float",
  "base_instrument_id": "int",
  "market_operation_type": "str",
  "order_2_scheduled_time": "str",
  "external_id": "str"
}

Response:

{
  "items": [
    {
      "mep_market_order_id": "int",
      "investment_account_id": "int",
      "base_instrument_id": "int",
      "market_operation_type": "str",
      "amount": "float",
      "status": "str",
      "external_id": "str",
      "market_order_id_1": "int",
      "market_order_id_2": "int",
      "message": "str",
      "error_code": "str",
      "created_at": "str",
      "updated_at": "str"
    }
  ]
}

GET/ mep-order

Endpoint para consultar el estado de una solicitud de compra-venta USD MEP.

Se debe enviar como pathParam el fund_request_id:

URL del Endpoint: GET/{{baseUrl}}/api/market/mep-order/{mep_market_order_id}

Response:

{
  "items": [
    {
      "mep_market_order_id": "int",
      "investment_account_id": "int",
      "base_instrument_id": "int",
      "market_operation_type": "str",
      "amount": "float",
      "status": "str",
      "external_id": "str",
      "market_order_id_1": "int",
      "market_order_id_2": "int",
      "message": "str",
      "error_code": "str",
      "created_at": "datetime",
      "updated_at": "datetime"
    }
  ]
}

POST/ closed-dollar-operation 💵

Endpoint para realizar compra-venta de dolar CERRADO. Permite comprar y vender dólares MEP con un precio asegurado para el usuario final.

Actualmente esta operación se encuentra disponible solo para cuentas de personas físicas.

URL del Endpoint: POST/{{baseUrl}}/api/market/closed-dollar-operation

Campo	Tipo	Descripción
currency_id	str	Código moneda de la operacion. Master-tables: currencies
operation_type	str	Tipo de operación
investment_account_id	int	investment_account_id del cliente final
amount	float	Importe de la transacción
fx_request	float	Tipo de cambio que el cliente aceptó
external_id	str	Identificador único de la petición. Lo envía el cliente, y sirve para evitar duplicados

Consideraciones:

Valores posibles para "operation_type": "buy" (Comprar USD MEP) o "sell" (vender USD MEP).
Este endpoint funciona en días habiles
- Si se utiliza "buy", lo que hará el sistema es enviar la primer orden de compra en moneda ARS💲 y enviará la proxima orden en el mismo día para obtener los USD💵
- Si se utiliza "sell", lo que hará el sistema es enviar la primer orden de compra en moneda USD💵, y enviará la próxima orden en el mismo día para obtener los ARS💲
Cuando se envía una solicitud, el campo "operation_1_client_market_order_id" corresponde a la primer orden enviada. El campo "operation_2_client_market_order_id" correspondiente a la segunda orden, no se completará automaticamente, sino cuando finalice el proceso.

Valores posibles para "status" de una orden :

status	Descripción
IN_PROGRESS	La orden ha sido enviada.
ERROR	Hubo un error al enviar la orden.
COMPLETED	Las ordenes se han completado exitosamente.

Request:

{
    "currency_id": "str",
    "operation_type": "str",
    "investment_account_id": "int",
    "amount": "float",
    "fx_request": "float",
    "external_id": "str"
}

Response:

{
   "items":[
      {
         "closed_dollar_operation_id":"str",
         "currency_id":"str",
         "operation_type":"str",
         "investment_account_id":"int",
         "amount":"float",
         "fx_request":"float",
         "actual_fx":"float",
         "operation_1_client_market_order_id":"int",
         "operation_2_client_market_order_id":"int",
         "external_id":"str",
         "message":"str",
         "error_code":"str",
         "status_id":"str",
         "created_at":"datetime",
         "updated_at":"datetime"
      }
   ]
}

GET/ closed-dollar-operation

Endpoint para consultar el estado de una solicitud de compra-venta Dolar Cerrado.

Se debe enviar como pathParam el closed_dollar_operation_id:

URL del Endpoint: GET/{{baseUrl}}/api/market/closed-dollar-operation/:closed_dollar_operation_id

Response:

{
   "items":[
      {
         "closed_dollar_operation_id":"str",
         "currency_id":"str",
         "operation_type":"str",
         "investment_account_id":"int",
         "amount":"float",
         "fx_request":"float",
         "actual_fx":"float",
         "operation_1_client_market_order_id":"int",
         "operation_2_client_market_order_id":"int",
         "external_id":"str",
         "message":"str",
         "error_code":"str",
         "status_id":"str",
         "created_at":"datetime",
         "updated_at":"datetime"
      }
   ]
}

GET/ closed-dollar-operation-price

Endpoint que se utiliza para consultar la cotización disponible para la operatoria de MEP Cerrado

URL del Endpoint: GET/{{baseUrl}}/api/market/closed-dollar-operation-price

Response:

{
   "items":[
      {
         "closed_dollar_fx":"float",
         "currency_id":"str",
         "operation_type":"str"
      }
   ]
}

Obtendremos dependiendo la operación (buy/sell) y la moneda (ARS/USD), el precio para operar por dolar cerrado.

DELETE/ market-orders

Endpoint para cancelar una orden enviada al mercado.

URL del Endpoint: DELETE/{{baseUrl}}/api/market/market-order/

Para CANCELAR una orden, necesitamos que se cumplan las siguientes validaciones:

Que exista la orden que queremos cancelar y que corresponda al usuario.
Que el estado de la orden en BYMA sea SENDING_PENDING.
Que el estado de la orden en BYMA sea RETRY.
Que el estado de la orden en BYMA sea SENT.
Que el estado de la orden en BYMA sea OFFERED.
Que el estado de la orden en BYMA sea PARTIALLY_COMPLETED. (En caso de que la orden sea del día actual, porque si la orden es de un día anterior se encuentra en un estado final, por lo que no puede ser CANCELADA, porque ya no se envía a mercado).

Se debe enviar como pathParam el market_order_id:

URL del Endpoint: DELETE/{{baseUrl}}/api/market/market-order/{market_order_id}

Si la orden pudo ser cancelada se obtendrá el siguiente response:

{
  "message": "Success"
}

Si la orden NO pudo ser cancelada se obtendrá el siguiente response:

{
  "error_code": "CODIGO DE ERROR",
  "message": "No se pudo cancelar la orden"
}

Nota: si el mensaje es de exito, el estado de la orden quedara en : "pending_cancellation". Una vez que la orden se encuentre cancelado su estado pasara a ser: "cancelled"

POST/ fund-requests

Endpoint para realizar solicitudes de suscripción o rescates de fondos comunes de inversión.

URL del Endpoint: POST/{{baseUrl}}/api/market/fund-requests/

Campo	Tipo	Descripción
fund_request_id	int	Código identificador de la solicitud.
investment_account_id	int	Código del comitente en ApiBroker.
mutual_fund_id	int	Código del instrumento de FCI.
name	str	Nombre del instrumento de FCI.
ticker	str	Identificador del instrumento de FCI.
clazz	str	Clase del instrumento de FCI.
fund_operation_type	str	Tipo de operación: suscripción o rescate.
is_total	bool	Indicador si el rescate es por el total o parcial. Por defecto: false
currency_id	str	Master-tables: currencies.
amount	float	Importe de la transacción.
share_quantity	float	Cantidad de cuotapartes.
share_price	float	Precio de la cuotaparte.
fund_request_status_id	str	Estado de la solicitud.
trade_date	datetime	Fecha de concertación.
settlement_date	datetime	Fecha de liquidación de la solicitud.
created_at	datetime	Fecha de la creación de la solicitud.
updated_at	datetime	Fecha de última actualización de la solicitud.
external_id	str	Identificador único de la petición. Lo envía el cliente, y sirve para evitar duplicados

Consideraciones:

Valores posibles para "fund_operation_type": "subscription" (suscripciones) o "redemption" (rescates).
Los valores posibles para "mutual_fund_id" se pueden obtener en la siguiente url: GET/{{baseUrl}}/api/instruments/mutual-funds/all

Posibles estados de las solicitudes:

fund_request_status_id	descripción
SENDING_PENDING	Pendiente de envío. Será enviada tan pronto sea posible.
RETRY	Se envió, pero falló y se marcó para reintentar. Se enviará nuevamente.
SENT	Enviada, esperando ser liquidada.
CANCELLED	Cancelada manualmente.
NOT_SENT	No enviada.
SETTLED	Liquidada.

Request:

{
  "investment_account_id": "int",
  "mutual_fund_id": "int",
  "fund_operation_type": "str",
  "currency_id": "str",
  "amount": "float",
  "is_total": "bool",
  "external_id": "str",
  "by_share_quantity": "bool",
  "share_quantity": "float"
}

Response:

{
  "items": [
    {
      "investment_account_id": "int",
      "fund_request_id": "int",
      "mutual_fund_id": "int",
      "name": "str",
      "ticker": "str",
      "fund_operation_type": "str",
      "currency_id": "str",
      "amount": "float",
      "is_total": "bool",
      "clazz": "str",
      "share_quantity": "float",
      "share_price": "float",
      "trade_date": "date",
      "settlement_date": "date",
      "created_at": "datetime",
      "updated_at": "datetime",
      "approved": "bool",
      "fund_request_status_id": "str",
      "external_id": "str"
    }
  ]
}

GET/ fund-requests

Endpoint para consultar el estado de una solicitud de fci.

URL del Endpoint: GET/{{baseUrl}}/api/market/fund-requests/

Se debe enviar como pathParam el fund_request_id:

URL del Endpoint: GET/{{baseUrl}}/api/market/fund-requests/{fund_request_id}

Response:

{
  "items": [
    {
      "investment_account_id": "int",
      "fund_request_id": "int",
      "mutual_fund_id": "int",
      "fund_operation_type": "str",
      "currency_id": "str",
      "amount": "float",
      "is_total": "bool",
      "name": "str",
      "ticker": "str",
      "clazz": "str",
      "share_quantity": "float",
      "share_price": "float",
      "trade_date": "date",
      "settlement_date": "date",
      "created_at": "datetime",
      "updated_at": "datetime",
      "fund_request_status_id": "str",
      "approved": "bool",
      "external_id": "str"
    }
  ]
}

Se pueden consultar todas las solicitudes de fci, en un rango de fechas especificas para un "investment_account_id":

URL del Endpoint: GET/{{baseUrl}}/api/market/fund-requests/fund-requests-by-investment-account/{investment_account_id}?from_date=2023-08-01&to_date=2023-08-12

GET/ mutual-fund-confirmations

URL del Endpoint: GET/{{baseUrl}}/api/market/mutual-fund-confirmations/funds-by-investment-account/{investment_account_id}

Response:

{
  "items": [
    {
      "mutual_fund_confirmation_id": "int",
      "investment_account_id": "int",
      "mutual_fund_id": "int",
      "fund_operation_type": "str",
      "trade_date": "date",
      "settlement_date": "date",
      "amount": "float",
      "share_quantity": "float",
      "share_price": "float",
      "expenses": "float",
      "currency_id": "str",
      "fund_request_id": "int",
      "canceled": "bool",
      "created_at": "datetime",
      "updated_at": "datetime"
    }
  ],
  "total": "int",
  "page": "int",
  "size": "int"
}

Tambien se pueden consultar todas confirmaciones de las solicitudes de fci, en un rango de fechas especificas para un "investment_account_id":

URL del Endpoint: GET/{{baseUrl}}/api/market/mutual-fund-confirmations/funds-by-investment-account/{investment_account_id}?from_date=2023-08-01&to_date=2023-08-12

DELETE/ fund-requests

Endpoint para cancelar una solicitud de fci.

URL del Endpoint: DELETE/{{baseUrl}}/api/market/fund-requests/

Solo cancelaremos una solicitud que no haya sido negociada y que no se haya cancelado/rechazado previamente

Se debe enviar como pathParam el fund_request_id: Url: DELETE/{{baseUrl}}/api/market/fund-requests/{fund_request_id}

Si la orden pudo ser cancelada se obtendrá el siguiente response:

{
  "message": "Success"
}

Si la orden NO pudo ser cancelada se obtendrá el siguiente response:

{
  "error_code": "CODIGO DE ERROR",
  "message": "No se pudo cancelar la orden"
}

Nota: si el mensaje es de exito, el estado de la orden quedara en : "pending_cancellation". Una vez que la solicitud se encuentre cancelada su estado pasara a ser: "cancelled"