Este método é responsável pela consulta de credito online


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
DataLista de ObjetosLista com os créditos retornados
Data.saldodoubleSaldo do crédito
Data.IdRetaguardaCreditostringIdentificador do crédito na retaguarda
ErrorsLista de objetosLista de erros
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros
DetailedMessagestringMensagem detalhada de retorno de erros

{
  "success": true,
  "message": "string",
  "detailedMessage": "string",
  "data": [
    {
      "saldo": 0,
      "idRetaguardaCredito": "string"
    }
  ],
  "totalTime": 0,
  "numberOfRecords": 0
}

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataLista de ObjetosQuando erro essa lista vem nula
ErrorsLista de ObjetosLista de erros
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros
DetailedMessagestringMensagem detalhada de retorno de erros


{
    "success": false,
    "message": "sting",
    "detailedMessage": "sting",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}