DOCUMENTAÇÃO CORPORATIVA
Webhook Autorizar
POST URL
Headers
Content-Type | application/json |
Authorization | Api-Key |
Request Body application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
IdOrdemPagamento | Long | Código de Identificação da Ordem de Pagamento. | Sim |
Token | String | Token de Autorização disponibilizado previamente ao Representante do Solicitante (Comprador) para o qual a Ordem de Pagamento foi cadastrada. | Sim |
Quantidade | Decimal | Quantidade de Produtos Vendidos. | Sim |
IdentificadorPoduto | String | Identificador do Produto que foi Vendido. | Sim |
ValorUnitario | Decimal | Valor da Unidade do Produto que foi Vendido. | Sim |
ValorTotal | Decimal | Valor Total da Ordem de Pagamento. | Sim |
JSON:
{
"IdOrdemPagamento": 4123,
"Token": "KSG7S",
"Quantidade": 100.000,
"IdentificadorPoduto": "DSS10",
"ValorUnitario" : 5.000,
"ValorTotal": 500.000
}
Response Body application/json
Campo | Tipo | Descrição | Obrigatório |
IdOrdemPagamento | Long | Código de Identificação da Ordem de Pagamento. | Sim |
Mensagem | String | Mensagem indicando resultado da operação. | Não |
Detalhes | Object <Detalhe> | Dados da Ordem de Pagamento a serem apresentados para o Usuário. | Sim |
<Detalhes>:
Campo | Tipo | Descrição | Obrigatório |
Solicitante | String | Nome do Solicitante responsável pela Ordem de Pagamento. | Sim |
DescricaoProduto | String | Descrição do Produto liberado para essa Ordem de Pagamento, quando houver. | Sim |
QuantidadeIndefinida | Boolean | Indica se a Ordem de Pagamento não possui uma Quantidade Previamente Definida. Nesse caso, a venda será realizada respeitando a Quantidade Definida pelo Representante do Solicitante (Comprador), no momento da Compra. | Sim |
QuantidadeLiberada | Decimal | Quantidade liberada para compra. (Disponibilizado apenas para Ordens de Pagamento que não sejam Tanque Cheio) | Não |
JSON:
{
"IdOrdemPagamento": "128",
"Mensagem": "Ordem de Abastecimento Validada com Sucesso!",
"Detalhes": {
"Solicitante": "IS Transportes",
"DescricaoProduto": "Diesel",
"QuantidadeIndefinida": true,
"QuantidadeLiberada": 0.000
}
}