Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Permitir que o parceiro desenvolva uma API onde o PDV realizará a consulta de créditos para fazer pagamento de venda. Por favor, siga a documentação de configuração de ambiente para mais detalhes.

Chamada

POST {url}

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.

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

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
idstringIdentificado único da requisição
versionstringVersão da API
operationstring

Operação 
opConsult - Consultar

opReserve - Reservar

opFinish - Baixar

opCancel - Estorno

headerObject Json

Cabeçalho da requisição

header.idDocumentInteger

Número da venda

header.idStoreInteger

Número da empresa

header.idTerminalInteger

Número do chekout

header.taxDocumentInteger

Número do documento fiscal (NFC-e, CFE, COO)

consultObject Json

Dados para realizar a consulta

consult.identificationsArray object Json

Lista de documentos

consult.identifications[0].documentstring

Documento

consult.identifications[0].documentTypestring

Tipo do documento

cdtNumberCredit- Número do crédito

citInternal- Código do cliente (Seqpessoa)


Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)


{
   "id":"{92C7BEBB-511F-4D36-B51F-7ABC63ADA13A}",
   "version":"1.0",
   "operation":"opConsult",
   "header":{
      "idDocument":1094880,
      "idStore":1,
      "idTerminal":32,
      "taxdocument":12300 
   },
   "consult":{
      "identifications":[
         {
            "document":"123456789",
            "documentType":"cdtNumberCredit"
         },
          {
            "document":"1526",
            "documentType":"citInternal"
         }
        ]
   }
}

Informações para Resposta - Operação consulta (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO

TIPO

TAMANHO

OBRIGATÓRIO

DESCRIÇÃO

idstring

Identificado único da resposta
versionInteger

Número da versão
CreditsArray object Json

Lista de créditos
Credits[0].IdCreditInteger15SimIdentificador do crédito
Credits[0].idPersonInteger10SimIdentificador da pessoa do crédito
Credits[0].dateTimeIssueDatatime
SimData de emissão
Credits[0].openAmountDouble9.2SimValor para ser utilizado
Credits[0].KindString6SimEspécie do crédito
StatusObject Json

Status do cédito
Status.TypeString
Sim

Status do crédito

stSuccess - Sucesso

stException - Falha

Status.MessageString50Não

Mensagem para mostra no PDV, caso ocorra uma exceção.

Formatos de Resposta (Response Formats)

application/json

Exemplo (Sample)


{
   "id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
   "version":1,
   "Credits":[
      {
         "IdCredit":1233,
         "idPerson":123456,
         "dateTimeIssue":"2023-01-15T00:00:00.000Z",
         "openAmount":100.00,
         "Kind":"DUPP"
      }
   ],
   "Status":{
      "Type":"stSuccess",
      "Message":""
   }
}


Informações da Requisição - Operações reservar, baixar e estorno  (Request Information)

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
idstringIdentificado único da requisição
versionstringVersão da API
operationstring

Operação 
opConsult - Consultar

opReserve - Reservar

opFinish - Baixar

opCancel - Estorno

headerObject Json

Cabeçalho da requisição

header.idDocumentInteger

Número da venda

header.idStoreInteger

Número da empresa

Credits[0].IdCreditIntegerIdentificador do crédito
Credits[0].dateTimeIssueDatatimeData de emissão
Credits[0].amountPaidDoubleValor utilizado da venda

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)


{
   "id":"{B2DBF307-03B3-44CA-B4E1-FFABC860E85F}",
   "version":"1.0",
   "operation":"opReserve",
   "header":{
      "idDocument":1094880,
      "idStore":1,
      "idTerminal":32,
      "taxdocument":12300 

   },
   "credits":[
      {
         "idCredit":1233,
         "dateTimeIssue":"1899-12-30T00:00:00.000Z",
         "amountPaid":30
      }
   ]
}

Informações para Resposta - operações reversar, baixar e estorno (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO

TIPO

TAMANHO

OBRIGATÓRIO

DESCRIÇÃO

idstring

Identificado único da resposta
versionInteger

Número da versão
StatusObject Json

Status do cédito
Status.TypeString
Sim

Status do crédito

stSuccess - Sucesso

stException - Falha

Status.MessageString50NãoMensagem para mostra no PDV, caso ocorra uma exceção.

Formatos de Resposta (Response Formats)

application/json

Exemplo (Sample)

{
   "id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
   "version":1,
   "Status":{
      "Type":"stSuccess",
      "Message":""
   }
}


Informações para resposta com emissão dos comprovantes no PDV - operações de baixar e estorno (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO

TIPO

TAMANHO

OBRIGATÓRIO

DESCRIÇÃO

idstring

Identificado único da resposta
versionInteger

Número da versão
StatusObject Json

Status do cédito
Status.TypeString
Sim

Status do crédito

stSuccess - Sucesso

stException - Falha

Status.MessageString50NãoMensagem para mostra no PDV, caso ocorra uma exceção.
TemplatesPrintObject Json

Comprovantes para impressão
TemplatesPrint[0].TextString3000NãoTexto que será impresso pela impressora

Formatos de Resposta (Response Formats)

application/json

Exemplo (Sample)

{
   "id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
   "version":1,
   "Status":{
      "Type":"stSuccess",
      "Message":""
   },
   "TemplatesPrint": [
		{
			"Text": "RECEBO PAGAMENTO, CONVENIO: \r\n\r\n   N. 100, Vlr. Compra: 99,99\r\n"
		},
		{
			"Text": "SEGUNDA via cliente \r\n\r\n  RECEBO PAGAMENTO, CONVENIO: \r\n\r\n   N. 100, Vlr. Compra: 99,99\r\n"
		}
	] 
}