Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- integracoes:api-pagamento [28/11/2019 21:19]
jefferson.araujo [ENDPOINT PESQUISAR DÉBITOS PARA EMISSÃO DE EXTRATO]
+++ integracoes:api-pagamento [22/11/2023 13:20] (atual)
moises.simoes [FLUXO DE ERRO PADRÃO]
@@ Linha 80: / Linha 80: @@
   * **client_id**: CREDENCIADA
   * **client_secret**: <HASH 256b>
 ==== ENDPOINT CONSULTAR DÉBITOS ====
-Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
+Usar [[:integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
-POST(autenticar): http://gsan.consensotec.com.br:8120/gsan/api/pagamentos/debitos
+POST(autenticar): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/debitos|HTTPS://ENDPOINTALVO:PORTA/gsan/api/debitos]]
 JSON de consulta:
@@ Linha 92: / Linha 93: @@
  {documento:"21469517000102"}
 </code>
-Resposta:
+OU
+<code javascript>
+ {matricula:"99999"}
+</code>
+  Resposta:
 <code javascript>
 {
+   matricula: 99999,
    nome: "EMPRESA DE EXEMPLO",
    documento: "21469517000102",
    debitos:    [
-            {
+      {
          id: "C#76108553",
          tipoDebito: "CONTA",
+         valorOriginal: 3109.00,
          valorDebito: 3199.35,
+         valorAcrescimos: 90.35,
          validadeDebito: "20180513",
+         referencia: "04/2018",
          descricao: "REFERENCIA 04/2018"
       },
-            {
+      {
          id: "G#527414",
          tipoDebito: "GUIA",
+         valorOriginal: 32.5,
+         valorAcrescimos: 0.00,
          valorDebito: 32.5,
          validadeDebito: "20181129",
+         referencia: "04/2018",
          descricao: "CADASTRO LIG AGUA MED IND"
+      },
+      {
+         id: "D#72478737",
+         tipoDebito: "DEBITO A COBRAR",
+         valorOriginal: 1.98,
+         valorAcrescimos: 0.00,
+         valorDebito: 1.98,
+         referencia: "04/2018",
+         descricao: "MULTA P/IMPONTUALIDADE PRESTACAO:0/1"
       }
    ]
@@ Linha 117: / Linha 140: @@
-==== ENDPOINT EMITIR DÉBITOS ====
-Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
-POST(autenticar): http://gsan.consensotec.com.br:8120/gsan/api/pagamentos/emitirDebitosPagamento
-JSON de consulta:
-<code javascript>
-      {
-   documento: "21469517000102",
-   debitos:    [
-            {
-         id: "C#76682203"
-      },
-            {
-         id: "G#527414"
-      }
-     ]
-       }
-</code>
-Resposta:
-<code javascript>
-{
-   nome: "EMPRESA DE EXEMPLO",
-   documento: "21469517000102",
-   debitos:    [
-            {
-         id: "C#76682203",
-         codigoBarras: "826700000225121900410014000950661017052018900036",
-         valorDebito: 2212.19,
-         validadeDebito: "20180613"
-      },
-            {
-         id: "G#527414",
-         codigoBarras: "826800000018290000410016006375123004040420700193",
-         valorDebito: 32.5,
-         validadeDebito: "20181129"
-      }
-   ]
-}
-</code>
 ==== ENDPOINT PESQUISAR DÉBITOS PARA EMISSÃO DE EXTRATO ====
@@ Linha 165: / Linha 145: @@
 Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
-  * POST (autenticar): http://gsan.consensotec.com.br:8120/gsan/api/pagamentos/extrato/debitos
+  * POST (autenticar): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/debitos
 JSON de consulta:
@@ Linha 204: / Linha 184: @@
 Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
-  * POST(autenticar): http://gsan.consensotec.com.br:8120/gsan/api/pagamentos/extrato/emitir
+  * POST(autenticar): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/emitir
-  * POST chatbot: http://gsan.consensotec.com.br:8120/gsan/api/chatbot/extrato/emitir
 O débito gerado neste endpoint deve ser notificado no ENDPOINT NOTIFICAR PAGAMENTOS. Não devem ser notificados os débitos retornados no ENDPOINT PESQUISAR DÉBITOS PARA EMISSÃO DE EXTRATO.
@@ Linha 232: / Linha 211: @@
       valorDebito: 125.17
    }]
+}
+</code>
+==== ENDPOINT DESCONTO EXTRATO ====
+Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
+  * POST(autenticar): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/desconto
+Esse endpoint não gera débito. Apenas retorna a matrícula e o valor de desconto com base nos débitos passados jo JSON de entrada.
+JSON de consulta:
+<code javascript>
+{
+   matricula:777985,
+   debitos: [
+            {
+         id: "C#74481982"
+      },{
+         id: "G#472527"
+      }
+   ]
+}
+</code>
+Resposta:
+<code javascript>
+{
+   matricula: 777985,
+   valorDesconto: 25.17
 }
 </code>
@@ Linha 241: / Linha 250: @@
 Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
-POST(autenticar): http://gsan.consensotec.com.br:8120/gsan/api/pagamentos/notificarPagamento
+POST(autenticar): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/notificarPagamento
 JSON de Consulta:
@@ Linha 247: / Linha 256: @@
 {
    identificacaoTransacao: "5462158456512",
+   tipoCartao: "creditoAVista",
    debitos:    [
             {
@@ Linha 254: / Linha 264: @@
             {
          id: "G#408204",
+	 autenticacao: "6565163516516574654361351351351354531"
+      }
+   ]
+}
+</code>
+<code javascript>
+{
+   identificacaoTransacao: "5462158456512",
+   tipoCartao: "debito",
+   debitos:    [
+            {
+         id: "C#78422196",
+	 autenticacao: "JHAJl765765765"
+      },
+            {
+         id: "G#408204",
+	 autenticacao: "6565163516516574654361351351351354531"
+      }
+   ]
+}
+</code>
+<code javascript>
+{
+   identificacaoTransacao: "5462158456512",
+   tipoCartao: "creditoParcelado",
+   debitos:    [
+            {
+         id: "E#408204",
 	 autenticacao: "6565163516516574654361351351351354531"
       }
@@ Linha 264: / Linha 304: @@
 {status: "OK"}
 </code>
+==== ENDPOINT NOTIFICAR CANCELAMENTO DE PAGAMENTO ====
+Usar [[integracoes:api-pagamento#endpoint_notificar_pagamentos|FLUXO DE ERRO PADRÃO]]
+POST(autenticar): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/notificarPagamento
+JSON de Consulta:
+<code javascript>
+{
+   identificacaoTransacao: "5462158456512",
+   status: "chargeback",
+   debitos:    [
+            {
+         id: "C#78422196",
+	 autenticacao: "JHAJl765765765"
+      },
+            {
+         id: "G#408204",
+	 autenticacao: "6565163516516574654361351351351354531"
+      }
+   ]
+}
+</code>
+Resposta:
+<code javascript>
+{status: "OK"}
+</code>
@@ Linha 269: / Linha 340: @@
 ==== ENDPOINT OBTER URL CHECKOUT ====
-GET: http://gsan.consensotec.com.br:8120/gsan/api/pagamentos/obterUrlCheckoutEmpresaPagamento
+GET: HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/obterUrlCheckoutEmpresaPagamento
 Parâmetros de Consulta:
@@ Linha 283: / Linha 354: @@
   url: "https://example.com/?param=fsdfsdf5454f35s4df5sd4f",
   erro: false
+}
+</code>
+**Obs.:** Este endpoint realiza um POST para o endpoint(com o token para acessar este endpoint) disponibilizado pela EMPRESA CREDENCIADA, passando como parâmetros:
+  * codigoBarras = código de barras do documento
+  * matricula = matrícula do imóvel **[Opcional]**
+  * documento =  cpf/cnpj do cliente **[Opcional]**
+  * nome = Nome do cliente **[Opcional]**
+  * id = identificação do débito fornecido pela API de emitir débito. **[Opcional]**
+JSON Resposta:
+<code javascript>
+{
+  url: "https://example.com/?param=fsdfsdf5454f35s4df5sd4f"
 }
 </code>
@@ Linha 297: / Linha 383: @@
 {erro: {
    cod: 3,
-   msg: "EMPRESAO NAO CADASTRADA"
+   msg: "EMPRESA NAO CADASTRADA"
 }}
 </code>
@@ Linha 307: / Linha 393: @@
 |1|client_id obrigatório|
 |2|client_secret obrigatório|
-|3|EMPRESAO NAO CADASTRADA|
+|3|EMPRESA NAO CADASTRADA|
 |4|chave inválida|
 |100|variável documento inexistente|
@@ Linha 326: / Linha 412: @@
 |115|imóvel não cadastrado|
 |116|extrato não permitido para imóvel|
+|117|variável credenciada inexistente|
+|118|matrícula obrigatória|
+|119|matrícula inválida|
+|120| pagamento inexistente|
+|121|Este imóvel não tem perfil |
+|122|Já existe pagamento para documento |
 ----
@@ Linha 425: / Linha 517: @@
 >> e – Telefone sem fatura/guia de arrecadação \\
 >> f – Outros meios sem fatura/guia de arrecadação \\
+> 7 – Casas lotéricas com fatura/guia de arrecadação
+> 8 - Cartão/Multibanco com fatura/guia de arrecadação
+> <color red>**9 – PIX com fatura/guia de arrecadação**</color>
+>> <color red>a – Guichê de Caixa sem fatura/guia de arrecadação</color>
+>> <color red>b – Arrecadação Eletrônica sem fatura/guia de arrecadação (terminais de auto - atendimento, ATM, home banking)</color>
+>> <color red>c – Internet/mobile sem fatura/guia de arrecadação</color>
+>> <color red>d – Correspondentes bancários sem fatura/guia de arrecadação</color>
+>> <color red>e – Telefone sem fatura/guia de arrecadação</color>
+>> <color red>f – Outros meios sem fatura/guia de arrecadação</color>
+>> <color red>g – Casas lotéricas sem fatura/guia de arrecadação</color>
+>> <color red>h – Cartão/Multibanco sem fatura/guia de arrecadação</color>
+>> <color red>i – PIX sem fatura/guia de arrecadação</color>
 G.11 – Número de autenticação caixa ou código de transação (será informado desde que acordado entre as
 partes). \\

Base de Conhecimento de Gestão Comercial de Saneamento

Ferramentas do usuário

Ferramentas do site

Diferenças

Ferramentas da página