/
Pesquisa sobre as funcionalidades da api PJBank.

Pesquisa sobre as funcionalidades da api PJBank.

ObjetivosRealizar um pesquisa para listar as funcionalidades e identificar o que é necessário consumir a api do PJBank.
Área de produtosPortal de Clientes / Integração bancária
ResponsávelCleudice Marques Santos
Data publicação04/2018

Metodologia

Avaliação da documentação da API e no próprio site da PJBank.


Análise

O que é PJBank?

PJBank é uma API que fornece vários serviços de uma Conta Digital, com ela você pode:

  • Abrir uma conta digital
  • Receber com boleto e cartão de crédito
  • Pagar contas
  • Transferir dinheiro entre contas
  • Emitir cartões corporativos
  • Obter extratos
  • Convidar pessoa física para administrar a Conta Digital.

Sobre a API

  • Ótima documentação da API.
  • Possui uma área de testes (SandBox)
  • Possui alguns SDK's (projetos no github com exemplos de uso)

Webhook

A empresa(cliente) pode disponibilizar uma api (integração com gerenciador) para que determinadas informações decorrentes de transações/ocorrências na Conta Digital sejam enviadas automaticamente para esta api.

Conta Digital

Credenciamento

Inicialmente deve-se realizar o credenciamento da Conta Digital, que pode ser feito pelo site PJBank ou via API. Cada credencial é vinculada a um CNPJ.

Após o credenciamento via API deve-se entrar em contato com o suporte para que o mesmo realiza a liberação.


São necessários os dados abaixo para o credenciamento.

AtributoDescrição
Nome da EmpresaRazão Social que será credenciada na Conta Digital.
CNPJO CNPJ da empresa.
CEPCEP do endereço da empresa.
EndereçoNome da rua do endereço da empresa.
NúmeroNúmero do endereço da empresa.
BairroBairro do Endereço da Empresa.
ComplementoComplemento opcional.
CidadeCidade do endereço da empresa.
EstadoEstado do endereço da empresa em dois dígitos.
DDDDDD de contato to telefone da empresa.
TelefoneTelefone de contato da empresa.
E-MailE-mail de contato da empresa.
Webhook(Opcional)  informe uma URL de webhook para informarmos seu sistema sempre que algo acontecer na Conta Digital.
Agência(Opcional) Código de identificação do parceiro, fornecido pelo PJBank.

Boleto Bancário

Quando é solicitado o registro de um novo boleto, a API retorna um identificador único referente a este boleto, com este identificador conseguimos verificar o status do mesmo.Também é possível enviar um identificador próprio, assim poderá editar o boleto via API sem duplicá-lo.

A API permite o registro de boletos em lote.

Processo de registro

Dados necessário para emitir Boletos Bancários.

AtributoDescrição
VencimentoVencimento da cobrança.
ValorValor a ser cobrado em reais.
JurosTaxa de juros ao mês. Valor informado será dividido por 30 pra ser encontrado a taxa diária.
MultaTaxa de multa por atraso.
DescontoValor do desconto por pontualidade, em Reais.
ClienteNome completo do pagador.
CPF/CNPJCPF ou CNPJ do pagador.
EndereçoEndereço do pagador.
NúmeroNúmero do endereço do pagador.
ComplementoOpcionalmente adicione o complemento do endereço do pagador.
BairroBairro do endereço do pagador.
CidadeCidade do endereço do pagador.
EstadoEstado do endereço do pagador.
CEPCEP do endereço do pagador.
LogotipoURL do logo da empresa.
TextoTexto que ficará no topo dos boletos.
GrupoIdentificação do grupo. É uma string que identifica um grupo de boletos. Quando um valor é passado neste campo, é retornado um link adicional para impressão de todos os boletos do mesmo grupo de uma vez. Recomendado para imprimir carnês.
Número do pedidoNumero do pedido da cobrança. Este número é importante se você precisar editar o boleto sem necessidade de duplica-lo.
WebhookOpcionalmente, informe uma URL de Webhook. (PJBank chama o endereço informado para atualizar as novas informações referentes ao boleto).
Espécie de documentoOpcionalmente, informa a espécie do titulo da cobrança.


Conclusões / Insights de produto

#InsightDescriçãoDecisãoIssue JIRA
001API de integraçãoCriar um site  para integrar com a API do PJBank