Reembolsos
Descrição dos campos associados a um evento de Reembolso de um título comprado a bordo do veículo.
O que é um Reembolso?
Reembolso é um evento referente a uma devolução de uma compra de um título de bordo de uma viagem. Esse evento é transmitido como transação APEX do tipo refund, com um conjunto de campos próprios que caracterizam um evento desse tipo.
Estrutura
Campos que caracterizam um evento do tipo APEX on-board-refund:
| Nome do campo | Tipo de dado | Descrição |
|---|---|---|
| id | GUID | Identificador único da transação de reembolso. |
| agency_id | Identificador único do Operador. | |
| apex_version | Versão do protocolo APEX utilizado para comunicar a transação. | |
| block_id | Identificação do plano de trabalho de um veículo. Placa - Conjunto de Circulações, Deslocações em Vazio e Tempos de Reserva cumpridos por um mesmo veículo. | |
| card_physical_type | ENUM | Tipo de suporte físico do cartão do passageiro. |
| card_serial_number | Número de série identificador do cartão associado à transação. | |
| created_at | UNIX Timestamp em milisegundos do momento em que a transação foi criada no equipamento local. | |
| device_id | GUID | Identificador único do equipamento que regista a transação APEX de reembolso. |
| duty_id | Identificação do plano de trabalho de um motorista/maquinista. Chapa - Conjunto de Circulações, Deslocações em Vazio e Tempos de Reserva em que intervém um mesmo motorista. | |
| line_id | Identificador da linha em que ocorreu a transação. | |
| mac_ase_counter_value | Valor no contador de transações APEX feitos pelo cartão SAM que se encontra no equipamento que regista a venda. | |
| mac_sam_serial_number | Número de série do cartão SAM que se encontra no equipamento que regista a venda. | |
| on_board_sale_id | Identificador da venda do título de bordo a que o reembolso está associado. | |
| pattern_id | Código de identificação do percurso de viagem associado ao reembolso. | |
| payment_method | ENUM | Modo de pagamento do reembolso. |
| price | Preço em céntimos de EUR, associado à transação. O valor é negativo devido a ser uma operação de reembolso. | |
| product_long_id | STRING | Identificador do produto, ou seja, do tipo de título da viagem que está a ser reembolsada. |
| product_quantity | NUM | Número de unidades vendidas/carregadas no cartão reembolsadas. |
| received_at | UNIX Timestamp em milisegundos do momento em que a transação foi recebida na central de base de dados. | |
| stop_id | Identificador único da paragem. | |
| trip_id | Identificador único da trip de um determinado plano de operação de um determinado operador. | |
| updated_at | UNIX Timestamp em milisegundos da última atualização deste refund. | |
| validation_id | Identificador único da validação. | |
| vehicle_id | Identificador do veículo, unívoco por operador. |
Exemplo
Aqui está um exemplo de uma transação APEX de on-board-refund:
{
{
"_id": "68AFE9AB-0039-40AE-AE60-C81928018307",
"agency_id": "42",
"apex_version": "3.2.0",
"block_id": null,
"card_physical_type": 28,
"card_serial_number": "0000000000000000",
"created_at": 1756359083000,
"device_id": "sibelius_35400000694",
"duty_id": null,
"line_id": "2803",
"mac_ase_counter_value": 99079,
"mac_sam_serial_number": 2932349224,
"on_board_sale_id": "68AFE99D-0035-40AE-B2F0-C81928018305",
"pattern_id": "2803_1_1",
"payment_method": 2,
"price": -450,
"product_long_id": "id-prod-tarifa-rapida",
"product_quantity": 1,
"received_at": 1756359166159,
"stop_id": "080122",
"trip_id": "2803_1_1|140|3|0615",
"updated_at": 1756391423979,
"validation_id": "68AFE9A0-0037-40AE-A4F0-C81928018306",
"vehicle_id": 1057
}
}