Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:api-pagamento

Diferenças

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

Link para esta página de comparações

Ambos lados da revisão anteriorRevisão anterior
Próxima revisão
Revisão anterior
integracoes:api-pagamento [05/02/2025 17:42] – [Fluxo de Pagamento por Cartão] sara.valongointegracoes:api-pagamento [20/08/2025 11:44] (atual) – [Autenticação] moises.simoes
Linha 9: Linha 9:
 Este documento é direcionado para empresas administradoras de serviços de pagamento por cartão que necessitem integrar o GSAN com seu portfólio de serviços financeiros. Este documento é direcionado para empresas administradoras de serviços de pagamento por cartão que necessitem integrar o GSAN com seu portfólio de serviços financeiros.
  
-A API possui o recurso de segurança através de token, facilitando a habilitação e desabilitação de novos parceiros. Utiliza plataforma REST com simples, utilizando JSON como protocolo padrão. </columns>+A API possui o recurso de segurança através de token, facilitando a habilitação e desabilitação de novos parceiros. Utiliza arquitetura REST em suas APIs. </columns> 
  
 ===== Fluxo de Pagamento por Cartão ===== ===== Fluxo de Pagamento por Cartão =====
Linha 15: Linha 16:
 <columns> A seguir o fluxo completo do pagamento descrevendo os processos de autorização, pagamento do compromisso pela credenciada, resposta de autorização e baixa do pagamento pelo movimento arrecadador, até a baixa definitiva no GSAN. </columns> <columns> A seguir o fluxo completo do pagamento descrevendo os processos de autorização, pagamento do compromisso pela credenciada, resposta de autorização e baixa do pagamento pelo movimento arrecadador, até a baixa definitiva no GSAN. </columns>
  
-<uml t=sequence>  +\\ 
-@startuml header Ciclo de Pagamento footer Operação da Credenciada title Ciclo de Vida do Pagamento por Cartão na Agência Virtual actor Consumidor #green boundary AgenciaVrtual control GSAN boundary Credenciada boundary OperadoraCartao boundary BancoArrecadador participant "Concessionária \nde Água" as CONCESSIONÁRIA +<WRAP center round box 100%
- +{{ :integracoes:imagem_documentacao_api_pagamentos.png?1000 |}} 
-Consumidor → AgenciaVrtual : Request Authentication<<documento>> AgenciaVrtual → GSAN : Autenticar Usuário GSAN → AgenciaVrtual : CriarSessaoUsuario Consumidor → AgenciaVrtual : Solicitar Negociação de Débitos AgenciaVrtual → Credenciada : Acionar Checkout Credenciada +</WRAP
- +\\
-alt Ciclo de controle da Credenciada Credenciada → Consumidor Solicitar dados do Cartão Credenciada → Consumidor Solicitar escolha de quantidade de parcelas Credenciada → Consumidor : Informar Tarifa da Operação Consumidor → Credenciada : Retornar Informações Credenciada → Consumidor : Solicitar Confirmação das Informações Consumidor → Credenciada : Confirmar Informações Credenciada → OperadoraCartao : Solicitar Autorização da Operadora OperadoraCartao → Credenciada : Retorna Autorização +
- +
-group Credenciada Não é Agente Arrecadador Credenciada → BancoArrecadador : Realizar Pagamento Código de Barras BancoArrecadador –> CONCESSIONÁRIA : Realizar Transferência Eletrônica de Fundos Credenciada → Consumidor : Recibo de Pagamento Autorizado Credenciada → GSAN : Pagamento Autorizado <<NSU, Autenticação Mecânica>> BancoArrecadador -[#blue]→ GSAN : Enviar Movimento TXT Tipo G end +
- +
-group Credenciada Como Agente Arrecadador Credenciada → CONCESSIONÁRIA : Realizar Transferência Eletrônica de Fundos Credenciada -[#blue]→ GSAN : Enviar Movimento TXT Tipo G Credenciada → Consumidor : Recibo de Pagamento Autorizado Credenciada → GSAN : Pagamento Autorizado <<NSU, Autenticação Mecânica>> end +
- +
-end +
- +
-GSAN → GSAN: Baixar Pagamentos +
- +
-@enduml  +
-</uml>+
  
 ===== Autenticação ===== ===== Autenticação =====
  
-<columns> Os endpoints que nescessitem autenticação serão informados abaixo. Os mesmos precisarão ter as seguintes chaves, **client_secret** e **client_id**, no cabeçalho HTTP, a chave em questão foi gerada para o ambiente de testes:+<columns> Os endpoints que nescessitem autenticação serão informados abaixo. Os mesmos precisarão ter as seguintes chaves, **client_secret** e **client_id**, no cabeçalho HTTP, a chave em questão deve ser solicitada para o ambiente sandbox alvo da homologação:
  
 </columns> </columns>
Linha 41: Linha 30:
   * **client_id**: CREDENCIADA   * **client_id**: CREDENCIADA
   * **client_secret**: <HASH 256b>   * **client_secret**: <HASH 256b>
 +
 +
 ==== ENDPOINT CONSULTAR DÉBITOS ==== ==== ENDPOINT CONSULTAR DÉBITOS ====
  
integracoes/api-pagamento.1738777335.txt.gz · Última modificação: 05/02/2025 17:42 por sara.valongo