Saltar a contenido

Tutorial: API de Transacciones

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

Crear un Depósito de Acciones (Share Deposit)

Endpoint para crear depósito

POST /api/share-deposit/create/

Request Body para crear depósito

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

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 depositar (obligatorio)
  • channel_code: Código del canal por donde se realiza el depósito (obligatorio)
  • Valores posibles para channel_code:
    • WEB: Para depósitos web
    • MOBILE: Para depósitos móviles
    • [otros códigos según configuración]

Response para creación de depósito exitoso

{
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "status": "accepted",
    "run_series": "12345-6",
    "share_holder_external_id": "id partícipe",
    "investment_account_external_id": "cuenta123",
    "share_class_name": "Clase A",
    "amount": "1000",
    "shares": "0.0000",
    "value": "0.0000",
    "received_at": "2024-03-20T15:30:00Z",
    "valuation_date": null,
    "execution_date": null,
    "channel_code": "WEB"
}
  • value: Valor cuota del depósito, se obtiene al confirmar el depósito.
  • shares: Cantidad de acciones del depósito, se calcula de acuerdo al monto a depositar y el valor cuota obtenido.
  • valuation_date: Fecha de valorización del depósito, se obtiene al confirmar el depósito.
  • execution_date: Fecha de ejecución del depósito, se obtiene al confirmar el depósito.

Posibles errores

  • 1003 - Validation Error: Error de validación, falta alguno de los campos.
  • 1003 - Validation Error - Canal inválido: Error de validación, el canal no es una opción válida.
  • 2002 - Cuenta inactiva: La cuenta de inversión se encuentra desactivada.

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." ], "channel_code": [ "This field is required." ] } } }

  • 1003 - Validation Error - Canal inválido: { "message": "Validation error", "code": "1003", "extra": { "fields": { "channel_code": [ "FAKE_CHANNEL_CODE" is not a valid choice." ] } } }

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

Estados posibles del depósito

  • ACCEPTED: Depósito aceptado
  • CANCELLED: Depósito cancelado
  • CONFIRMED: Depósito confirmado
  • PENDING-EXECUTION: Depósito pendiente de ejecución
  • EXECUTED: Depósito ejecutado