Aquí podrás consultar los movimientos de tu cuenta virtual: liquidaciones, comisiones, fees, retenciones y disponibilidad de dinero asociados a tus transacciones.
Ambos endpoints requieren autenticación con token Bearer y acceso API habilitado. El ambiente (Pruebas o Producción) se determina automáticamente según el token utilizado (api-access:test o api-access:production); no es necesario enviarlo como parámetro.
Descripción: Obtiene los movimientos de la cuenta virtual del comercio autenticado de forma paginada con un status 200 OK. Solo se retornan movimientos del ambiente correspondiente al token.
Endpoint: GET /api/v1/virtual-account/movements
Parámetros de filtros
| Nombre | Descripción | Reglas |
|---|---|---|
| start_date | Fecha de inicio del rango (Y-m-d). Se aplica sobre la fecha de creación del movimiento |
nullable, date_format:Y-m-d, before_or_equal:finish_date |
| finish_date | Fecha final del rango (Y-m-d) |
nullable, date_format:Y-m-d, before_or_equal:today, after_or_equal:start_date |
| offices | Array con el/los id de sucursal del usuario autenticado. Si se omite, se consultan todas las sucursales del usuario | nullable, array |
| availability | Disponibilidad del dinero: all (todas), available (disponible), to_release (por liberar) |
nullable, in:all,available,to_release |
| transaction_id | Filtra por el transaction_id exacto de la transacción asociada |
nullable, string |
| per_page | Cantidad de registros por página (máximo 100). Por defecto 15 |
nullable, integer, min:1, max:100 |
Campos de respuesta (cada ítem dentro de data)
| Campo | Tipo | Descripción |
|---|---|---|
| environment | string | Ambiente del movimiento: Producción o Pruebas |
| concept | string | Concepto / descripción del movimiento |
| transaction_id | mixed | ID de la transacción (o ajuste) asociado |
| authorization_number | string | Número de autorización de la transacción. Puede ser null |
| transaction_amount | number | Valor de la transacción |
| subtotal | number | Subtotal después de comisiones, fees e IVAs |
| liquidated_amount | number | Monto liquidado (subtotal menos gravamen) |
| commission | number | Comisión aplicada |
| fee | number | Fee aplicado |
| gravamen | number | Gravamen aplicado |
| iva | number | IVA de la transacción |
| iva_commission | number | IVA de la comisión |
| iva_fee | number | IVA del fee |
| rete_iva | number | Retención de IVA |
| rete_ica | number | Retención de ICA |
| rete_fte | number | Retención en la fuente |
| transaction_date | string | Fecha de la transacción / compensación |
| available_at | string | Fecha en la que el dinero queda disponible. Puede ser null |
| days_difference | string | Tiempo restante o transcurrido hasta la disponibilidad. Puede ser null |
| plan_detail_feature | object | Tasas del plan asociadas al movimiento. Puede ser null |
Campos de plan_detail_feature
| Campo | Tipo | Descripción |
|---|---|---|
| commission | number | Porcentaje / valor de comisión |
| min_commission | number | Comisión mínima |
| fee | number | Fee configurado en el plan |
| gravamen | number | Gravamen configurado en el plan |
Ejemplo de solicitud:
Descripción: Consulta un movimiento específico de la cuenta virtual a partir del transaction_id de la transacción, limitado al ambiente del token. Responde con el objeto del registro (sin wrapper data) y un status 200 OK. Si no existe o no pertenece al comercio autenticado / ambiente del token, responde 404 Not Found.
Endpoint: GET /api/v1/virtual-account/movement/{transaction_id}
Parámetro de url
| Nombre | Descripción | Reglas |
|---|---|---|
| transaction_id | ID de la transacción asociada al movimiento | required |
La respuesta usa los mismos campos descritos en Lista de movimientos.
Ejemplo de solicitud: