Pix
O Plasfran ERP oferece integração completa com a API Pix da TecnoSpeed para facilitar a gestão de contas Pix de empresas e o recebimento de pagamentos eletrônicos.
Autenticação
Obter Token de Acesso
Endpoint
POST /oauth2/token
Descrição
Autentica o Plasfran ERP na API da TecnoSpeed para permitir chamadas subsequentes.
Gerenciamento de Empresas
Endpoint
POST /api/v1/companies
Descrição
Cadastra uma nova empresa para uso do serviço Pix.
Endpoint
PATCH /api/v1/companies/{id}
Descrição
Atualiza os dados de uma empresa cadastrada.
Endpoint
GET /api/v1/companies
Descrição
Retorna a lista de empresas vinculadas à conta.
Endpoint
DELETE /api/v1/companies/{id}
Descrição
Remove uma empresa do cadastro Pix.
Certificado
Endpoint
GET /api/v1/certificate
Descrição
Rotina para listagem do certificado digital.
Endpoint
POST /api/v1/certificate/upload
Descrição
Nessa rotina será feito o upload do certificado digital.
Endpoint
DELETE /api/v1/certificate/{accountId}
Descrição
Nessa rotina será feito a exclusão do certificado digital.
Endpoint
POST /api/v1/certificate/pfxtopem
Descrição
Nessa rotina será realizada a conversão do certificado digital do formato PFX para PEM.
Endpoint
GET /api/v1/certificate/download/{accountId}/{extension}
Descrição
Nessa rotina é feito o download do certificado digital.
Conta
Endpoint
POST /api/v1/accounts
Descrição
Nessa rotina será cadastrada a conta bancária responsável por fazer a cobrança.
Endpoint
PATCH /api/v1/accounts/{id}
Descrição
Nessa rotina será feito a alteração dos dados da conta.
Endpoint
GET /api/v1/accounts
Descrição
Esse método retorna todas as contas cadastradas para uma empresa.
Endpoint
GET /api/v1/accounts/{id}
Descrição
O método de inativação pode ser usado quando uma conta não fará mais pagamentos, ou então houve um cadastro incorreto de conta. Aqui, será necessário passar apenas o id da conta, gerado através do método de cadastro.
Pix - Cobrança imediata
Endpoint
POST /api/v1/pix/dynamic
Descrição
Nessa rotina será criado um pix dinâmico
Endpoint
GET /api/v1/pix/{id}
Descrição
Rotina para consultar o Pix informado
Endpoint
GET /api/v1/qr/{id}
Descrição
Imprimir QR code do pix gerado.
Bilhetagem
Endpoint
GET /api/v1/report
Descrição
Nessa rotina é consultado as informações de bilhetagem.
Webhook
Endpoint
POST /api/v1/webhook
Descrição
Nessa rotina será cadastrado as configurações de webhook do pix.
Endpoint
PATCH /api/v1/webhook
Descrição
Nessa rotina será atualizado as configurações de webhook do pix.
Endpoint
DELETE /api/v1/webhook
Descrição
Nessa rotina será deletado as configurações de webhook do pix.
Documentação oficial Pix
https://docs.pix.tecnospeed.com.br/