Saltar a contenido

Tutorial: API de Transacciones

Guía para crear y gestionar transacciones utilizando la API de transacciones.

Crear un Rescate de Acciones (Share Withdrawal)

Endpoint para crear rescate

POST /api/share-withdrawal/create/

Request Body para crear rescate

{
    "share_class_uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "investment_account_external_id": "cuenta123",
    "amount": "1000"
}

Descripción de los campos

  • share_class_uuid: UUID de la clase de acción (obligatorio)
  • investment_account_external_id: ID externo de la cuenta de inversión (obligatorio)
  • amount: Monto a retirar (obligatorio)

Response para creación de rescate exitoso

{
    "uuid": "3ee6e7a1-6d7e-4beb-bc5e-bee78aeedfd1",
    "status": "accepted",
    "run_series": "12345-6",
    "share_holder_external_id": "id partícipe",
    "investment_account_external_id": "Some-External-Id",
    "share_class_name": "Clase A",
    "amount": "0.0000",
    "shares": "0.8375",
    "value": "0.0000",
    "received_at": "2024-11-20T11:37:23.160501-03:00",
    "valuation_date": null,
    "execution_date": null,
    "settlement_date": null
}
  • value: Se obtiene el último valor cuota disponible.
  • shares: Se calcula de acuerdo al monto a retirar y el valor cuota obtenido.
  • valuation_date: Fecha de valorización del rescate, se obtiene al confirmar el rescate.
  • execution_date: Fecha de ejecución del rescate, se obtiene al confirmar el rescate.
  • settlement_date: Fecha de liquidación del rescate, se obtiene al confirmar el rescate.

Posibles errores

  • 2002: Cuenta inactiva.
  • 5005: Rescate inválido: Cuenta no tiene suficientes acciones para el rescate.

Ejemplos de errores

  • 1003 - Validation Error: { "message": "Validation error", "code": "1003", "extra": { "fields": { "share_class_uuid": [ "This field is required." ], "investment_account_external_id": [ "This field is required." ], "amount": [ "This field is required." ] } } }

  • 2002 - Cuenta inactiva: { "message": "Inactive Account", "code": "2002", "extra": { "detail": "The account has been deactivated." } }

  • 5005 - Rescate inválido: { "message": "Invalid share withdrawal", "code": "5005", "extra": { "detail": "The client doesn't have enough available shares" } }

Estados posibles del rescate

  • ACCEPTED: Rescate aceptado
  • CANCELLED: Rescate cancelado
  • CONFIRMED: Rescate confirmado
  • PENDING-EXECUTION: Rescate pendiente de ejecución
  • PENDING-PAYMENT: Rescate pendiente de pago
  • EXECUTED: Rescate ejecutado