Bienvenido al API de PowerGAS

Aquí encontrarás la documentación necesaria para utilizar las APIs que tenemos disponibles para tí.

Clientes

Información de tarjetas

Método
GET

Path
demoapi.powergas.mx/Clientes/ConsultaTarjetas

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

TarjetasResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lTarjetas List <InfoTarjetaResponse> Contiene una lista con la información de las tarjetas.

Información de mi tarjeta

Método
GET

Path
demoapi.powergas.mx/Clientes/ConsultaTarjeta/{Folio}

Parámetros
Folio - Folio de la tarjeta

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

InfoTarjetaResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
Folio string Indica el folio de la tarjeta seleccionada.
Saldo decimal Saldo total de la tarjeta.
Bloqueada bool Indica el bloqueo de la tarjeta, si se encuentra bloqueada: true o desbloqueada: false.
Activa bool Indica el estatus de la tarjeta activa: true o desactiva: false.
Politica string Nombre de la politica asignada.
InfoVehiculo string Información del vehiculo asignado.

Información de consumos

Método
POST

Path
demoapi.powergas.mx/Clientes/ConsultaConsumos

Parámetros

ConsumosRequest
AtributoTipoDescripción
fechaInicioDateTimeFecha de inicio de la consulta.
fechaFinalDateTimeFecha limite de la consulta.
combustiblesstringTipos de ventas de combustibles que se van a consultar.
1: DIESEL, 2: MAGNA, 3: PREMIUM.
Ejemplos: 1,2,3

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

ConsumosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lConsumos List <InfoConsumoResponse> Lista con los consumos encontrados.

Información de Estados de Cuenta y Facturas

Método
POST

Path
demoapi.powergas.mx/Clientes/ConsultaCFDI

Parámetros

CFDRequest
AtributoTipoDescripción
SeriestringSerie del tipo de comprobante
'EC' - Estado de cuenta
'F' - Factura
FoliointFecha limite de la consulta.

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

CFDResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
XML string Cadena con XML del comprobante.

Información de rendimientos

Método
POST

Path
demoapi.powergas.mx/Clientes/ConsultaRendimientos

Parámetros

RendimientosRequest
AtributoTipoDescripción
fechaInicioDateTimeFecha de inicio de la consulta.
fechaFinalDateTimeFecha limite de la consulta.
centroCostos (Opcional)stringNombre del centro de costos.
noEconomico (Opcional)stringNúmero económico.

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

RendimientosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lRend List <InfoRendimiento> Lista con los rendimientos encontrados.

Catálogo de vehículos

Método
GET

Path
demoapi.powergas.mx/Clientes/Vehiculos

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

VehiculosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lVehiculos List <Vehiculo> Contiene una lista con la información de los vehiculos que se encuentran activos.

Catálogo de centro de costos

Método
GET

Path
demoapi.powergas.mx/Clientes/CentrosCostos

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

lCentroCostos
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lCentroCostos List <CentroCostos> Contiene una lista con la información de los centros de costos que se encuentran activos.

Clientes V2

Información de tarjetas

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaTarjetas

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

TarjetasResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lTarjetas List <InfoTarjetaResponse> Contiene una lista con la información de las tarjetas.

Información de mi tarjeta

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaTarjeta/{Folio}

Parámetros
Folio - Folio de la tarjeta

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

InfoTarjetaResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
Folio string Indica el folio de la tarjeta seleccionada.
Saldo decimal Saldo total de la tarjeta.
Bloqueada bool Indica el bloqueo de la tarjeta, si se encuentra bloqueada: true o desbloqueada: false.
Activa bool Indica el estatus de la tarjeta activa: true o desactiva: false.
Politica string Nombre de la politica asignada.
InfoVehiculo string Información del vehiculo asignado.

Información de consumos

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaConsumos

Parámetros

ConsumosRequest
AtributoTipoDescripción
fechaInicioDateTimeFecha de inicio de la consulta.
fechaFinalDateTimeFecha límite de la consulta.
combustiblesArrayTipos de ventas de combustibles que se van a consultar.
1: DIESEL, 2: MAGNA, 3: PREMIUM.
Ejemplos: [1,2,3]
autoconsumoBoolIncluir autoconsumos.

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

ConsumosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
ResponseValueList <InfoConsumoResponse> Lista con los consumos encontrados.

Información de Estados de Cuenta y Facturas

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaCFDI

Parámetros

CFDRequest
AtributoTipoDescripción
SeriestringSerie del tipo de comprobante
'EC' - Estado de cuenta
'F' - Factura
FoliointFecha limite de la consulta.

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

CFDResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
XML string Cadena con XML del comprobante.

Información de rendimientos

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaRendimientos

Parámetros

RendimientosRequest
AtributoTipoDescripción
fechaInicioDateTimeFecha de inicio de la consulta.
fechaFinalDateTimeFecha limite de la consulta.
centroCostos (Opcional)stringNombre del centro de costos.
noEconomico (Opcional)stringNúmero económico.

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

RendimientosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lRend List <InfoRendimiento> Lista con los rendimientos encontrados.

Catálogo de vehículos

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/Vehiculos

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

VehiculosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lVehiculos List <Vehiculo> Contiene una lista con la información de los vehiculos que se encuentran activos.

Catálogo de centro de costos

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/CentrosCostos

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

lCentroCostos
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lCentroCostos List <CentroCostos> Contiene una lista con la información de los centros de costos que se encuentran activos.

Consulta precios de combustibles

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaPrecios

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

ApiResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
ResponseValue List <PreciosCombustiblesResponse> Contiene una lista con información del tipo de combustible (1: DIESEL, 2: MAGNA, 3: PREMIUM), precio y ultima fecha de actualizacion.

Transfiere saldo de cuenta central a tarjeta

Método
POST

Path
demoapi.powergas.mx/Cliente/V2/TransferenciaSaldo

Permisos
Escritura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

ApiResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
ResponseValue string Regresa el folio del movimiento que se realizo.

Consulta saldo cuenta central

Método
GET

Path
demoapi.powergas.mx/Cliente/V2/ConsultaSaldoCentral

Permisos
Lectura

Autorización
Usuario: Nombre de Usuario
Contraseña: API Key

Respuesta

ApiResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
ResponseValue decimal Regresa el saldo disponible en la cuenta central.

Estaciones

Información de Ordenes de Pago

Método
POST

Path
demoapi.powergas.mx/Estaciones/ConsultaOPs

Parámetros

OPRequest
AtributoTipoDescripción
fechaInicioDateTimeFecha de inicio de la consulta.
fechaFinalDateTimeFecha limite de la consulta.

Autorización
Usuario: Número de estación
Contraseña: API Key

Respuesta

OPResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lOPs List <InfoOPResponse> Lista con las ordenes de pago encontradas.

Información de consumos

Método
POST

Path
demoapi.powergas.mx/Estaciones/ConsultaConsumos

Parámetros

ConsumosRequest
AtributoTipoDescripción
fechaInicioDateTimeFecha de inicio de la consulta.
fechaFinalDateTimeFecha limite de la consulta.
combustiblesstringTipos de ventas de combustibles que se van a consultar.
1: DIESEL, 2: MAGNA, 3: PREMIUM.
Ejemplos: 1,2,3

Autorización
Usuario: Número de cliente
Contraseña: API Key

Respuesta

ConsumosResponse
AtributoTipoDescripción
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición.
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición.
lConsumos List <InfoConsumoResponse> Lista con los consumos encontrados.

TPV Externa

Consulta el saldo y politicas de la tarjeta indicada

Método
POST

Path
demoapi.powergas.mx/tpvexterna/v1/ConsultaSaldo

Parámetros

OperacionTarjetaRequest
AtributoTipoDescripción
FolioTarjetastringFolio de tarjeta que se consultara
NipstringNip de la tarjeta
IdCombustibleintTipo de combustible (1-Diesel, 2-Magna, 3-Premium)
PrecioCombustibledecimalPrecio de combustible

Autorización
Usuario: Número de serie de terminal
Contraseña: API Key

Respuesta

ConsultaSaldoResponse
AtributoTipoDescripción
ESNointNúmero de estación
ESNombrestringNombre de estación
ESNombreCortostringNombre comercial de estación
IdClienteintId cliente
ClientestringNombre de cliente
FolioTarjeta string Número identificador de tarjeta o tag
- El folio de la tarjeta es una sucesión numérica de 14 dígitos sin espacios ej.: 4441000000000000
- El folio del tag consta de un prefijo "CTLS" más una sucesión numérica de 5 dígitos numéricos sin espacios ej.: CTLS00000
VehiculostringDatos de vehículos (Placas, Modelo, No. económico)
KilometrajedecimalKilometraje
TotalDiariodecimalAcumulado diario
TotalSemanaldecimalAcumulado semanal
TotalMensualdecimalAcumulado mensual
DiasCarga int Valor definido por Enumerador con atributo Flag, determina los días permitidos para cargar
Lunes = 1
Martes = 2
Miércoles = 4
Jueves = 8
Viernes = 16
Sábado = 32
Domingo = 64
Todos = 127
HoraInicialstringHorario inicial en el que se permite cargar combustible
HoraFinalstringHorario final a partir del cual ya NO es posible cargar combustible
Combustibles int Valor definido por Enumerador con atributo Flag, determiona los Combustibles permitidos
Diesel = 1
Magna = 2
Premium = 4
SaldoActualdecimalSaldo actual en tarjeta
SaldoDisponibledecimalMuestra el saldo disponible en MX Pesos/Litros
SinRestriccionesboolIndica si existen políticas de restricción, en caso de existir y esta no se cumpla el campo OperacionExitosa sera false
LimitarPorMontoboolIndica si el saldo disponible se mostrara en MX Pesos o su equivalencia en litros
ValidarConductorboolIndica si el dato Conductor es obligatorio y debe validarse al momento de realizar una venta
ValidarPlacasboolIndica si el dato Placas es obligatorio y debe validarse al momento de realizar una venta
ValidarKmboolIndica si el dato Km es obligatorio y debe validarse al momento de realizar una venta
ValidarNoEcoboolIndica si el dato No. Economico es obligatorio y debe validarse al momento de realizar una venta
EstacionAutorizadaboolIndica si se validara la Estacion y se comprobara si el usuario tiene permitico cargar en ella
InfoVisibleshortMostrar información
CapturaPrecioboolÚltimo precio de combustible capturado
OperacionExitosa bool Indica el estatus de la petición.
Exitosa: true/false
Mensaje string Definición del error en caso que la solicitud no se finalice con éxito, de lo contrario el mensaje estará vacío
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición

Registra una venta

Método
POST

Path
demoapi.powergas.mx/tpvexterna/v1/RegistraVenta

Parámetros

RegistraVentaRequest
AtributoTipoDescripción
IdCombustibleintTipo de combustible (1-Diesel, 2-Magna, 3-Premium).
PreciodecimalPrecio de combustible.
TotaldecimalTotal de la venta.
KilometrajedecimalKilometraje del vehiculo.
NoConductorintNumero de conductor.
NipConductorstringNip de condutor.
PlacasstringPlacas del vehiculo.
NoEconomicostringNumero economico del vehiculo.
FolioEstacionstringFolio de estacion que realizo la venta.
ReintentoboolReintento.

Autorización
Usuario: Número de serie de terminal
Contraseña: API Key

Respuesta

VentaResponse
AtributoTipoDescripción
ESNointNúmero de estación
ESNombrestringNombre
ESNombreCortostringNombre comercial
IdClienteintId cliente
ClientestringCliente
FolioTarjetastringFolio de tarjeta
VehiculostringDatos de vehículos (Placas, Modelo, No. económico)
SaldoActualdecimalSaldo actual
KmActualdecimalKilometraje actual
KmAnteriordecimalKilometraje anterior
RendimientodecimalRendimiento de combustible
IdCombustibleintCombustibles (1-Diesel, 2-Magna, 3-Premium)
PreciodecimalPrecio de combustible
LitrosdecimalLitros vendidos
TotaldecimalCosto total
FolioVentastringFolio de venta
FolioEstacionstringFilio de estación
FechaVentaDateTimeFecha de venta
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición

Registra la última conexión de la terminal que realiza la solicitud

Método
GET

Path
demoapi.powergas.mx/tpvexterna/v1/Hearthbeat

Autorización
Usuario: Número de serie de terminal
Contraseña: API Key

Respuesta

HearthbeatResponse
AtributoTipoDescripción
ESNointNúmero de estación
ESNombrestringNombre
ESNombreCortostringNombre comercial
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición

Registra la última conexión de la terminal que realiza la solicitud

Método
POST

Path
demoapi.powergas.mx/tpvexterna/v1/Hearthbeat

Parámetros

HearthbeatRequest
AtributoTipoDescripción
ModelostringModelo de TPV.
SerieTPVstringNúmero de serie de TPV.
VersionstringVersion.
FechaActualstringFecha actual.
SIMstringSIM.
SerieSIMstringNúmero de serie de SIM.
EthernetstringEthernet.

Autorización
Usuario: Número de serie de terminal
Contraseña: API Key

Respuesta

HearthbeatResponse
AtributoTipoDescripción
ESNointNúmero de estación
ESNombrestringNombre
ESNombreCortostringNombre comercial
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición

Consulta una venta

Método
POST

Path
demoapi.powergas.mx/tpvexterna/v1/ConsultaVenta

Parámetros

ConsultaVentaRequest
AtributoTipoDescripción
FolioVentastringFolio de venta.
NipstringNip de tarjeta.

Autorización
Usuario: Número de serie de terminal
Contraseña: API Key

Respuesta

VentaResponse
AtributoTipoDescripción
ESNointNúmero de estación
ESNombrestringNombre
ESNombreCortostringNombre comercial
IdClienteintId cliente
ClientestringCliente
FolioTarjetastringFolio de tarjeta
VehiculostringDatos de vehículos (Placas, Modelo, No. económico)
SaldoActualdecimalSaldo actual
KmActualdecimalKilometraje actual
KmAnteriordecimalKilometraje anterior
RendimientodecimalRendimiento
IdCombustibleintCombustibles (1-Diesel, 2-Magna, 3-Premium)
PreciodecimalPrecio de combustible
LitrosdecimalLitros vendidos
TotaldecimalCosto total
FolioVentastringFolio de venta
FolioEstacionstringFolio de estacion
FechaVentaDateTimeFecha de venta
Operación exitosaboolIndica el estatus de la petición. Exitosa: true/false
MensajestringIndica el mensaje de éxito o error en la petición
FechaConsultaDateTimeIndica la fecha y hora en que se realizó la petición