Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Permitir que o parceiro desenvolva uma API onde o PDV realizará a consulta de crédito. Essa operação ocorre no evento de pagamento da compra. Por favor, siga a documentação de configuração de ambiente para mais detalhes.

Chamada

POST {url}

Informações da Requisição (Request Information)

Segurança

Se os parâmetros de autenticação estiver configurado será enviado no Header no formato Basic Auth ou Bearer Token, siga a documentação de configuração para selecionar o modelo de autenticação.

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
idstringIdentificado único da requisição
versionstring

Versão da API

creditsArray object JsonLista de créditos
credits[0].itemNumberIntegerIdentificar do crédito
credits[0].idStoreIntegerNúmero da loja
credits[0].idTerminalIntegerNúmero do checkout
credits[0].idDocumentIntegerIdentificador da venda
credits[0].paymentNumberIntegerNúmero da forma de pagamento
credits[0].paymentTypeString

Espécie de pagamento

cptMoney - Espécie dinheiro;

cptDebitCard - Espécie cartão de débito;

cptCreditCard - Espécie cartão de crédito;

cptBillet - Espécie boleto;

cptCheck - Espécie cheque;

cptPOS - Espécie  POS;
cptPaperTicket - Espécie ticket;

cptAgreement - Espécie convênio;

cptPromissoryNote - Espécie nota promissório;

cptFinancialCredit - Espécie crédito financeira;

cptWorthDebit - Espécie vale débito;
cptWorthCredit - Espécie vale crédito;

cptDigitalWallet - Espécie carteira digital;

credits[0].parcelNumberIntegerNúmero de parcelas
credits[0].totalValueCurrencyValor do crédito a ser utilizado
credits[0].orderNumberInt64Número da pré-venda
credits[0].limitControlString

Tipo de controle do crédito

lctNo - Não controla;

lctAgreement - Convênio;

lctAccumulatedAgreement - Convênio acumulado;

lctGlobalPerson - Pessoa global;

lctCustomer - Cliente;

lctIssuer - Emitente;

lctIntegrated - Integrado;

lctCustom - Personalizado;

credits[0].cardNumberIntegerNúmero do cartão
credits[0].billingBaseDateData
Data base de cobrança
credits[0].minimumParcelValueCurrencyValor mínimo da parcela
credits[0].identificationsArray object JsonLista dos tipos de documento
credits[0].identifications[0].documentStringDocumentos
credits[0].identifications[0].documentTypeString

Tipos de documentos

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIE -  Inscrição estadual

cdtRG - RG

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

{
  "id":"{F7D91806-0F9C-4E1F-AC62-77B41C4D8A45}",
  "version":1,
  "credits":[
    {
      "itemNumber":0,
      "idStore":1,
      "idTerminal":32,
      "idDocument":942959,
      "paymentNumber":3,
      "paymentType":"cptBillet",
      "parcelNumber":1,
      "totalValue":20,
      "limitControl":"lctNo",
      "cardNumber":0,
      "billingBaseDate":0,
      "minimumParcelValue":0,
      "identifications":[
        {"document":"12345678909",
         "documentType":"cdtCPF"
        },
        {"document":"1000000020",
         "documentType":"cdtIDInternal"
        }
      ]
    }
  ]
}

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)


PARÂMETROTIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
idstring

Identificado único da resposta
versionInteger

Número da versão
creditsArray object Json

Lista de créditos
credits[0].itemNumberInteger
TrueIdentificador do crédito, precisa ser o mesmo enviado no request
credits[0].creditStatusString
true

Situação do crédito

cstReleased - Liberado; 
cstBlocked - Bloqueado;
cstSuspended - Suspenso;
cstInactive - Inativo;
cstAnalysis - Analise;

credits[0].AvailableValueDouble12, 2trueValor disponível (Limite)
credits[0].UsedValueDouble12, 2trueValor utilizado
credits[0].BalanceValueDouble12, 2true

Valor do saldo (Valor disponível - Valor utilizado)

Esse campo que será validado no PDV nas rotinas de crédito

returnCodeString
true

Código de retorno

rctCreditReleased -  Credito liberado;
rctWithoutBalance - Sem saldo;
rctUnknown - Retorno desconhecido;
rctBlockedCredit - Credito bloqueado;
rctSuspendedCredit - Credito suspenso;
rctInactiveCredit - Credito inativo;
rctAnalysisCredit - Credito em analise;
rctCardDoesNotExist - Cartao não existe;
rctPeriodDoesNotExist - Periodo não existe;
rctPersonDoesNotExist - Pessoa não existe;
rctInactivePerson - Pessoa inativa;
rctCustomerDoesNotExist - Cliente não existe;
rctInactiveCustomer - Cliente inativo;
rctPaymentFormDoesNotExist - Forma de pagamento não existe;
rctInactivePaymentForm - Forma de pagamento inativa;
rctWithoutParcelBalance - Sem saldo parcelado;
rctCommercialBlocked - Comercial bloqueado;

credits[0].ReturnMessageString40trueMensagem de retorno
credits[0].ParcelValueDouble12, 2false*Valor da parcela (obrigatório no controle por Convênio)
credits[0].AvailableParcelValueDouble12, 2false*Valor parcelado disponível (obrigatório no controle por Convênio)
credits[0].UsedParcelValueDouble12, 2false*Valor parcelado utilizado (obrigatório no controle por Convênio)

Formatos de Resposta (Response Formats)

application/json

Exemplo simplificado (Sample)

{
  "id":"{A1B8E3D3-CE2E-4D8A-9BCD-2A4DEF37251E}",
  "version":1,
  "Credits":[
    {
      "itemNumber":0,
      "creditStatus":"cstAnalysis",
      "availableValue":100,
      "usedValue":500,
      "balanceValue":500,
      "returnCode":"rctAnalysisCredit",
      "returnMessage":"CREDITO EM ANALISE",
      "parcelValue":0,
      "availableParcelValue":0,
      "usedParcelValue":0
    }
  ]
}