TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela consulta online de limite de crédito por cliente

Ao realizarmos uma consulta na API de processoonlinelimitecredito, será possível verificar o limite  de crédito disponível,  para o consumidor, no momento da venda, inclusive por diferentes formas de pagamento, quando solicitado.


  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinelimitecredito/{idInquilino}/{idRetaguardaLoja}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Client

Pré-requisitos: Preenchimento correto dos dois campos, abaixo, no METADATA do inquilino.

Endpoint FormasCondicoesCliente: Exemplo.:  /URL/payments/pdvsync
Endpoint LimiteCredito: Exemplo.: /api/limitecredito

Os parâmetros desta requisição são enviados através do header, abaixo estão listados os parâmetros:

ParametroDescriçãoTipoObrigatórioObservação
idInquilinoIdentificador do inquilinoStringSimInformado na Url
idRetaguardaLojaIdentificador da loja da retaguardaStringSimInformado na Url
cpfCnpjCPF / CNPJStringSimParâmetro do tipo Header
limitePagamentoForma Utilizado para solicitar limites detalhados por forma de pagamentoBooleanNãoParâmetro do tipo Header

Retornos

    Campo

    Tipo

    Descrição
    success Booleano Indica se a requisição retornou sucesso
    message String Campo com as mensagens de erro
    detailedmessage string Mensagem detalhada de erros(Retaguarda)
    data Lista de Objeto Lista dos limites de créditos retornados
    data.saldoDisponivel String Saldo do crédito disponível
    data.idRetaguardaLimiteCredito Double Identificador do limite de crédito caso exista
    data.saldoDetalhadoFormaPagamento Lista de objetos Lista com os limites de créditos retornados por forma de pagamento
    data.saldoDetalhadoFormaPagamento.valor Double Valor por forma de pagamento do limite de crédito
    data.saldoDetalhadoFormaPagamento.idRetaguardaPagamentoForma String idRetaguarda relacionado ao tipo de forma de pagamento disponível para o limite de crédito.


    {
        "success": true,
        "message": "",
        "detailedMessage: null,
        "data": [
            {
                "saldoDisponivel": 1090.0,
                "idRetaguardaLimiteCredito": "00001",

                 "saldoDetalhadoFormaPagamento":
                [
                   {
                    "valor": 500.00,
                    "idRetaguardaPagamentoForma": "BL"
                   },
                   {
                    "valor": 500.00,
                    "idRetaguardaPagamentoForma": "CH"
                  }
              ]
            }
        ],
        "errors": null,
        "totalTime": 0,
        "numbersOfRecords": 0
    }

    Campo

    Tipo

    Descrição

    Observação
    Success bool Indica se a requisição foi feita com sucesso
    Message string Mensagem de retorno de erros
    detailedMessage String Mensagem detalhada de erros Em caso de erro detalhar o erro nesse campo.
    Data Objeto Objeto de retorno
    Errors Lista de objetos Lista de erros Somente é retornado na V3
    TotalTime Int Tempo total da requisição
    NumberOfRecords Int Número de registros


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





    • Sem rótulos