DOCUMENTAÇÃO CORPORATIVA
Webhook Localizar
GET URL/{localizador}
Headers
Content-Type | application/json |
Authorization | Api-Key |
Request Query String application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
IdOrdemPagamento | String | Código de Identificação da Ordem de Pagamento. | Sim |
Response Body application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
Validada | Boolean | Indica se a Ordem de Pagamento já se encontra Validada. | Sim |
IdentificadorProduto | String | Identificador do Produto liberado para essa Ordem de Pagamento, quando houver. | Sim |
Campos | Array of Objects <Campo> | Dados solicitados pelo Parceiro, para serem Capturados e Validados durante o processo de Pagamento. | Sim |
Detalhes | Object <Detalhes> | Detalhes da Ordem de Pagamento. | Sim |
<Campo>:
Campo | Tipo | Descrição | Obrigatório |
Chave | String | Chave do Campo, que será enviada no momento da Validação. | Sim |
Descricao | String | Descrição do Campo para ser utilizado como Legenda/Label. | Sim |
Tipo | String | Tipo do Campo que será apresentado. Tipos esperados:
| Sim |
IdentificadorTipo | Integer | Identificador do Tipo do Campo. | Sim |
Obrigatorio | Boolean | Booleana que identifica se o Campo é obrigatório. | Sim |
Precisao | Int32 | Precisão do Campo. Apenas válido para Campos Decimais. | Não |
ValorMinimo | Decimal | Valor Mínimo do Campo. Válido para campos Numéricos. | Não |
ValorMaximo | Decimal | Valor Máximo do Campo. Válido para Campos Numéricos. | Não |
MaxLength | Int32 | Tamanho máximo do Campo. Válido para Campos de Texto. | Não |
SomenteNumeros | Boolean | Booleana que indica que o input precisa aceitar somente números. | Não |
Dominio | Array Of Objects <Item> | Domínio de dados, obrigatórios para os Tipos SingleSelect (5) e MultiSelect (6). | Não |
<Item>:
Campo | Tipo | Descrição |
Valor | String | Valor do Item que será disponibilizado no Select. |
Descricao | String | Descrição do Item, quer deverá ser apresentado no Select. |
<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:
{
"Validada": false,
"IdentificadorProduto": "DSLCM",
"Campos": [
{
"Chave": "23",
"Descricao": "Hodômetro",
"Tipo": "integer",
"IdentificadorTipo": 2,
"Obrigatorio": true
},
{
"Chave": "24",
"Descricao": "Placa",
"Tipo": "string",
"IdentificadorTipo": 1,
"Obrigatorio": true,
"MaxLength": 9
}
],
"Detalhes": {
"Solicitante": "IS Transportes",
"DescricaoProduto": "Diesel",
"QuantidadeIndefinida": true,
"QuantidadeLiberada": 0.000,
}
}