- Criado por Rodrigo Nicolás González em jul 27, 2023
FleetManager Agente - Servicios Operadores de Flota
Fecha | Versión | Descripción | Autor |
|---|---|---|---|
| 28/06/2022 | 1.0 | Creación del documento | |
| 12/09/2022 | 2.0 | Actualización Documentación:
|
Servicio: Registración de Pre-Autorizacion (registerPreAuthorization)
Servicio que nos permitirá registrar una Pre-Autorización informada por el sistema cliente.
Es un método REST basado en el formato JSON. Ejemplo:
[post] http://[dirección-ip]:[puerto]/api/v1/registerPreAuthorization |
POST – REQUEST
HEADER
Elemento | Valor |
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE |
BODY
Elemento | Descripcion | Tipo | Requerido | Validacion |
requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto | SI | |
| fleetOperatorCode | Código del Operador de Flota Externo | String | SI | |
serviceStationCode | Nodo de la Estación | String | SI | |
posCode | Id de Pos | String | SI | |
operatorCode | Id de Usuario | String | SI | |
transaction | Objeto | SI | ||
transactionCode | Número único de Transacción | String | SI | |
preAuthorization | Objeto | SI | ||
date | Fecha en que se realiza la Preautorización | dateTime | SI | |
authorizationCode | Id Único de Transacción dado por PTS | String | SI | |
authorizedAmount | Monto máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number | SI | |
authorizedQuantity | Volumen máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number | SI | |
responseCode | Resultado de la operación, podrá tener los valores "A" (Aprobado) o "R" (Rechazado) o "P" (Parcial) | Char | SI | |
responseMessages | Texto Mostrar | String | SI | |
invoice | Objeto | SI | ||
invoiceDate | Fecha de Factura (factura realizada en el negocio de Flota - Prepago) | String | Si prepaid = 2 Obligatorio | |
invoiceType | Tipo de Factura (1=Factura, 2=Boleta) | Char | SI | |
cardNumber | PAN Enmascarado | String | SI | |
prepaid | 1 = POS;2=PRE | Char | SI | |
invoiceNumber | Numero Factura Prepago | String | Si prepaid = 2 Obligatorio | |
voucher | Voucher de Impresión | String | SI | |
customer |
| Objeto | SI | |
vehicleOdometer | Información ingresada por el usuario cuando requerida. | String | ||
customerAddress | Dirección del Cliente | String | SI | |
customerCity | Ciudad Cliente | String | SI | |
customerMunicipality | Comuna Cliente | String | SI | |
customerName | Nombre Cliente | String | SI | |
customerDocumentNumber | RUT Cliente | String | SI | |
vehiclePlate | Patente Vehiculo | String | SI |
Ejemplo:
{ "requestCredential": { "fleetOperatorCode ": "SG", "ServiceStationCode" : "CH9329", "posCode" : "1", "operatorCode" : "1002" }, "transaction": { " transactionCode" : "25451247" }, "preAuthorization": { "date": "20220115100535", "authorizationCode" : "210215152145648", "authorizedAmount" : 40000.0000, "authorizedQuantity" : 51.880674448767833981841763943, "responseCode" : "A", "responseMessages" : "Transaccion aprobada."
}, "invoice": { "invoiceDate" : 20220102, "invoiceType" : 1, "cardNumber" : "xxxxxxxxxxxxxxxxxxx", "prepaid" : "1", "invoiceNumber" : "1411444", "voucher": "" }, "customer": { "vehicleOdometer" : "114849", "customerAddress" : "CAMINO A MELIPILLA", "customerCity" : "TALAGANTE", "customerMunicipality" : "PADRE HURTADO", "customerName" : "I MUNICIPALIDAD DE PADRE HURTADO", "customerDocumentNumber" : "69.261.400-3", "vehiclePlate" : "JJ WG 74" } } |
RESPONSE OK
Elemento | Descripcion | Tipo | Requerido |
ack | Código del Response | number | SI |
message | Mensaje del Response | String | SI |
Ejemplo:
{ " ack" : 0, " message" : "OK" } |
RESPONSE ERROR
Elemento | Tipo | Detalle |
ack | Number | Código de error. Siendo los valores posibles: FM-3002 : Se debe enviar un Access Token FM-3003 : Access Token invalido FM-3007 : La compañía de FLota no existe FM-3008 : Estructura del JSON invalida FM-3013 : Error de Validacion: [Campo Faltante] es Requerido FM-3015 : Registro duplicado [Campo][Valor] |
message | String | Detalle del tipo del error. |
Ejemplo:
{ "ack": 3002, "message": "Se debe enviar un Access Token" } |
Servicio: Confirmación de venta (confirmation)
Mensaje de Confirmación de venta de una Pre-autorización para dar por cerrado el flujo desde el POS/Terminal en el autorizador de Flota.
En el request irá el ID de transacción del autorizador (transactionCode) y todos los datos finales de la transacción.
Este mensaje no se puede rechazar por parte del autorizador.
Es un método REST basado en el formato JSON. Ejemplo:
[post] http://[dirección-ip]:[puerto]/api/v1/confirmation |
|---|
POST – REQUEST
HEADER
Elemento | Valor |
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE |
BODY
Elemento | Descripción | Tipo | Requerido | Validacion |
requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto | SI | |
| fleetOperatorCode | Código del Operador de Flota Externo | String | SI | |
serviceStationCode | Nodo de la Estación | String | SI | |
posCode | Id de Pos | String | SI | |
operatorCode | Id de Usuario | String | SI | |
operatorDescription | Descripción Usuario logueado | String | SI | |
transaction | Objeto | SI | ||
transactionCode | Número único de transacción de flota para toda la red. | String | SI | |
confirmation | Objeto | SI | ||
confirmationDate | YYYYMMDDHHMMSS | dateTime | SI | |
documentType | Tipo de Documento Fiscal. Se enviará "GDE" | String | SI | |
deliverCode | Número de Documento Fiscal (num de folio) | String | SI | |
productId | Código Producto HE | Number | SI | |
amount | Este valor dependerá del campo anterior TipoVenta. Para caso en que se quiera solicitar un despacho de "estanque lleno" se enviará el valor 0 (cero) como cantidad. | Number | SI | Mayor a 0 |
unitPrice | Precio Unitario del producto seleccionado | Number | SI | Mayor a 0 |
totalAmount | Importe Total de la venta | Number | SI | Mayor a 0 |
deliverId | Id de Despacho | String | SI | |
shiftId | Id de Turno | String | SI | |
pumpId | Id de Surtidor | Number | SI |
Ejemplo:
{ "requestCredential": { "fleetOperatorCode": "SG", "serviceStationCode" : "CH9329", "posCode" : "1", "operatorCode" : "1002", "operatorDescription" : "Bombero Playa - Turno 1"
}, "transaction": { "transactionCode": "194278" }, "confirmation": { "confirmationDate": "20210215152522", "documentType": "GDE", "deliverCode": "9479893", "productId": 3, "amount": 24.594817, "unitPrice": 849.0, "totalAmount": 20881.0, "deliverId": "5629", "shiftId": "20210215080256", "pumpId": 2 } } |
RESPONSE OK
Elemento | Descripcion | Tipo | Requerido |
authorizationCode | Id único de Transacción | String | SI |
transactionCode | Número de Trx HE | String | SI |
deliverCode | Número de Documento Fiscal (num de folio) | String | SI |
documentType | Número de Tarjeta del Cliente | String | SI |
| cardNumber | PAN Enmascarado | String | SI |
| flagOffline | Flag que indica si la operación se confirmó por proceso de Store & Forward u online. False o True (Null=NO, 1=SI ) | String | SI |
ack | Resultado de la operación. | Number | SI |
mesagge | Descripción del resultado | String | SI |
Ejemplo:
{
" authorizationCode": "210215151755021", " transactionCode ": 194278, " deliverCode ": "9479893", " cardNumber": "XXXXXXXXXXXXX", " documentType": "GDE", "flagOffline":"True", "ack": 0, " mesagge": "OK"
} |
RESPONSE ERROR
Elemento | Tipo | Detalle |
ack | Number | Código de error. Siendo los valores posibles: FM-3002 : Se debe enviar un Access Token FM-3003 : Access Token invalido FM-3007 : La compañía de FLota no existe FM-3008 : Estructura del JSON invalida FM-3011 : Transacción no encontrada FM-3016 : Transacción en estado Invalida FM-3013 : Error de Validacion: [Campo Faltante] es Requerido FM-3020 : [ Campo ] debe ser mayor a cero |
message | String | Detalle del tipo del error. |
Ejemplo:
{ "ack": 3008, "message": " Formato de JSON Invalido" } |
Servicio: Reversa de Pre-Autorizacion (reverse)
Mensaje de cancelación de una Pre-autorización aprobada de una operación de flota para dar por cerrado el flujo desde el POS/Terminal en el autorizador de Flota.
En el request irá el ID de transacción del autorizador (transactionCode) siempre que Bridge lo haya recibido en la pre-autorización .
Este mensaje no se puede rechazar por parte del autorizador.
Es un método REST basado en el formato JSON. Ejemplo:
[post] http://[dirección-ip]:[puerto]/api/v1/reverse |
POST – REQUEST
HEADER
Elemento | Valor |
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE |
BODY
Elemento | Descripción | Tipo | Requerido | |
requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto | SI | |
| fleetOperatorCode | Codigo del Operador de Flota Externo | String | SI | |
serviceStationCode | Nodo de la Estación | String | SI | |
posCode | Id de Pos | String | SI | |
operatorCode | Id de Usuario | String | SI | |
transaction | Objeto | SI | ||
transactionCode | Número único de transacción de flota para toda la red. | String | SI | |
reverse | Objeto | SI | ||
| dateReverse | YYYMMDDHHMMSS | dateTime | ||
reasonId | Id Motivo | Number | SI | |
reasonDescription | Descripcion del motivo de reversa | String | SI |
Ejemplo:
{ "requestCredential": { "fleetOperatorCode": "SIGAF", "serviceStationCode" : "CH9329", "posCode" : "1", "operatorCode" : "1002" }, "transaction": { "transactionCode": "194278" }, "reverse": { "dateReverse": "20210215152522" "reasonId": 6, "reasonDescription": "'Error al generar DTE " } } |
RESPONSE OK
Elemento | Descripcion | Tipo | Requerido |
authorizationCode | Id único de Transacción | String | SI |
transactionCode | Número de Trx HE | String | SI |
ack | Resultado de la operación | Number | SI |
message | Descripción del resultado | String | SI |
Ejemplo:
{ " authorizationCode": "210215151755021", " transactionCode ": 194278 "ack": 0, " message": "OK"
} |
RESPONSE ERROR
Elemento | Tipo | Detalle |
ack | Number | Código de error. Siendo los valores posibles: FM-3002 : Se debe enviar un Access Token FM-3003 : Access Token invalido FM-3007 : La compañía de FLota no existe FM-3008 : Estructura del JSON invalida FM-3011 : Transacción no encontrada FM-3016 : Transacción en estado Invalida FM-3013 : Error de Validacion: [Campo Faltante] es Requerido |
message | String | Detalle del tipo del error. |
Ejemplo:
{ "ack": 3008, "message": " Formato de JSON Invalido" } |
Servicio: Reversa Online (reverseOnline)
El servicio de reversa online se usara para casos en los que por algún motivo el sistema cliente haya enviado una pre-Autorizacion, el sistema de flota lo haya aceptado pero por algún motivo no llego el response, entonces este servicio permitirá al sistema cliente poder reversar la reserva de saldo que se genera al momento de pedir una pre-Autorizacion. Este servicio deberá recibir los datos del sistema cliente y enviarlos directamente al servidor, no persistirá ningún dato en el agente.
Es un método REST basado en el formato JSON. Ejemplo:
[post] http://[dirección-ip]:[puerto]/api/v1/reverseOnline |
POST – REQUEST
HEADER
Elemento | Valor |
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE |
BODY
Elemento | Descripción | Tipo | Requerido | |
requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto | SI | |
| fleetOperatorCode | Codigo del Operador de Flota Externo | String | SI | |
serviceStationCode | Nodo de la Estación | String | SI | |
posCode | Id de Pos | String | SI | |
operatorCode | Id de Usuario | String | SI | |
transaction | Objeto | SI | ||
transactionCode | Número único de transacción de flota para toda la red. | String | SI | |
reverse | Objeto | SI | ||
| dateReverse | YYYMMDDHHMMSS | dateTime | ||
reasonId | Id Motivo | Number | SI | |
reasonDescription | Descripcion del motivo de reversa | String | SI |
Ejemplo:
{ "requestCredential": { "fleetOperatorCode": "SIGAF", "serviceStationCode" : "CH9329", "posCode" : "1", "operatorCode" : "1002" }, "transaction": { "transactionCode": "194278" }, "reverse": { "dateReverse": "20210215152522" "reasonId": 6, "reasonDescription": "'Error al generar DTE " } } |
RESPONSE OK
Elemento | Descripcion | Tipo | Requerido |
transactionCode | Número de Trx HE | String | SI |
ack | Resultado de la operación | Number | SI |
message | Descripción del resultado | String | SI |
Ejemplo:
{ " transactionCode ": 194278 "ack": 0, " message": "Transaccion Aprobada" } |
RESPONSE ERROR
Elemento | Tipo | Detalle |
ack | Number | Código de error. Siendo los valores posibles: FM-3002 : Se debe enviar un Access Token FM-3003 : Access Token invalido FM-3004 : Token de acceso caducado FM-3006 : La compañia no existe FM-3007 : La compañía de FLota no existe FM-3008 : Estructura del JSON invalida FM-3011 : Transacción no encontrada FM-3013 : Error de Validacion: [Campo Faltante] es Requerido FM-3017 : Error interno del Servidor FM-3018 : Tiempo de espera agotado en el servidor de Flota FM-3019 : No es posible anular una transacción Confirmada |
message | String | Detalle del tipo del error. |
Ejemplo:
{ "ack": 3008, "message": " Formato de JSON Invalido" } |
Servicio: Consulta de Transaccion (transactionGet)
Operación de consulta de Transacciones. Se deberá indicar el Codigo de Transaccion y Autorizacion del comprobante a consultar los datos.
Es un método REST basado en el formato JSON. Ejemplo:
[Get] http://[dirección-ip]:[puerto]/api/v1/transaction?fleetOperatorCode=SG&transactionCode=640 |
|---|
POST – REQUEST
HEADER
Elemento | Valor |
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE |
ACLARACIONES!!
Cabe aclarar que mientras la transacción exista, se podrá consultar sin importar en que estado este. Por eso el response de este servicio podrá cambiar según lo mencionado anteriormente.
A continuación se detallará todas las posibles respuestas:
RESPONSE OK - PREAUTORIZADA
| lemento | Descripcion | Tipo |
| requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto |
| fleetOperatorCode | Codigo del Operador de Flota Externo | String |
| serviceStationCode | Código de tienda. | String |
| posCode | Id de Pos | String |
| operatorCode | Id de Usuario | String |
| transaction | Objeto | |
| internalId | ID interno de transacción | String |
| transactionCode | Número único de transacción de flota para toda la red. | String |
state | Estado de la Transacción de flota. | String |
notifiedFleetOperator | Si la transaccion fue notificada al operador de flota(False) | Bool |
| preAuthorization | Objeto | |
| date | Fecha en que se realiza la Preautorización | dateTime |
| authorizationCode | Id Único de Transacción dado por PTS | String |
| authorizedAmount | Monto máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number |
| authorizedQuantity | Volumen máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number |
responseCode | Resultado de la operación, podrá tener los valores "A" (Aprobado) o "R" (Rechazado) o "P" (Parcial) | Char |
responseMessages | Texto Mostrar | String |
| invoice | Objeto | |
| invoiceDate | Fecha de Factura (factura realizada en el negocio de Flota - Prepago) | String |
| invoiceType | Tipo de Factura (1=Factura, 2=Boleta) | Char |
| cardNumber | PAN Enmascarado | String |
| prepaid | 1 = POS;2=PRE | Char |
| invoiceNumber | Numero Factura Prepago | String |
| voucher | Voucher de Impresión | String |
| customer | Objeto | |
| vehicleOdometer | Información ingresada por el usuario cuando requerida. | String |
| customerAddress | Dirección del Cliente | String |
| customerCity | Ciudad Cliente | String |
| customerMunicipality | Comuna Cliente | String |
| customerName | Nombre Cliente | String |
| customerDocumentNumber | RUT Cliente | String |
| vehiclePlate | Patente Vehiculo | String |
| history | JSON Array | |
| dateHistory | Fecha del movimiento | dateTime |
| state | Estado de la Transacción de flota. | String |
RESPONSE OK - CONFIRMADA
| Elemento | Descripcion | Tipo |
| requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto |
| fleetOperatorCode | Codigo del Operador de Flota Externo | String |
| serviceStationCode | Código de tienda. | String |
| posCode | Id de Pos | String |
| operatorCode | Id de Usuario | String |
operatorDescription | Descripción Usuario logueado | String |
| transaction | Objeto | |
| internalId | ID interno de transacción | String |
| transactionCode | Número único de transacción de flota para toda la red. | String |
notifiedFleetOperator | Si la transaccion fue notificada al operador de flota(False) | Bool |
| state | Estado de la Transacción de flota. | String |
| flagOffline | Flag que indica si la operación se confirmó por proceso de Store & Forward u online. False o True (Null=NO, 1=SI ) | String |
| preAuthorization | Objeto | |
| date | Fecha en que se realiza la Preautorización | dateTime |
| authorizationCode | Id Único de Transacción dado por PTS | String |
| authorizedAmount | Monto máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number |
| authorizedQuantity | Volumen máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number |
responseCode | Resultado de la operación, podrá tener los valores "A" (Aprobado) o "R" (Rechazado) o "P" (Parcial) | Char |
responseMessages | Texto Mostrar | String |
| invoice | Objeto | |
| invoiceDate | Fecha de Factura (factura realizada en el negocio de Flota - Prepago) | String |
| invoiceType | Tipo de Factura (1=Factura, 2=Boleta) | Char |
| cardNumber | PAN Enmascarado | String |
| prepaid | 1 = POS;2=PRE | Char |
| invoiceNumber | Numero Factura Prepago | String |
| voucher | Voucher de Impresión | String |
| customer | Objeto | |
| vehicleOdometer | Información ingresada por el usuario cuando requerida. | String |
| customerAddress | Dirección del Cliente | String |
| customerCity | Ciudad Cliente | String |
| customerMunicipality | Comuna Cliente | String |
| customerName | Nombre Cliente | String |
| customerDocumentNumber | RUT Cliente | String |
| vehiclePlate | Patente Vehiculo | String |
| confirmation | Objeto | |
| confirmationDate | YYYYMMDDHHMMSS | dateTime |
| documentType | Tipo de Documento Fiscal. Se enviará "GDE" | String |
| deliverCode | Número de Documento Fiscal (num de folio) | String |
| productId | Código Producto HE | Number |
| amount | Este valor dependerá del campo anterior TipoVenta. Para caso en que se quiera solicitar un despacho de "estanque lleno" se enviará el valor 0 (cero) como cantidad. | Number |
| unitPrice | Precio Unitario del producto seleccionado | Number |
| totalAmount | Importe Total de la venta | Number |
| deliverId | Id de Despacho | String |
| shiftId | Id de Turno | String |
| pumpId | Id de Surtidor | Number |
| history | JSON Array | |
| dateHistory | Fecha del movimiento | date |
| state | Estado de la Transacción de flota. | String |
RESPONSE OK - REVERSADA
| Elemento | Descripcion | Tipo | Requerido | Origen |
| requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto | ||
| fleetOperatorCode | Codigo del Operador de Flota Externo | String | SI | POS |
| serviceStationCode | Código de tienda. | String | SI | POS |
| posCode | Id de Pos | String | SI | preAuthorizationReq |
| operatorCode | Id de Usuario | String | SI | preAuthorizationReq |
| transaction | Objeto | |||
| internalId | ID interno de transacción | String | Interno | |
| transactionCode | Número único de transacción de flota para toda la red. | String | preAuthorizationReq | |
notifiedFleetOperator | Si la transaccion fue notificada al operador de flota(False) | Bool | SI | Interno |
| state | Estado de la Transacción de flota. | String | Interno | |
| flagOffline | Flag que indica si la operación se confirmó por proceso de Store & Forward u online. False o True (Null=NO, 1=SI ) | String | Interno | |
| preAuthorization | Objeto | |||
| date | Fecha en que se realiza la Preautorización | dateTime | SI | preAuthorizationReq |
| authorizationCode | Id Único de Transacción dado por PTS | String | SI | preAuthorizationRes |
| authorizedAmount | Monto máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number | SI | preAuthorizationRes |
| authorizedQuantity | Volumen máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number | SI | preAuthorizationRes |
responseCode | Resultado de la operación, podrá tener los valores "A" (Aprobado) o "R" (Rechazado) o "P" (Parcial) | Char | SI | |
responseMessages | Texto Mostrar | String | SI | |
| invoice | Objeto | SI | ||
| invoiceDate | Fecha de Factura (factura realizada en el negocio de Flota - Prepago) | String | SI | preAuthorizationRes |
| invoiceType | Tipo de Factura (1=Factura, 2=Boleta) | Char | SI | preAuthorizationRes |
| cardNumber | PAN Enmascarado | String | SI | preAuthorizationRes |
| prepaid | 1 = POS;2=PRE | Char | SI | preAuthorizationRes |
| invoiceNumber | Numero Factura Prepago | String | SI | preAuthorizationRes |
| voucher | Voucher de Impresión | String | SI | preAuthorizationRes |
| customer | Objeto | SI | ||
| vehicleOdometer | Información ingresada por el usuario cuando requerida. | String | SI | preAuthorizationRes |
| customerAddress | Dirección del Cliente | String | SI | preAuthorizationRes |
| customerCity | Ciudad Cliente | String | SI | preAuthorizationRes |
| customerMunicipality | Comuna Cliente | String | SI | preAuthorizationRes |
| customerName | Nombre Cliente | String | SI | preAuthorizationRes |
| customerDocumentNumber | RUT Cliente | String | SI | preAuthorizationRes |
| vehiclePlate | Patente Vehiculo | String | SI | preAuthorizationRes |
| reverse | Objeto | |||
| dateReverse | YYYYMMDDHHMMSS | String | reverseReq | |
| reasonId | ID del motivo de Reversa | String | reverseReq | |
| reasonDescription | Motivo de rechazo o cancelación cuando la transacción termina Rejected o Cancel. | String | reverseReq | |
| history | JSON Array | SI | ||
| dateHistory | Fecha del movimiento | date | SI | Interno |
| state | Estado de la Transacción de flota. | String | SI | Interno |
RESPONSE OK - CONFIRMADA OPERADOR FLOTA
| Elemento | Descripcion | Tipo |
| requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto |
| fleetOperatorCode | Codigo del Operador de Flota Externo | String |
| serviceStationCode | Código de tienda. | String |
| posCode | Id de Pos | String |
| operatorCode | Id de Usuario | String |
operatorDescription | Descripción Usuario logueado | String |
| transaction | Objeto | |
| internalId | ID interno de transacción | String |
| transactionCode | Número único de transacción de flota para toda la red. | String |
notifiedFleetOperator | Si la transaccion fue notificada al operador de flota | Bool |
| state | Estado de la Transacción de flota. | String |
| flagOffline | Flag que indica si la operación se confirmó por proceso de Store & Forward u online. False o True (Null=NO, 1=SI ) | String |
| preAuthorization | Objeto | |
| date | Fecha en que se realiza la Preautorización | dateTime |
| authorizationCode | Id Único de Transacción dado por PTS | String |
| authorizedAmount | Monto máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number |
| authorizedQuantity | Volumen máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number |
responseCode | Resultado de la operación, podrá tener los valores "A" (Aprobado) o "R" (Rechazado) o "P" (Parcial) | Char |
responseMessages | Texto Mostrar | String |
| invoice | Objeto | |
| invoiceDate | Fecha de Factura (factura realizada en el negocio de Flota - Prepago) | String |
| invoiceType | Tipo de Factura (1=Factura, 2=Boleta) | Char |
| cardNumber | PAN Enmascarado | String |
| prepaid | 1 = POS;2=PRE | Char |
| invoiceNumber | Numero Factura Prepago | String |
| voucher | Voucher de Impresión | String |
| customer | Objeto | |
| vehicleOdometer | Información ingresada por el usuario cuando requerida. | String |
| customerAddress | Dirección del Cliente | String |
| customerCity | Ciudad Cliente | String |
| customerMunicipality | Comuna Cliente | String |
| customerName | Nombre Cliente | String |
| customerDocumentNumber | RUT Cliente | String |
| vehiclePlate | Patente Vehiculo | String |
| confirmation | Objeto | |
| confirmationDate | YYYYMMDDHHMMSS | dateTime |
| documentType | Tipo de Documento Fiscal. Se enviará "GDE" | String |
| deliverCode | Número de Documento Fiscal (num de folio) | String |
| productId | Código Producto HE | Number |
| amount | Este valor dependerá del campo anterior TipoVenta. Para caso en que se quiera solicitar un despacho de "estanque lleno" se enviará el valor 0 (cero) como cantidad. | Number |
| unitPrice | Precio Unitario del producto seleccionado | Number |
| totalAmount | Importe Total de la venta | Number |
| deliverId | Id de Despacho | String |
| shiftId | Id de Turno | String |
| pumpId | Id de Surtidor | Number |
| history | JSON Array | |
| dateHistory | Fecha del movimiento | date |
| state | Estado de la Transacción de flota. | String |
| fleetOperatorResponse | Objeto | |
| status | estado de la respuesta del operador de flota | String |
| message | Mensaje de la respuesta del operador de flota | String |
RESPONSE OK - REVERSADA OPERADOR DE FLOTA
| Elemento | Descripcion | Tipo | Requerido | Origen |
| requestCredential | Detalle de la identificación de la terminal que solicita la autorización | Objeto | ||
| fleetOperatorCode | Codigo del Operador de Flota Externo | String | SI | POS |
| serviceStationCode | Código de tienda. | String | SI | POS |
| posCode | Id de Pos | String | SI | preAuthorizationReq |
| operatorCode | Id de Usuario | String | SI | preAuthorizationReq |
| transaction | Objeto | |||
| internalId | ID interno de transacción | String | Interno | |
| transactionCode | Número único de transacción de flota para toda la red. | String | preAuthorizationReq | |
notifiedFleetOperator | Si la transaccion fue notificada al operador de flota | Bool | SI | Interno |
| state | Estado de la Transacción de flota. | String | Interno | |
| flagOffline | Flag que indica si la operación se confirmó por proceso de Store & Forward u online. False o True (Null=NO, 1=SI ) | String | Interno | |
| preAuthorization | Objeto | |||
| date | Fecha en que se realiza la Preautorización | dateTime | SI | preAuthorizationReq |
| authorizationCode | Id Único de Transacción dado por PTS | String | SI | preAuthorizationRes |
| authorizedAmount | Monto máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number | SI | preAuthorizationRes |
| authorizedQuantity | Volumen máximo autorizado para el Cliente. Este campo vendrá con valor "0" en aquellos casos en que se rechace la Preventa por restricciones del Cliente, y no por una falta de saldo en sí; de esta manera HE sabrá que en ese caso no deberá ofrecer al Cliente despachar por menos cantidad. | Number | SI | preAuthorizationRes |
responseCode | Resultado de la operación, podrá tener los valores "A" (Aprobado) o "R" (Rechazado) o "P" (Parcial) | Char | SI | |
responseMessages | Texto Mostrar | String | SI | |
| invoice | Objeto | SI | ||
| invoiceDate | Fecha de Factura (factura realizada en el negocio de Flota - Prepago) | String | SI | preAuthorizationRes |
| invoiceType | Tipo de Factura (1=Factura, 2=Boleta) | Char | SI | preAuthorizationRes |
| cardNumber | PAN Enmascarado | String | SI | preAuthorizationRes |
| prepaid | 1 = POS;2=PRE | Char | SI | preAuthorizationRes |
| invoiceNumber | Numero Factura Prepago | String | SI | preAuthorizationRes |
| voucher | Voucher de Impresión | String | SI | preAuthorizationRes |
| customer | Objeto | SI | ||
| vehicleOdometer | Información ingresada por el usuario cuando requerida. | String | SI | preAuthorizationRes |
| customerAddress | Dirección del Cliente | String | SI | preAuthorizationRes |
| customerCity | Ciudad Cliente | String | SI | preAuthorizationRes |
| customerMunicipality | Comuna Cliente | String | SI | preAuthorizationRes |
| customerName | Nombre Cliente | String | SI | preAuthorizationRes |
| customerDocumentNumber | RUT Cliente | String | SI | preAuthorizationRes |
| vehiclePlate | Patente Vehiculo | String | SI | preAuthorizationRes |
| reverse | Objeto | |||
| dateReverse | YYYYMMDDHHMMSS | String | reverseReq | |
| reasonId | ID del motivo de Reversa | String | reverseReq | |
| reasonDescription | Motivo de rechazo o cancelación cuando la transacción termina Rejected o Cancel. | String | reverseReq | |
| history | JSON Array | SI | ||
| dateHistory | Fecha del movimiento | date | SI | Interno |
| state | Estado de la Transacción de flota. | String | SI | Interno |
| fleetOperatorResponse | Objeto | |||
| status | estado de la respuesta del operador de flota | String | ||
| message | Mensaje de la respuesta del operador de flota | String |
RESPONSE ERROR
Elemento | Tipo | Detalle |
ack | Number | |
message | String | Detalle del tipo del error. |
Ejemplo:
{ "ack": 3002, "message": " Se debe enviar un Access Token" } |
- Sem rótulos