integracoes:api-pagamento
Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
Ambos lados da revisão anteriorRevisão anteriorPróxima revisão | Revisão anterior | ||
integracoes:api-pagamento [05/02/2025 17:36] – [Fluxo de Pagamento por Cartão] sara.valongo | integracoes:api-pagamento [07/02/2025 12:27] (atual) – Diego Imagem tadeu.sarmento | ||
---|---|---|---|
Linha 5: | Linha 5: | ||
====== API Pagamento ====== | ====== API Pagamento ====== | ||
- | < | + | < |
- | 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. </ |
- | </ | + | |
===== Fluxo de Pagamento por Cartão ===== | ===== Fluxo de Pagamento por Cartão ===== | ||
Linha 17: | Linha 15: | ||
< | < | ||
- | <uml t=sequence> | + | \\ |
- | + | <WRAP center round box 100%> | |
- | Consumidor → AgenciaVrtual : Request Authentication<< | + | {{ :integracoes:imagem_documentacao_api_pagamentos.png? |
- | + | </WRAP> | |
- | alto Ciclo de controle da Credenciada Credenciada → Consumidor | + | \\ |
- | + | ||
- | 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 << | + | |
- | + | ||
- | 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 << | + | |
- | + | ||
- | end | + | |
- | + | ||
- | GSAN → GSAN: Baixar Pagamentos | + | |
- | + | ||
- | @enduml | + | |
===== Autenticação ===== | ===== Autenticação ===== | ||
- | < | + | < |
- | Os endpoints que nescessitem autenticação serão informados abaixo. Os mesmos precisarão ter as seguintes chaves, **client_secret** e **client_id**, | + | |
</ | </ | ||
Linha 51: | Linha 37: | ||
JSON de consulta: | JSON de consulta: | ||
- | <code javascript> | + | <code javascript> |
+ | {documento:" | ||
</ | </ | ||
Linha 57: | Linha 45: | ||
OU | OU | ||
- | <code javascript> | + | <code javascript> |
+ | {matricula:" | ||
</ | </ | ||
< | < | ||
+ | |||
Resposta: | Resposta: | ||
</ | </ | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
nome: " | nome: " | ||
Linha 101: | Linha 93: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 112: | Linha 105: | ||
JSON de consulta: | JSON de consulta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 120: | Linha 115: | ||
Resposta: | Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 142: | Linha 138: | ||
} | } | ||
]} | ]} | ||
+ | |||
</ | </ | ||
Linha 155: | Linha 152: | ||
JSON de consulta: | JSON de consulta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 165: | Linha 163: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 170: | Linha 169: | ||
Resposta: | Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 178: | Linha 178: | ||
}] | }] | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 191: | Linha 192: | ||
JSON de consulta: | JSON de consulta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 201: | Linha 203: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 206: | Linha 209: | ||
Resposta: | Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 221: | Linha 226: | ||
JSON de Consulta: | JSON de Consulta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 235: | Linha 241: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 252: | Linha 260: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 265: | Linha 275: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 270: | Linha 281: | ||
Resposta: | Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | {status: " | ||
</ | </ | ||
Linha 282: | Linha 295: | ||
JSON de Consulta: | JSON de Consulta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
| | ||
| | ||
Linha 296: | Linha 310: | ||
] | ] | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 301: | Linha 316: | ||
Resposta: | Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | {status: " | ||
</ | </ | ||
Linha 313: | Linha 330: | ||
* 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. | ||
Linha 319: | Linha 336: | ||
JSON Resposta: | JSON Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
url: " | url: " | ||
erro: false | erro: false | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 330: | Linha 349: | ||
* 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]** | ||
Linha 336: | Linha 355: | ||
JSON Resposta: | JSON Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | { | ||
url: " | url: " | ||
} | } | ||
+ | |||
</ | </ | ||
Linha 348: | Linha 369: | ||
Resposta: | Resposta: | ||
- | <code javascript> | + | <code javascript> |
+ | {erro: { | ||
cod: 3, | cod: 3, | ||
msg: " | msg: " | ||
}} | }} | ||
+ | |||
</ | </ | ||
Linha 384: | Linha 407: | ||
|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 391: | 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/ | + | **“Layout” Padrão de Arrecadação/ |
- | + | ||
- | < | + | |
- | 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 [[: | + | |
- | </ | + | |
==== 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/ |
---- | ---- | ||
Linha 423: | Linha 442: | ||
|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/ | + | |G.02|2|21|CHAR(20)|Identificação da agência/ |
- | |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, |
- | |G.07 |94 |100 |NUM(7,2) |Valor da tarifa | | + | |G.07|94|100|NUM(7, |
- | |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/ | + | |G.10|117|117|CHAR(1)|Forma de arrecadação/ |
- | |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/ |
- | partes) | + | |
- | partes). | + | |
---- | ---- | ||
Linha 451: | 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, |
- | |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.1738776986.txt.gz · Última modificação: 05/02/2025 17:36 por sara.valongo