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

Visitou: • mais
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 [20/10/2023 20:13] – anderson.italointegracoes:api-pagamento [07/02/2025 12:27] (atual) – Diego Imagem tadeu.sarmento
Linha 1: Linha 1:
-[[:treinamentos|{{treinamentos:api.png?90 |}}]]+[[:treinamentos|{{:treinamentos:api.png?nolink&90  }}]]
  
 ---- ----
Linha 5: Linha 5:
 ====== API Pagamento ====== ====== API Pagamento ======
  
-<columns> +<columns> Documentação do funcionamento da API Pagamento construída para trabalhar com todos os Sistemas Comerciais suportados pela Consenso.
-Documentação do funcionamento da API Pagamento construída para trabalhar com todos os Sistemas Comerciais suportados pela Consenso.+
  
 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. +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>
-</columns>+
  
 ===== Fluxo de Pagamento por Cartão ===== ===== Fluxo de Pagamento por Cartão =====
  
-<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>
-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 +
- +
-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 +
- +
-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>+
  
 +\\
 +<WRAP center round box 100%>
 +{{ :integracoes:imagem_documentacao_api_pagamentos.png?1000 |}}
 +</WRAP>
 +\\
  
 ===== Autenticação ===== ===== Autenticação =====
  
-<columns> +<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:
-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> </columns>
Linha 80: Linha 29:
   * **client_id**: CREDENCIADA   * **client_id**: CREDENCIADA
   * **client_secret**: <HASH 256b>   * **client_secret**: <HASH 256b>
- 
- 
 ==== ENDPOINT CONSULTAR DÉBITOS ==== ==== 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): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/debitos|HTTPS://ENDPOINTALVO:PORTA/gsan/api/debitos]]+POST(autenticar): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/debitos|]]
  
 JSON de consulta: JSON de consulta:
Linha 92: Linha 39:
 <code javascript> <code javascript>
  {documento:"21469517000102"}  {documento:"21469517000102"}
 +
 +
 </code> </code>
 +
 OU OU
 +
 <code javascript> <code javascript>
  {matricula:"99999"}  {matricula:"99999"}
 +
 +
 </code> </code>
 +<code>
  
-  Resposta:+Resposta: 
 + 
 +</code>
  
 <code javascript> <code javascript>
Linha 137: Linha 93:
    ]    ]
 } }
-</code> 
  
  
 +</code>
  
 ==== ENDPOINT PESQUISAR DÉBITOS PARA EMISSÃO DE EXTRATO ==== ==== ENDPOINT PESQUISAR DÉBITOS PARA EMISSÃO DE EXTRATO ====
  
-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): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/debitos+  * POST (autenticar): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/debitos|]]
  
 JSON de consulta: JSON de consulta:
Linha 153: Linha 109:
    matricula:"452812"    matricula:"452812"
 } }
 +
 +
 </code> </code>
 +
 Resposta: Resposta:
 +
 <code javascript> <code javascript>
 { {
Linha 178: Linha 138:
    }    }
 ]} ]}
 +
 +
 </code> </code>
  
 ==== ENDPOINT EMITIR EXTRATO ==== ==== ENDPOINT EMITIR EXTRATO ====
  
-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): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/emitir+  * POST(autenticar): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/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. 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 201: Linha 163:
    ]    ]
 } }
 +
 +
 </code> </code>
 +
 Resposta: Resposta:
 +
 <code javascript> <code javascript>
 { {
Linha 212: Linha 178:
    }]    }]
 } }
 +
 +
 </code> </code>
  
 ==== ENDPOINT DESCONTO EXTRATO ==== ==== ENDPOINT DESCONTO EXTRATO ====
  
-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): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/extrato/desconto+  * 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. 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.
Linha 235: Linha 203:
    ]    ]
 } }
 +
 +
 </code> </code>
 +
 Resposta: Resposta:
 +
 <code javascript> <code javascript>
 { {
Linha 242: Linha 214:
    valorDesconto: 25.17    valorDesconto: 25.17
 } }
-</code> 
  
  
 +</code>
  
 ==== ENDPOINT NOTIFICAR PAGAMENTOS ==== ==== ENDPOINT NOTIFICAR PAGAMENTOS ====
  
-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): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/notificarPagamento+POST(autenticar): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/notificarPagamento|]]
  
 JSON de Consulta: JSON de Consulta:
 +
 <code javascript> <code javascript>
 { {
    identificacaoTransacao: "5462158456512",    identificacaoTransacao: "5462158456512",
-   tipoCartao: "creditoAVista",  +   tipoCartao: "creditoAVista",
    debitos:    [    debitos:    [
             {             {
          id: "C#78422196",          id: "C#78422196",
-  autenticacao: "JHAJl765765765"+     autenticacao: "JHAJl765765765"
       },       },
             {             {
          id: "G#408204",          id: "G#408204",
-  autenticacao: "6565163516516574654361351351351354531"+     autenticacao: "6565163516516574654361351351351354531"
       }       }
    ]    ]
 } }
 +
 +
 </code> </code>
  
Linha 273: Linha 248:
 { {
    identificacaoTransacao: "5462158456512",    identificacaoTransacao: "5462158456512",
-   tipoCartao: "debito",  +   tipoCartao: "debito",
    debitos:    [    debitos:    [
             {             {
          id: "C#78422196",          id: "C#78422196",
-  autenticacao: "JHAJl765765765"+     autenticacao: "JHAJl765765765"
       },       },
             {             {
          id: "G#408204",          id: "G#408204",
-  autenticacao: "6565163516516574654361351351351354531"+     autenticacao: "6565163516516574654361351351351354531"
       }       }
    ]    ]
 } }
 +
 +
 </code> </code>
  
Linha 290: Linha 267:
 { {
    identificacaoTransacao: "5462158456512",    identificacaoTransacao: "5462158456512",
-   tipoCartao: "creditoParcelado",  +   tipoCartao: "creditoParcelado",
    debitos:    [    debitos:    [
             {             {
          id: "E#408204",          id: "E#408204",
-  autenticacao: "6565163516516574654361351351351354531"+     autenticacao: "6565163516516574654361351351351354531"
       }       }
    ]    ]
 } }
 +
 +
 </code> </code>
  
 Resposta: Resposta:
 +
 <code javascript> <code javascript>
 {status: "OK"} {status: "OK"}
-</code> 
  
 +
 +</code>
  
 ==== ENDPOINT NOTIFICAR CANCELAMENTO DE PAGAMENTO ==== ==== ENDPOINT NOTIFICAR CANCELAMENTO DE PAGAMENTO ====
  
-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): HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/notificarPagamento+POST(autenticar): [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/notificarPagamento|]]
  
 JSON de Consulta: JSON de Consulta:
 +
 <code javascript> <code javascript>
 { {
Linha 320: Linha 302:
             {             {
          id: "C#78422196",          id: "C#78422196",
-  autenticacao: "JHAJl765765765"+     autenticacao: "JHAJl765765765"
       },       },
             {             {
          id: "G#408204",          id: "G#408204",
-  autenticacao: "6565163516516574654361351351351354531"+     autenticacao: "6565163516516574654361351351351354531"
       }       }
    ]    ]
 } }
 +
 +
 </code> </code>
  
 Resposta: Resposta:
 +
 <code javascript> <code javascript>
 {status: "OK"} {status: "OK"}
-</code> 
- 
  
  
 +</code>
  
 ==== ENDPOINT OBTER URL CHECKOUT ==== ==== ENDPOINT OBTER URL CHECKOUT ====
  
-GET: HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/obterUrlCheckoutEmpresaPagamento+POST: [[HTTPS://ENDPOINTALVO:PORTA/gsan/api/pagamentos/obterUrlCheckoutEmpresaPagamento|]]
  
 Parâmetros de Consulta: Parâmetros de Consulta:
 +
   * credenciada = identificacao da credenciada   * credenciada = identificacao da credenciada
   * codBarra = código de barras do documento   * codBarra = código de barras do documento
-  * doc =  cpf/cnpj do cliente+  * doc = cpf/cnpj do cliente
   * nome = Nome do cliente   * nome = Nome do cliente
   * id = identificação do débito fornecido pela API de emitir débito.   * id = identificação do débito fornecido pela API de emitir débito.
  
 JSON Resposta: JSON Resposta:
 +
 <code javascript> <code javascript>
 { {
Linha 355: Linha 341:
   erro: false   erro: false
 } }
 +
 +
 </code> </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:+**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   * codigoBarras = código de barras do documento
   * matricula = matrícula do imóvel **[Opcional]**   * matricula = matrícula do imóvel **[Opcional]**
-  * documento =  cpf/cnpj do cliente **[Opcional]**+  * documento = cpf/cnpj do cliente **[Opcional]**
   * nome = Nome do cliente **[Opcional]**   * nome = Nome do cliente **[Opcional]**
   * id = identificação do débito fornecido pela API de emitir débito. **[Opcional]**   * id = identificação do débito fornecido pela API de emitir débito. **[Opcional]**
  
 JSON Resposta: JSON Resposta:
 +
 <code javascript> <code javascript>
 { {
   url: "https://example.com/?param=fsdfsdf5454f35s4df5sd4f"   url: "https://example.com/?param=fsdfsdf5454f35s4df5sd4f"
 } }
-</code> 
- 
  
  
 +</code>
  
 ==== FLUXO DE ERRO PADRÃO ==== ==== FLUXO DE ERRO PADRÃO ====
Linha 380: Linha 368:
  
 Resposta: Resposta:
 +
 <code javascript> <code javascript>
 {erro: { {erro: {
    cod: 3,    cod: 3,
-   msg: "EMPRESAO NAO CADASTRADA"+   msg: "EMPRESA NAO CADASTRADA"
 }} }}
 +
 +
 </code> </code>
  
 Tabela de Erros: Tabela de Erros:
  
-^Codigo^Erro^+^Codigo^Erro|
 |0|NÃO TRATADO| |0|NÃO TRATADO|
 |1|client_id obrigatório| |1|client_id obrigatório|
 |2|client_secret obrigatório| |2|client_secret obrigatório|
-|3|EMPRESAO NAO CADASTRADA|+|3|EMPRESA NAO CADASTRADA|
 |4|chave inválida| |4|chave inválida|
 |100|variável documento inexistente| |100|variável documento inexistente|
Linha 415: Linha 406:
 |118|matrícula obrigatória| |118|matrícula obrigatória|
 |119|matrícula inválida| |119|matrícula inválida|
-|120| pagamento inexistente| +|120|pagamento inexistente| 
-|121|Este imóvel não tem perfil | +|121|Este imóvel não tem perfil| 
-|122|Já existe pagamento para documento |+|122|Já existe pagamento para documento|
  
 ---- ----
Linha 423: Linha 414:
 ===== Apêndice 1 - Layout Arquivo de Remessa de Arrecadação ===== ===== Apêndice 1 - Layout Arquivo de Remessa de Arrecadação =====
  
-**“Layout” Padrão de Arrecadação/Recebimento com Utilização do Código de Barras** +**“Layout” Padrão de Arrecadação/Recebimento com Utilização do Código de Barras**<columns> Para as empresas que possuem serviço de VAN é necessário respeitar o layou abaixo, conforme Febraban V.04, para transmitir o movimento com o arquivo com os devidos pagamentos, o layout abaixo precisa ser respeitado, ver [[:postgres:arrecadacao:uc0262|UC0262]] para mais detalhes. </columns>
- +
-<columns> +
-Para as empresas que possuem serviço de VAN é necessário respeitar o layou abaixo, conforme Febraban V.04, para transmitir o movimento com o arquivo com os devidos pagamentos, o layout abaixo precisa ser respeitado, ver [[postgres:arrecadacao:uc0262|UC0262]] para mais detalhes. +
-</columns> +
  
 ==== Distribuir Registro Código A (CABEÇALHO DO ARQUIVO) ==== ==== Distribuir Registro Código A (CABEÇALHO DO ARQUIVO) ====
  
-| DESCRIÇÃO DO REGISTRO **A - HEADER** OBRIGATÓRIO EM TODOS OS ARQUIVOS ||||| +|DESCRIÇÃO DO REGISTRO **A - HEADER** OBRIGATÓRIO EM TODOS OS ARQUIVOS||||| 
-| | POSIÇÕES || | | +|POSIÇÕES|||| 
-| CAMPOS | DE | ATÉ | FORMATO | CONTEÚDO | +|CAMPOS|DE|ATÉ|FORMATO|CONTEÚDO| 
-| A. 01 | 1 | 1 | CHAR(1) | Código do registro = A | +|A. 01|1|1|CHAR(1)|Código do registro = A| 
-| A. 02 | 2 | 2 | NUM(1) | Código de Remessa | +|A. 02|2|2|NUM(1)|Código de Remessa| 
-| A. 03 | 3 | 22 | CHAR(20) | Código do Convênio | +|A. 03|3|22|CHAR(20)|Código do Convênio| 
-| A. 04 | 23 | 42 | CHAR(20) | Nome da Empresa | +|A. 04|23|42|CHAR(20)|Nome da Empresa| 
-| A. 05 | 43 | 45 | NUM(3) | Código do Banco | +|A. 05|43|45|NUM(3)|Código do Banco| 
-| A. 06 | 46 | 65 | CHAR(20) | Nome do Banco | +|A. 06|46|65|CHAR(20)|Nome do Banco| 
-| A. 07 | 66 | 73 | NUM(08) | Data da geração do arquivo (AAAAMMDD) | +|A. 07|66|73|NUM(08)|Data da geração do arquivo (AAAAMMDD)| 
-| A. 08 | 74 | 79 | NUM(06) | Número sequencial do arquivo (NSA) | +|A. 08|74|79|NUM(06)|Número sequencial do arquivo (NSA)| 
-| A. 09 | 80 | 81 | NUM(02 ) | Versão do layout | +|A. 09|80|81|NUM(02 )|Versão do layout| 
-| A. 10 | 82 | 98 | CHAR(17) | Tipo de Movimento | +|A. 10|82|98|CHAR(17)|Tipo de Movimento| 
-| A.11 | 99 | 150 | CHAR(52) | Reservado para o futuro (em branco) |+|A.11|99|150|CHAR(52)|Reservado para o futuro (em branco)|
  
-**DESCRIÇÃO DOS CAMPOS DO REGISTRO “A”** \\+**DESCRIÇÃO DOS CAMPOS DO REGISTRO “A”**
  
-A.01 - Código do registro = “A” \\ +A.01 - Código do registro = “A” \\ A.02 - Código de Remessa \\ > 2 - RETORNO - Enviado pelo Banco para a Empresa/Órgão \\ A.03 - Código do Convênio \\ > Definido pelo banco \\ A.04 - Nome da Empresa/Órgão \\ A.05 - Código do Banco \\ > Código do Banco na câmara de compensação \\ A.06 - Nome do Banco \\ A.07 - Data da geração do arquivo (AAAAMMDD ) \\ A.08 - Número seqüencial do arquivo ( NSA ) \\ > Este número deverá evoluir de 1 em 1 para cada arquivo gerado \\ A.09 - Versão do lay - out \\ > legada = versão 03 \\ > atual = versão 04 \\ > nova = versão 05 - disponível a partir de 01.08.2016. \\ A.10 – Identificação do serviço \\ > Deverá conter “CÓDIGO DE BARRAS” \\ A.11 – Reservado para o futuro (filler)
-A.02 - Código de Remessa \\ +
-> 2 - RETORNO - Enviado pelo Banco para a Empresa/Órgão +
-A.03 - Código do Convênio \\ +
-> Definido pelo banco +
-A.04 - Nome da Empresa/Órgão \\ +
-A.05 - Código do Banco \\ +
-> Código do Banco na câmara de compensação +
-A.06 - Nome do Banco \\ +
-A.07 - Data da geração do arquivo (AAAAMMDD ) \\ +
-A.08 - Número seqüencial do arquivo ( NSA ) \\ +
-> Este número deverá evoluir de 1 em 1 para cada arquivo gerado +
-A.09 - Versão do lay - out \\ +
-> legada = versão 03 +
-> atual = versão 04 +
-> nova = versão 05 - disponível a partir de 01.08.2016. +
-A.10 – Identificação do serviço \\ +
-> Deverá conter “CÓDIGO DE BARRAS” +
-A.11 – Reservado para o futuro (filler) \\+
  
 ---- ----
- 
  
 ==== Distribuir Registro Código G ==== ==== Distribuir Registro Código G ====
  
-| DESCRIÇÃO DO REGISTRO **G - RETORNO DAS ARRECADAÇÕES IDENTIFICADAS** **COM CÓDIGO DE BARRAS** ||||| +|DESCRIÇÃO DO REGISTRO **G - RETORNO DAS ARRECADAÇÕES IDENTIFICADAS** **COM CÓDIGO DE BARRAS** ||||| 
-| | POSIÇÕES || | | +|POSIÇÕES|||| 
-| CAMPOS | DE | ATÉ | FORMATO | CONTEÚDO | +|CAMPOS|DE|ATÉ|FORMATO|CONTEÚDO| 
-| G.01 | 1 | 1 | CHAR(1) | Código do registro = G | +|G.01|1|1|CHAR(1)|Código do registro = G| 
-| G.02 | 2 | 21 | CHAR(20) | Identificação da agência/conta/dígito creditada | +|G.02|2|21|CHAR(20)|Identificação da agência/conta/dígito creditada| 
-| G.03 | 22 | 29 | NUM(08) | Data de pagamento (AAAAMMDD) | +|G.03|22|29|NUM(08)|Data de pagamento (AAAAMMDD)| 
-| G.04 | 30 | 37 | NUM(08) | Data prevista para o crédito (AAAAMMDD) | +|G.04|30|37|NUM(08)|Data prevista para o crédito (AAAAMMDD)| 
-| **G. 05** | **38** | **81** | **CHAR(44)** | **Código de Barras** | +|**G. 05** |**38** |**81** |**CHAR(44)** |**Código de Barras** | 
-| G.06 | 82 | 93 | NUM(12,2) | Valor recebido | +|G.06|82|93|NUM(12,2)|Valor recebido| 
-| G.07 | 94 | 100 | NUM(7,2) | Valor da tarifa | +|G.07|94|100|NUM(7,2)|Valor da tarifa| 
-| G.08 | 101 | 108 | NUM(8) | NSR - Número Sequencial de Registro | +|G.08|101|108|NUM(8)|NSR - Número Sequencial de Registro| 
-| G.09 | 109 | 116 | CHAR(8) | Código da agência arrecadadora | +|G.09|109|116|CHAR(8)|Código da agência arrecadadora| 
-| G.10 | 117 | 117 | CHAR(1) | Forma de arrecadação/captura | +|G.10|117|117|CHAR(1)|Forma de arrecadação/captura| 
-| G.11 | 118 | 140 | CHAR(23) | Número de autenticação caixa ou código de transação | +|G.11|118|140|CHAR(23)|Número de autenticação caixa ou código de transação| 
-| G.12 | 141 | 141 | NUM(1) | Forma de Pagamento, se a forma de pagamento for nula alterar para valor 1 | +|G.12|141|141|NUM(1)|Forma de Pagamento, se a forma de pagamento for nula alterar para valor 1| 
-| G.13 | 142 | 150 | CHAR(9) | Reservado para o futuro |+|G.13|142|150|CHAR(9)|Reservado para o futuro|
  
 **DESCRIÇÃO DOS CAMPOS DO REGISTRO “G”** **DESCRIÇÃO DOS CAMPOS DO REGISTRO “G”**
  
-G.01 - Código do registro = “G” \\ +G.01 - Código do registro = “G” \\ G.02 - Identificação da empresa/órgão no banco/agência/conta/dígito creditada \\ G.03 - Data do pagamento no formato Ano/Mês /Dia \\ G.04 - Data do crédito no formato Ano/Mês/Dia \\ G.05 - Informações do Código de Barras \\ G.06 - Valor efetivamente recebido \\ G.07 - Valor da tarifa referente a cada comprovante arrecadado (será informado desde que acordado entre as partes) \\ G.08 - Uso do Banco - Identificação do registro dentro do arquivo gerado \\ G.09 – Código da agência arrecadadora \\ G.10 – Forma de arrecadação/captura (canais de recebimento) \\ > 1 – Guichê de Caixa com fatura/guia de arrecadação \\ > 2 – Arrecadação Eletrônica com fatura/guia de arrecadação (terminais de auto - atendimento, \\ ATM, home/office banking) \\ > 3 – Internet com fatura/guia de arrecadação \\ > 4 – Outros meios com fatura/guia de arrecadação \\ > 5 – Casas lotéricas/correspondentes bancários com fatura/guia de arrecadação \\ > 6 – Telefone com fatura/guia de arrecadação \\ >> a – Guichê de Caixa sem fatura/guia de arrecadação \\ >> b – Arrecadação Eletrônica sem fatura/guia de arrecadação (terminais de auto - atendimento, ATM, home/office banking) \\ >> c – Internet sem fatura/guia de arrecadação \\ >> d – Casas lotéricas/correspondentes bancários sem fatura/guia de arrecadação \\ >> 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). \\ G.12 – Forma de Pagamento \\ > 1 – Dinheiro \\ > 2 – Cheque \\ > 3 – Não identificado \\ G.13 – Reservado para o futuro
-G.02 - Identificação da empresa/órgão no banco/agência/conta/dígito creditada \\ +
-G.03 - Data do pagamento no formato Ano/Mês /Dia \\  +
-G.04 - Data do crédito no formato Ano/Mês/Dia \\ +
-G.05 - Informações do Código de Barras \\ +
-G.06 - Valor efetivamente recebido \\ +
-G.07 - Valor da tarifa referente a cada comprovante arrecadado (será informado desde que acordado entre as +
-partes) \\ +
-G.08 - Uso do Banco - Identificação do registro dentro do arquivo gerado \\ +
-G.09 – Código da agência arrecadadora \\ +
-G.10 – Forma de arrecadação/captura (canais de recebimento) \\ +
-> 1 – Guichê de Caixa com fatura/guia de arrecadação \\ +
-> 2 – Arrecadação Eletrônica com fatura/guia de arrecadação (terminais de auto - atendimento, \\ +
-ATM, home/office banking) \\ +
-> 3 – Internet com fatura/guia de arrecadação \\ +
-> 4 – Outros meios com fatura/guia de arrecadação \\ +
-> 5 – Casas lotéricas/correspondentes bancários com fatura/guia de arrecadação \\ +
-> 6 – Telefone com fatura/guia de arrecadação \\ +
->> a – Guichê de Caixa sem fatura/guia de arrecadação \\ +
->> b – Arrecadação Eletrônica sem fatura/guia de arrecadação (terminais de auto - atendimento, ATM, home/office banking) \\ +
->> c – Internet sem fatura/guia de arrecadação \\ +
->> d – Casas lotéricas/correspondentes bancários sem fatura/guia de arrecadação \\ +
->> 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). \\ +
-G.12 – Forma de Pagamento \\ +
-> 1 – Dinheiro \\ +
-> 2 – Cheque \\ +
-> 3 – Não identificado \\ +
-G.13 – Reservado para o futuro \\+
  
 ---- ----
- 
  
 ==== Distribuir Registro Código Z (TRAILLER) ==== ==== Distribuir Registro Código Z (TRAILLER) ====
Linha 544: Linha 468:
 Distribuir os campos do registro do arquivo de movimento de arrecadadores de acordo com o formato abaixo: Distribuir os campos do registro do arquivo de movimento de arrecadadores de acordo com o formato abaixo:
  
-| DESCRIÇÃO DO REGISTRO **Z - TRAILLER** OBRIGATÓRIO EM TODOS OS ARQUIVOS ||||| +|DESCRIÇÃO DO REGISTRO **Z - TRAILLER** OBRIGATÓRIO EM TODOS OS ARQUIVOS||||| 
-| | POSIÇÕES || | | +|POSIÇÕES|||| 
-| CAMPOS | DE | ATÉ | FORMATO | CONTEÚDO | +|CAMPOS|DE|ATÉ|FORMATO|CONTEÚDO| 
-| Z. 01 | 1 | 1 | CHAR(1) | Código do Registro = Z | +|Z. 01|1|1|CHAR(1)|Código do Registro = Z| 
-| Z. 02 | 2 | 7 | NUM(06) | Total de registros do arquivo | +|Z. 02|2|7|NUM(06)|Total de registros do arquivo| 
-| Z. 03 | 8 | 24 | NUM(17,2) | Valor total recebido dos registros do arquivo | +|Z. 03|8|24|NUM(17,2)|Valor total recebido dos registros do arquivo| 
-| Z. 04 | 25 | 150 | CHAR(126) | Reservado para o futuro (brancos) |+|Z. 04|25|150|CHAR(126)|Reservado para o futuro (brancos)|
  
-\\+~~NOSIDEBAR~~
  
- 
- 
-~~NOSIDEBAR~~ 
  
integracoes/api-pagamento.1697832788.txt.gz · Última modificação: 20/10/2023 20:13 por anderson.italo