Pesquisa sobre as funcionalidades da api PJBank.
Objetivos | Realizar um pesquisa para listar as funcionalidades e identificar o que é necessário consumir a api do PJBank. |
---|---|
Área de produtos | Portal de Clientes / Integração bancária |
Responsável | Cleudice Marques Santos |
Data publicação | 04/2018 |
Metodologia
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.
Atributo | Descrição |
---|---|
Nome da Empresa | Razão Social que será credenciada na Conta Digital. |
CNPJ | O CNPJ da empresa. |
CEP | CEP do endereço da empresa. |
Endereço | Nome da rua do endereço da empresa. |
Número | Número do endereço da empresa. |
Bairro | Bairro do Endereço da Empresa. |
Complemento | Complemento opcional. |
Cidade | Cidade do endereço da empresa. |
Estado | Estado do endereço da empresa em dois dígitos. |
DDD | DDD de contato to telefone da empresa. |
Telefone | Telefone de contato da empresa. |
E-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.
Atributo | Descrição |
---|---|
Vencimento | Vencimento da cobrança. |
Valor | Valor a ser cobrado em reais. |
Juros | Taxa de juros ao mês. Valor informado será dividido por 30 pra ser encontrado a taxa diária. |
Multa | Taxa de multa por atraso. |
Desconto | Valor do desconto por pontualidade, em Reais. |
Cliente | Nome completo do pagador. |
CPF/CNPJ | CPF ou CNPJ do pagador. |
Endereço | Endereço do pagador. |
Número | Número do endereço do pagador. |
Complemento | Opcionalmente adicione o complemento do endereço do pagador. |
Bairro | Bairro do endereço do pagador. |
Cidade | Cidade do endereço do pagador. |
Estado | Estado do endereço do pagador. |
CEP | CEP do endereço do pagador. |
Logotipo | URL do logo da empresa. |
Texto | Texto que ficará no topo dos boletos. |
Grupo | Identificaçã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 pedido | Numero do pedido da cobrança. Este número é importante se você precisar editar o boleto sem necessidade de duplica-lo. |
Webhook | Opcionalmente, informe uma URL de Webhook. (PJBank chama o endereço informado para atualizar as novas informações referentes ao boleto). |
Espécie de documento | Opcionalmente, informa a espécie do titulo da cobrança. |
Conclusões / Insights de produto
# | Insight | Descrição | Decisão | Issue JIRA |
---|---|---|---|---|
001 | API de integração | Criar um site para integrar com a API do PJBank |