PIX
Levantamento para implementação do recurso de PIX utilizando a API do GerenciaNet.
| Esta primeira proposta contempla apenas os recursos mais básicos. |
Casos de uso atendimentos
-
Configuração da Gerencianet por Gestor
-
Certificado PIX gerado pela Gerencianet
-
Possivelmente uma chave PIX do gestor (Criar chave evp)
-
Criar PIX para recebimento na Gerencianet
-
-
Títulos
-
Geração de títulos (gerará PIX de cobrança)
-
Criação manual de título (gerará PIX de cobrança)
-
Edição de título (alterar o PIX de cobrança)
-
Cancelamento de título (alterar o PIX de cobrança)
-
Apresentar QRCode (Gerar QRCode de um location)
-
Apresentar Código de copy/cola (não encontrei este recurso na gerencianet)
-
Baixar “automática” do título (via notificação de pagamento do PIX)
-
Dicas de implementação
-
Indicar o uso do boleto ou PIX na configuração (seria global ou por título?)
-
Novo campo para o certificado (backend e web) no gestor, produção e sandbox
-
Novo campo para chave PIX do gestor… Cadastro da chave pix?
-
Todo request leva o certificado
-
Criação de um txid para cada título (cobrança), exigindo um novo campo
-
Criação da notificação de pix pago (baixa automática no sistema)
Implementação
| Abaixo temos a lista de endpoints da API do Gerencianet que serão usadas nesta implementação inicial. |
| Operação | Endpoint | Uso |
|---|---|---|
POST |
/oauth/token |
Autenticação |
PUT |
/v2/cob/{txid} |
Criar cobrança |
PATCH |
/v2/cob/{txid} |
Revisar cobrança |
GET |
/v2/cob/{txid} |
Consultar cobrança |
GET |
/v2/loc/{id}/qrcode |
Gerar QRCode de um location |
POST |
/v2/gn/evp |
Criar chave evp |
PUT |
/v2/webhook/:chave |
Configurar o Webhook Pix |
PUT |
/v2/gn/config |
Criar/modificar configurações da conta |
Recursos para implementação futura
| Haverão muitas rotinas, principalmente de gestão e consultas que não serão implementadas neste suporte inicial. Segue elas logo abaixo. |
| Operação | Endpoint | Uso |
|---|---|---|
POST |
/v2/loc |
Criar location do payload |
POST |
/v2/cob |
Criar cobrança imediata |
GET |
/v2/cob/ |
Consultar lista de cobranças |
GET |
/v2/pix/{e2eid} |
Consultar Pix |
GET |
/v2/pix/ |
Consultar Pix recebidos |
POST |
/v2/pix |
Requisitar envio de Pix. |
PUT |
/v2/pix/{e2eid}/devolucao/{id} |
Solicitar devolução. |
GET |
/v2/pix/{e2eid}/devolucao/{id} |
Consultar devolução |
GET |
/v2/webhook/:chave |
Exibir informações do Webhook Pix |
GET |
/v2/webhook/ |
Consultar lista de webhooks |
DELETE |
/v2/webhook/:chave |
Cancelar o webhook Pix |
GET |
/v2/loc |
Consultar locations cadastradas |
GET |
/v2/loc/{id} |
Recuperar location do payload |
DELETE |
/v2/loc/{id}/txid |
Desvincular um txid de uma location |
GET |
/v2/gn/evp |
Listar chaves evp |
DELETE |
/v2/gn/evp/:chave |
Remover chave evp |
GET |
/v2/gn/saldo |
Buscar o saldo da conta |
GET |
/v2/gn/config |
Listar configurações da conta |