Registraciones

Registraciones



Enviar pedido de registración

Este mensaje permite enviar un pedido de registración.

Path: [baseURL]/rest/registration
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 del cliente para el pedido de registración.

“symbol”

Y

 

String

Instrumento.

“price”

Y

 

Number

Precio.

“quantity”

Y

 

Integer

Cantidad.

“tradeClearingInstruction”

Y

2=BILATERAL
6=GUARANTEED

Integer

Instrucción para la liquidación de la operación. En instrumentos sin instrucción válida, enviar obligatoriamente el campo con valor null.

“sellAccount”

Y

 

String

Cuenta asociada al lado de venta.
Mutuamente excluyente con el campo “sellMarketMemberID”, se debe enviar uno de los dos.

“sellMarketMemberID”

C

 

String

Identidad ROFEX del participante con cuenta principal, asociado al lado de venta.
Mutuamente excluyente con el campo “sellAccount”, se debe enviar uno de los dos.

“buyAccount”

Y

 

String

Cuenta asociada al lado de compra.
Mutuamente excluyente con el campo “buyMarketMemberID”, se debe enviar uno de los dos.

“buyMarketMemberID”

C

 

String

Identidad ROFEX del participante con cuenta principal, asociado al lado de venta.
Mutuamente excluyente con el campo “buyAccount”, se debe enviar uno de los dos.

{ "clientRequestID": "RG-1006", "symbol": "AL30", "price": 95.25, "quantity": 1000, "tradeClearingInstruction": 2, "buyAccount": "CTA_01", "sellAccount": "CTA_02" }

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 del cliente para el pedido de registración.

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

 


Consultar una registración

Este mensaje permite consultar una registración asociada al cliente autenticado.

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

Response - HTTP/1.1 200 OK

Campos del body:

Field

Req.

Valid Values

Data Type

Description

Field

Req.

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 registración por API-REST.

“registrationID”

C

 

String

Identificador que le asigna el mercado a la registración.
Requerido cuando el “status” es diferente a INVALID o UNKNOWN.

“tradeID”

C

 

String

Identificador que le asigna el mercado al trade resultante de la registración.
Requerido cuando el status es ACCEPTED.

“symbol”

Y

 

String

Instrumento.

“price”

Y

 

Number

Precio.

“quantity”

Y

 

integer

Cantidad.

“createdBy“

Y

BLOQUE

 

->

“userID”

Y

 

String

Usuario que creo la registración.

->

“channel”

Y

FIX_API, REST_API

String

Canal por el que se creo la registración.

“responseBy“

C

BLOQUE

Requerido cuando “status” = ACCEPTED y REJECTED.

->

“userID”

C

 

String

Usuario que respondio la registración.

->

“channel”

C

FIX_API, REST_API

String

Canal por el que se respondió la registración.

“status”

Y

PENDING_RESPONSE, PENDING_COUNTERPARTY_RESPONSE, ACCEPTED, REJECTED, EXPIRED, INVALID, UNKNOWN, CANCELED

String

Estado actual de la registracion.
PENDING_RESPONSE: La registración se encuentra pendiente de aceptación por el usuario que realizo la consulta.
PENDING_COUNTERPARTY_RESPONSE: La registración se encuentra pendiente de aceptación la contraparte.
ACCEPTED: La registración se encuentra aceptada.
REJECTED: La registración fue rechazada por la contraparte.
EXPIRED: La registración se encuentra expirada.
INVALID: El pedido de registración fue rechazado por el mercado.
UNKNOWN: El pedido de registración aun no fue procesado por el mercado.
CANCELED: La registración fue anulada por los participantes o el mercado.

“tradeClearingInstruction”

C

BILATERAL, GUARANTEED

String

Instruccion para la liquidación de la operación.
Requerido cuando la registracion es garantizada o bilateral.

“initializerSide“

Y

BUY, SELL, BOTH

String

Que lado inicio la registración.
BUY: El lado comprador inicio la registración.
SELL: El lado vendedor creo la registración.
BOTH: Quien inicio la registración posee ambos lados de la operación.

“lastUpdateDate”

Y

 

String

Fecha y hora de ultimo cambio de estado en formato YYYYMMDD-hh:mm:ss.sss UTC.

“text“

C

 

String

Razón por la que fue rechazada un pedido de registración.
Requerido cuando el “status” = INVALID

“buyAccount”

Y

BLOQUE

->

“account”

C

 

String

Cuenta asociada al lado de compra.
Requerido cuando el usuario tiene permisos sobre la cuenta o es el creador de la registración.

->

“marketMember”

C

 

String

Participante al que pertenece la cuenta.
Requerido cuando el usuario tiene permisos sobre la cuenta o el usuario tiene permisos sobre la cuenta del lado no iniciador.

“sellAccount”

Y

BLOQUE

->

“account”

C

 

String

Cuenta asociada al lado de compra.
Requerido cuando el usuario tiene permisos sobre la cuenta o es el creador de la registración.

->

“marketMember”

C

 

String

Participante al que pertenece la cuenta.
Requerido cuando el usuario tiene permisos sobre la cuenta o el usuario tiene permisos sobre la cuenta del lado no iniciador.

{ "requestID": "16013", "clientRequestID": "RG-1006", "registrationID": "REG-20260122-00015", "tradeID": "6004", "symbol": "AL30", "price": 95.25, "quantity": 1000, "createdBy": { "userID": "Client_A", "channel": "REST_API" }, "responseBy": { "userID": "Client_B", "channel": "FIX_API" }, "status": "ACCEPTED", "tradeClearingInstruction": "BILATERAL", "initializerSide": "BUY", "lastUpdateDate": "20260122-11:05:12.430", "text": null, "buySide": { "account": "CTA_01", "marketMember": "ALYC_123" }, "sellSide": { "account": "CTA_02", "marketMember": "ALYC_456" } }

 


Consultar registraciones

Este mensaje permite consultar todas las registraciones asociadas al cliente autenticado.

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

Request

Query Params:

Name

Req

Valid Values

Data Type

Description

Name

Req

Valid Values

Data Type

Description

status

N

PENDING_RESPONSE, PENDING_COUNTERPARTY_RESPONSE, ACCEPTED, REJECTED, EXPIRED, INVALID, UNKNOWN, CANCELED

String

Estado actual de la registration. Se envía para consultar que registraciones tengo pendientes de aceptar.

GET /registration?status=PENDING_RESPONSE

Response - HTTP/1.1 200 OK

Campos del body:

Field

Req.

Valid Values

Data Type

Description

Field

Req.

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 registración por API-REST.

“registrationID”

C

 

String

Identificador que le asigna el mercado a la registración.
Requerido cuando el “status” es diferente a INVALID o UNKNOWN.

“tradeID”

C

 

String

Identificador que le asigna el mercado al trade resultante de la registración.
Requerido cuando el status es ACCEPTED.

“symbol”

Y

 

String

Instrumento.

“price”

Y

 

Number

Precio.

“quantity”

Y

 

integer

Cantidad.

“createdBy“

Y

BLOQUE

 

->

“userID”

Y

 

String

Usuario que creo la registración.

->

“channel”

Y

FIX_API, REST_API

String