SiPagoDocs
Docs para IA

Descargar movimientos

GET /operations/downloadOperations

Descarga tus movimientos de un rango de fechas en un archivo Excel, el mismo reporte de ventas que podés bajar desde el panel de Sipago. A diferencia de Consultar movimientos, no es paginado: el archivo trae todos los movimientos del período.

PARÁMETROS DE CONSULTA (QUERY STRING)

NombreTipoObligatorioDescripción
downloadTypestringSíFormato del archivo. Valor: xls .
start_datestring (AAAA-MM-DD)SíFecha desde.
end_datestring (AAAA-MM-DD)SíFecha hasta.
subsidiarystringNoID de la sucursal, para descargar solo sus movimientos. Vacío: todas.
statusstringNoFiltro por estado del movimiento. Vacío: todos.
transactionTypesstringNoFiltro por tipo de operación. Vacío: todos.
usersstringNoFiltro por usuario que hizo la venta. Vacío: todos.
Consejo: Parámetros de fecha

Este endpoint usa start_date y end_date (con guion bajo), a diferencia de startDate/endDate de Consultar movimientos. Los parámetros van en la URL; no lleva cuerpo.

RESPUESTA 200 OK

El contenido del archivo, no JSON. Guardá el cuerpo de la respuesta tal como llega.

EncabezadoValor
Content-Typeapplication/vnd.ms-excel
Content-Dispositionattachment; filename="sales_<timestamp>.xls"

Si algo falla, la respuesta es JSON con el formato de error (status, message, timestamp), así que revisá el código HTTP antes de guardar el archivo.

EJEMPLOS

curl --location --get 'https://api-gwt.sipago.online/services/operations/downloadOperations' \
--header 'apikey: TU_API_KEY' \
--header 'X-TRACE-ID: 3cc1aabd-eb40-48bc-bb84-d1c34f1e2934' \
--header 'X-VERSION: 1' \
--data-urlencode 'downloadType=xls' \
--data-urlencode 'start_date=2024-05-01' \
--data-urlencode 'end_date=2024-05-31' \
--fail --output movimientos-mayo.xls

Campos del archivo descargado

El archivo Excel contiene las siguientes columnas, en el orden del archivo de ejemplo ejemplo_descarga_movimientos.xls. Cada fila corresponde a un movimiento; algunos campos pueden estar vacíos según la operación.

CampoDescripción
OrigenCanal de origen de la operación, por ejemplo, ECOMMERCE, Pagos recurrentes o QR.
FechaFecha y hora del movimiento, con formato AAAA-MM-DD HH:mm:ss en el ejemplo.
Nombre de comercioNombre del comercio al que pertenece el movimiento.
Nombre de sucursalNombre de la sucursal asociada.
UsuarioNombre del usuario asociado a la operación.
EstadoEstado del movimiento, por ejemplo, Aprobada.
Nombre del clienteNombre del cliente; puede aparecer UNKNOWN cuando no está disponible.
Número de documentoNúmero de documento del cliente, cuando está disponible.
E-mail del clienteCorreo electrónico del cliente, cuando está disponible.
Marca tarjetaMarca o identificación del medio utilizado, por ejemplo, Visa Débito, MasterCard Prepaga o PCT.
Número tarjetaNúmero de tarjeta enmascarado; puede estar vacío en operaciones sin tarjeta.
Método de pagoMétodo utilizado, por ejemplo, Débito, Crédito o PREPAID.
MonedaCódigo de moneda; en el ejemplo figura 032.
Importe brutoImporte bruto del movimiento.
Importe netoImporte neto informado para el movimiento.
PropinaImporte de la propina.
ImpuestosImporte de impuestos informado para el movimiento.
ArancelImporte del arancel aplicado.
IVA ArancelIVA correspondiente al arancel.
Costo FinancieroImporte del costo financiero.
IVA Costo FinancieroIVA correspondiente al costo financiero.
II.BB.Importe informado bajo el concepto de Ingresos Brutos.
Ret. IVAImporte de la retención de IVA.
Ret. GananciasImporte de la retención de Ganancias.
Ret. IIBB SIRTACImporte de la retención de Ingresos Brutos SIRTAC.
Ret. IIBB no inscriptoImporte de la retención de Ingresos Brutos por no inscripto.
Ret. IIBB por falta de altaImporte de la retención de Ingresos Brutos por falta de alta.
Fecha de disponibilidadFecha de acreditación de fondos, con formato AAAA-MM-DD.
Nº ReferenciaNúmero de referencia del movimiento.
Nº AutorizaciónCódigo de autorización de la operación.
ID TerminalIdentificador de la terminal; puede ser numérico o texto, como COELSA.
TipoTipo de operación, por ejemplo, Venta.
LectorInformación del lector, cuando está disponible; está vacío en el archivo de ejemplo.
Cuentas de email a las que se envió boucherLista de correos a los que se envió el comprobante. El nombre de la columna conserva la escritura del archivo original.
GeolocalizaciónInformación de geolocalización, cuando está disponible; está vacía en el archivo de ejemplo.

Resumen de totales

Al final del archivo, después del detalle de movimientos, aparece un resumen por moneda con estos campos:

CampoDescripción
MonedaCódigo de moneda del resumen.
Total brutoTotal bruto informado para esa moneda.
Total anuladasTotal de operaciones anuladas informado para esa moneda; está vacío en el ejemplo.
Total impuestosTotal de impuestos informado en el resumen.
Total netoTotal neto informado para esa moneda.