Método responsável pela consulta de credito online: 

Ao realizarmos uma consulta na API de processoonlinecredito será possível verificar  o limite  de crédito, definido pela retaguarda, disponível para o consumidor  no momento da venda, inclusive por diferentes formas de pagamento, se configurado. 


Os parâmetros para a requisição estão abaixo

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


Retornos

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
creditosLista de ObjetosLista com os créditos retornados
creditos.saldodoubleSaldo do crédito
creditos.IdRetaguardaCreditostringIdentificador do crédito na retaguarda

{
  "success": true,
  "message": "string",
  "creditos": [
    {
      "saldo": 0,
      "idRetaguardaCredito": "string"
    }
  ]
}

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
creditosLista de ObjetosQuando erro essa lista vem nula


{
    "success": false,
    "message": "sting",
    "creditos": null,
    "errors": null
}