Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

4.1 Contrato de consulta de limite de crédito 

  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinelimitecredito/{IdInquilino}/{IdRetaguardaLoja}
  • Método: Get
  • Autenticação: Bearer token
  • Permissão: Client


Request:

Campo

Tipo

Descrição

Tipo Parâmetro

Obrigatório

Observação

IdInquilinostringIdentificador do InquilinoParameter/Path/Query ParamsSim

Usado apenas pelo PDV.

Retaguarda não precisa criar API com esse parâmetro

IdRetaguardaLojastringIdentificador da loja na retaguarda

Parameter/Path/Query Params

Sim


cpfCnpjstringDocumento do cliente

Header

Não


idRetaguardaCreditostringCódigo do crédito disponível do cliente

Header

Não



Response:

Campo

Tipo

Descrição

Obrigatório

Observação

successboolIndica se a requisição foi feita com sucessoSim
messagestringMensagem de retorno de errosNãoSempre que possível em caso de erro justificar o erro nesse campo.
limitesCreditoLista de objetosLista com dos limites de créditos retornadosNãoDeve ser enviado sempre que houver retorno de true no atributo "success".
limitesCredito.saldodoubleSaldo do créditoNãoDeve ser enviado sempre que houver retorno de true no atributo "success".
limitesCredito.idRetaguardaLimiteCreditostringIdentificador do limite de crédito caso existaNãoDeve 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 

...