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
CreditosLista de ObjetosLista com os créditos retornados
Creditos.saldodoubleSaldo do crédito
Credito.IdRetaguardaCreditostringIdentificador do crédito na retaguarda

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

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
CreditosObjetoObjeto de retorno


{
    "success": false,
    "message": "string",
    "creditos": null
}