DOCUMENTAÇÃO CORPORATIVA
Autorizar Ordem de Abastecimento
- Ivan Saavedra (Unlicensed)
- Larissa Oliveira (Unlicensed)
- Bruno Gorini (Unlicensed)
POST /api/broker/ordemabastecimento/autorizar
Endpoint responsável por Autorizar uma Ordem de Abastecimento através de um Token fornecido previamente ao Motorista para o qual a mesma foi cadastrada. Nesse momento todos os Parâmetros de Controle foram atendidos, necessitando apenas do Token e das informações do abastecimento para Autorização.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Request Body application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
NSU | Long | Número Sequencial Único (ID) referente a Transação do Parceiro. | Sim |
Localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. | Sim |
Token | String | Token de Autorização disponibilizado previamente ao Motorista para o qual a Ordem de Abastecimento foi cadastrada. | Sim |
ValorLitro | Decimal | Valor por Litro do Combustível que foi Abastecido. | Sim |
QuantidadeLitrosAbastecidos | Decimal | Quantidade de Litros que foram Abastecidos. | Sim |
IdentificadorCombustivel | String | Identificador do Combustível que foi utilizado nesse Abastecimento. | Sim |
IdRedeCredenciadaMetodoPagamento | Long | Autorizador referente ao Método de Pagamento em questão (Ordem de Abastecimento) | Sim |
JSON:
{
"nsu": 54856,
"localizador": "4123",
"token": "KSG7S",
"valorLitro": 3.900,
"quantidadeLitrosAbastecidos": 100.235,
"identificadorCombustivel": "DSS10",
"idRedeCredenciadaMetodoPagamento": 2,
}
Response Body application/json
Campo | Tipo | Descrição |
Localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. |
Mensagem | String | Mensagem indicando resultado da operação. |
Detalhes | Object <Detalhe> | Dados da Ordem de Abastecimento a serem apresentados para o Usuário. |
<Detalhes>:
Campo | Tipo | Descrição |
Solicitante | String | Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento. |
DescricaoCombustivel | String | Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver. |
ValorLitro | Decimal | Valor por Litro do Combustível em questão, cadastrado previamente pelo Posto de Combustível. |
DescontoNegociado | Decimal | Valor de Desconto Negociado previamente pelo Posto de Combustível e o Transportador/Frotista. |
ValorLitroNegociado | Decimal | Valor por Litro Negociado. No caso de não existir uma negociação prévia, constará o Valor por Litro cadastrado pelo Posto de Combustível. |
QuantidadeLitrosLiberada | Decimal | Quantidade de Litros liberados para abastecimento. (Disponibilizado apenas para Ordens de Abastecimento que não sejam Tanque Cheio) |
TanqueCheio | Boolean | Indica se a Ordem de Abastecimento é para Tanque Cheio. Nesse caso, o Valor Total da Ordem será a Quantidade de Litros Abastecidos multiplicado pelo Valor Litro Negociado (Disponibilizado nesse objeto) |
JSON:
{
"localizador": "42",
"mensagem": "Pagamento realizado com Sucesso!",
"detalhes": {
"solicitante": "IS Transportes",
"descricaoCombustivel": "Diesel",
"valorLitro": 3.800,
"descontoNegociado": 0.300,
"valorLitroNegociado": 3.500,
"quantidadeLitrosLiberada": 0.000,
"tanqueCheio": true
}
}