...
4.1 Contrato de consulta de limite de crédito
Request:
Campo | Tipo | Descrição | Tipo Parâmetro | Obrigatório | Observação |
---|---|---|---|---|---|
IdInquilino | string | Identificador do Inquilino | Parameter/Path/Query Params | Sim | Usado apenas pelo PDV. Retaguarda não precisa criar API com esse parâmetro |
IdRetaguardaLoja | string | Identificador da loja na retaguarda | Parameter/Path/Query Params | Sim | |
cpfCnpj | string | Documento do cliente | Header | Não | |
idRetaguardaCredito | string | Código do crédito disponível do cliente | Header | Não |
Response:
Campo | Tipo | Descrição | Obrigatório | Observação |
---|---|---|---|---|
success | bool | Indica se a requisição foi feita com sucesso | Sim | |
message | string | Mensagem de retorno de erros | Não | Sempre que possível em caso de erro justificar o erro nesse campo. |
limitesCredito | Lista de objetos | Lista com dos limites de créditos retornados | Não | Deve ser enviado sempre que houver retorno de true no atributo "success". |
limitesCredito.saldo | double | Saldo do crédito | Não | Deve ser enviado sempre que houver retorno de true no atributo "success". |
limitesCredito.idRetaguardaLimiteCredito | string | Identificador do limite de crédito caso exista | Não | Deve ser enviado sempre que houver retorno de true no atributo "success". |
Exemplos
Sucesso:
{
"success": true,
"message": null,
"limitesCredito":
[
{
"saldo": 1000.00 ,
"idRetaguardaLimiteCredito": null
}
]
}
Erro:
{
"success": false,
"message": "Cliente com XPTO não encontrado na base de dados da retaguarda"
}
4.2 Contrato descida de dado forma de pagamento
...