Árvore de páginas

Versões comparadas

Chave

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

...

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

Campo

Tipo

Descrição

Tipo Parâmetro

Obrigatório

IdInquilinostringIdentificador do InquilinoParameterSim
IdRetaguardaLojastringIdentificador da loja na retaguarda

Parameter

Sim

cpfCnpjstringDocumento do cliente

Header

Não

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

Header

Não

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

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
Card
labelJson

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

Card
label400 - Bad Request

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
}