Consultar candidatas

Este mensaje permite consultar todas las operaciones candidatas a ser asignadas por el usuario. En la respuesta se obtendrán todas las operaciones candidatas que aun tengan cantidad disponible para asignarse, incluyendo aquellas que que se les acabo el tiempo disponible para ser asignadas.

Path: [baseURL]/rest/allocations/candidates
Method: GET
Produces: application/json
Consumes: -

Request

Query Params:

Name	Req	Valid Values	Data Type	Description

Name	Req	Valid Values	Data Type	Description
tradeID	N		String	Identificador que le asigna el mercado al negocio.

GET /rest/allocations/candidates?tradeID=33001

Response - `HTTP/1.1 200 OK`

Campos del body:

Field	Req.	Valid Values	Data Type	Description

Field	Req.	Valid Values	Data Type	Description
“candidateID”	Y		String	Identificador de la operación candidata a asignable.
“tradeID”	Y		String	Identificador que le asigna el mercado al negocio.
“symbol”	Y		String	Instrumento del negocio.
"side"	Y	`BUY`, `SELL`	String	Lado del negocio sobre el cual el usuario puede realizar la asignación.
“quantity”	Y		Number	Cantidad total del negocio.
“allocableQuantity”	Y		Number	Cantidad disponible para asignar (cantidad total menos lo ya asignado).
“price”	Y		Number	Precio del negocio.
"tradeDateTime"	Y		String	Fecha y hora UTC de ultimo cambio de estado en formato `YYYYMMDD-hh:mm:ss.sss UTC`.
“account”	Y		String	Cuenta asociada al lado sobre el que se puede realizar la asignación.
“tradeClearingInstruction”	C	`BILATERAL`, `GUARANTEED`	String	Instrucción para la liquidación del negocio. Requerido cuando la registración es garantizada o bilateral.

[
  {
    "candidateID": "36004",
    "tradeID": "33001",
    "symbol": "AL30/CI",
    "side": "BUY",
    "quantity": 2000,
    "allocableQuantity": 2000,
    "price": 150.75,
    "tradeDateTime": "20260504-14:30:25.123",
    "account": "09T",
    "tradeClearingInstruction": "GUARANTEED"
  },
  {
    "candidateID": "36005",
    "tradeID": "33001",
    "symbol": "AL30/CI",
    "side": "SELL",
    "quantity": 2000,
    "allocableQuantity": 2000,
    "price": 150.75,
    "tradeDateTime": "20260504-14:30:25.123",
    "account": "ACC_Temporaly",
    "tradeClearingInstruction": "GUARANTEED"
  }
]

En el ejemplo el usuario tiene permiso sobre las cuentas “a confirmar” 09T y ACC_Temporaly

Enviar pedido de asignación

Este mensaje permite enviar un al mercado un pedido de asignación. El mismo se puede realizar indicando el identificador de la operación candidata a asignar (“candidateID”) o el identificador y lado del negocio que se quiere asignar (“tradeID” y “side”)

Path: [baseURL]/rest/allocation
Method: POST
Produces: application/json
Consumes: application/json

Request

Campos del body:

Field	Req.	Valid Values	Data Type	Description

Field	Req.	Valid Values	Data Type	Description
“clientRequestID”	Y		String	Identificador generado por el cliente para el pedido de asignación.
“candidateID”	C		String	Identificador de la operación candidata a asignar. Requerido si no se envían los campos “tradeID” y “side”.
“tradeID”	C		String	Negocio sobre el que se va a realizar la operación de asignación. Requerido si no se envían el campos “candidateID”.
“side”	C	`BUY`, `SELL`	String	Lado del negocio a asignar, mismo lado que la operación candidata a asignar. Requerido si no se envían el campos “candidateID”.
“account“	Y		String	Cuenta destino de la asignación.
“quantity“	Y		String	Cantidad asociada a la asignación.

Ejemplo de body indicando el identificador de la operación candidata a asignar:

{
  "clientRequestID": "ALLOC-1006",
  "candidateID": "36005",
  "account": "ACC_01",
  "quantity": 500,
}

Ejemplo de body indicando el identificador y lado del negocio:

{
  "clientRequestID": "ALLOC-1006",
  "tradeID": "33001",
  "side": "SELL",
  "account": "ACC_01",
  "quantity": 500,
}

Response - `HTTP/1.1 200 OK`

Campos del body:

Field	Req.	Valid Values	Data Type	Description

Field	Req.	Valid Values	Data Type	Description
“requestID”	Y		String	Identificador del mercado para el pedido realizado por el cliente.
“clientRequestID”	Y		String	Identificador generado por el cliente para el pedido de asignación.

{
  "requestID": "16013",
  "clientRequestID": "ALLOC-1006"
}

Consultar una asignación

Este mensaje permite consultar una asignación en la que el cliente autenticado sea el creador o tenga permiso sobre alguna de las cuentas que intervienen.

Path: [baseURL]/rest/registration/{requestID}
Method: GET
Produces: application/json
Consumes: -

Response - `HTTP/1.1 200 OK`

Campos del body:

Field		NULL?	Valid Values	Data Type	Description
“clientRequestID”		Y		String	Identificador del cliente para el pedido de registración.
“requestID”		Y		String	Identificador único de un pedido de asignación por API-REST.
“candidateID”		Y		String	Identificador de la operación candidata asignada.
“operationID”		C		String	Identificador que le asigna el mercado a la asignación. Requerido cuando el status es `ACCEPTED`.
“tradeID”		Y		String	Identificador del negocio asociado a la asignación.
“symbol”		Y		String	Instrumento de la operación asignada.
“price”		Y		Number	Precio de la operación asignada.
“quantity”		Y		integer	Cantidad asignada.
“createdBy“		Y	BLOQUE
->	“userID”	Y		String	Usuario que creo la asignación.
->	“channel”	Y	`FIX_API`, `REST_API`	String	Canal por el que se creo la asignación.
“status”		Y	`ACCEPTED`, `INVALID`, `UNKNOWN`, `CANCELED`	String	Estado actual de la registración. `ACCEPTED`: La asignación se encuentra aceptada. `INVALID`: El pedido de asignación fue rechazado por el mercado. `UNKNOWN`: El pedido de asignación aun no fue procesado por el mercado. `CANCELED`: La asignación fue anulada por los participantes o el mercado.
“lastUpdateDate”		Y		String	Fecha y hora UTC de ultimo cambio de estado en formato `YYYYMMDD-hh:mm:ss.sss UTC`.
“tradeClearingInstruction”		C	`BILATERAL`, `GUARANTEED`	Integer	Instrucción para la liquidación de la operación asignada. Requerido cuando la registración es garantizada o bilateral.
“text“		C		String	Razón por la que fue rechazada por el mercado un pedido de asignación. Requerido cuando el “status” = `INVALID`
“operationSide“		Y	`BUY`, `SELL`	String	Lado del negocio asignado, mismo lado que la operación candidata asignada. `BUY`: Se asigna una compra. `SELL`: Se asigna una venta.
“buyAccount”		C		String	Cuenta asociada al lado de compra de la asignación. Requerido cuando el usuario tiene permisos sobre la cuenta o es el creador de la asignación.
“sellAccount”		C		String	Cuenta asociada al lado de compra de la asignación. Requerido cuando el usuario tiene permisos sobre la cuenta o es el creador de la asignación.

{
  "clientRequestID": "ALLOC-1008",
  "requestID": "16013",
  "candidateID": "36005",
  "operationID": "36009",
  "tradeID": "33001",
  "symbol": "AL30/CI",
  "price": 150.75,
  "quantity": 500,
  "createdBy":{
    "userID": "Client_A",
    "channel": "REST_API"
  }
  "status": "ACCEPTED",
  "tradeClearingInstruction": "GUARANTEED",
  "text": null,
  "lastUpdateDate": "20260504-14:50:22.123",
  "operationSide": "SELL",
  "buyAccount": "ACC_Temporaly",
  "sellAccount": "ACC_01"
}

Consultar asignaciones

Este mensaje permite consultar rodas las asignaciones en la que el cliente autenticado sea el creador o tenga permiso sobre alguna de las cuentas que intervienen.

Path: [baseURL]/rest/registrations
Method: GET
Produces: application/json
Consumes: -

Response - `HTTP/1.1 200 OK`

Campos del body:

[{
  "clientRequestID": "ALLOC-1008",
  "requestID": "16013",
  "candidateID": "36005",
  "operationID": "36009",
  "tradeID": "33001",
  "symbol": "AL30/CI",
  "price": 150.75,
  "quantity": 500,
  "createdBy":{
    "userID": "Client_A",
    "channel": "REST_API"
  }
  "status": "ACCEPTED",
  "tradeClearingInstruction": "GUARANTEED",
  "text": null,
  "lastUpdateDate": "20260504-14:50:22.123",
  "operationSide": "SELL",
  "buyAccount": "ACC_Temporaly",
  "sellAccount": "ACC_01"
},
{
  "clientRequestID": "ALLOC-2038",
  "requestID": "15062",
  "candidateID": "15002",
  "operationID": "15003",
  "tradeID": "32036",
  "symbol": "GGAL/DIC26",
  "price": 180.75,
  "quantity": 4000,
  "createdBy":{
    "userID": "Client_B",
    "channel": "REST_API"
  }
  "status": "ACCEPTED",
  "tradeClearingInstruction": null,
  "text": null,
  "lastUpdateDate": "20260504-14:50:22.123",
  "operationSide": "SELL",
  "buyAccount": "ACC_Temporaly",
  "sellAccount": "ACC_01"
}]

Flujo de la mensajería

Ejemplo de asignación:

Asignaciones

Consultar candidatas

Request

Response - HTTP/1.1 200 OK

Enviar pedido de asignación

Request

Response - HTTP/1.1 200 OK

Consultar una asignación

Response - HTTP/1.1 200 OK

Consultar asignaciones

Response - HTTP/1.1 200 OK

Flujo de la mensajería

Response - `HTTP/1.1 200 OK`

Response - `HTTP/1.1 200 OK`

Response - `HTTP/1.1 200 OK`

Response - `HTTP/1.1 200 OK`