Criar Pagador e Conta para Extrato Open Finance

Para criar uma conta utilizando o Extrato Open Finance é necessário contratar a funcionalidade na sua Software House. Portanto, caso ainda não tenha executado esse processo, acesse esse link.

Após a contratação do serviço, é necessário ativar a funcionalidade dentro do Pagador (payer) e da Conta (account). Caso ainda não tenha um Pagador (payer) criado, siga as instruções.

Rotas

Homologação:

https://staging.pagamentobancario.com.br/api/v1/

Produção:

https://api.pagamentobancario.com.br/api/v1/

1.  Cadastrar Pagador (payer)

Para ativar a funcionalidade no Pagador é obrigatório informar o campo "statementActived": true. 

Método:

POST https://staging.pagamentobancario.com.br/api/v1/payer

Requisição:

{
   "name": "CNPJ PARA TESTES",
   "cpfCnpj": "01001001000113",
   "neighborhood": "DUQUE DE CAXIAS",
   "addressNumber": "882",
   "zipcode": "87020025",
   "state": "PR",
   "city": "MARINGA",
   "statementActived": true
}

Resposta:

{
 "name": "string",
 "email": "string",
 "cpfCnpj": "string",
 "accounts": [],
 "street": "string",
 "neighborhood": "string",
 "addressNumber": "string",
 "addressComplement": "string",
 "city": "string",
 "state": "string",
 "zipcode": "string",
 "token": "string",
 "statementActived": true
}

Caso já exista um Pagador, mas ainda não está com o Extrato Open Finance ativo, então:

Método:

PUT https://staging.pagamentobancario.com.br/api/v1/payer

Requisição:

{
   "statementActived": true
}

Resposta:

{
 "name": "string",
 "email": "string",
 "cpfCnpj": "string",
 "accounts": [],
 "street": "string",
 "neighborhood": "string",
 "addressNumber": "string",
 "addressComplement": "string",
 "city": "string",
 "state": "string",
 "zipcode": "string",
 "token": "string",
 "statementActived": true
}

Para mais informações sobre preenchimento das requisições, acesse nossa documentação detalhada.

2. Cadastrar Conta (account)

Para ativar a funcionalidade na Conta é obrigatório informar o campo "statementActived": true. 

Método:

POST https://staging.pagamentobancario.com.br/api/v1/account

Requisição:

[
  {
    "bankCode": "001",
    "agency": "1111",
    "agencyDigit": "",
    "accountNumber": "0001",
    "convenioAgency": "",
    "convenioNumber": "22",
    "remessaSequential": 0,
    "accountDac": "",
    "accountType": "",
    "accountPayment": false,
    "webservice": false,
    "codeContract": "",
    "clientKey": "",
    "clientSecret": "",
    "clientId": "",
    "recipientNotification": false,
    "statementActived": true
  }
]

Resposta:

{
  "accounts": [
    {
      "bankCode": "string",
      "accountHash": "string",
      "agency": "string",
      "agencyDigit": "string",
      "accountNumber": "string",
      "accountNumberDigit": "string",
      "convenioAgency": "string",
      "convenioNumber": "string",
      "remessaSequential": 0,
      "accountPayment": true,
      "statementActived": true,
      "openfinanceLink": "https://staging.pagamentobancario.com.br/gui/7e23a377f1264936a19c4689c7bffa0c"
    }
  ]
}

Para mais informações sobre preenchimento das requisições, acesse nossa documentação detalhada.

3. Criar Conector Open Finance

Na resposta será entregue o campo openfinanceLink. Nele será retornado um link como esse https://staging.pagamentobancario.com.br/gui/7e23a377f1264936a19c4689c7bffa0c. 

Agora, acessando o link, será feita a criação do Conector. 

Será aberto uma janela solicitando concentimento com os termos e, prosseguindo, serão apresentados os bancos disponíveis para Pessoa Física (conta Pessoal) ou Pessoa Jurídica (conta Empresa). 

Localize o banco desejado e preencha as informações necessárias para receber o pedido de autorização do Open Finance. 

Feito esse processo, no Internet Banking ou Aplicativo, será solicitada a permissão para a Tecnospeed coletar as informações de transações da conta.

Após aprovação e conclusão da criação do conector, será exibido o openfinanceId. Não é necessário copiar, mas pode se preferir. Esse campo é retornado na consulta da conta.

Caso a conta já esteja com o seu conector cadastrado, não será possível repetir o processo. Uma mensagem de conta vincula será exibida.

Caso o link for alterado e estiver inválido, será apresentada a seguinte informação: 

4. Consultar Conta

Após o vínculo do conector com a conta criada, será exibido na consulta da conta o openfinanceId. Essa informação pode ser utilizada para controle interno, no entanto, nós estaremos salvando e mantendo ela para utilização dos recursos do produto. 

Método:

GET https://staging.pagamentobancario.com.br/api/v1/account/:accountHash

Resposta:

{
  "accounts": {
    "bankCode": "string",
    "accountHash": "string",
    "agency": "string",
    "agencyDigit": "string",
    "accountNumber": "string",
    "accountNumberDigit": "string",
    "convenioAgency": "string",
    "convenioNumber": "string",
    "remessaSequential": 0,
    "statementActived": true,
    "openfinanceLink": "https://staging.pagamentobancario.com.br/gui/7e23a377f1264936a19c4689c7bffa0c",
    "openfinanceId": "ab4dafd0-0b00-4a5a-8dd0-13b8ae90a37e"
  }
}

Após finalizado todos os processos acima, o Pagador e a Conta já possuem os critérios necessários para obter os Extratos Open Finance. 

5. Sincronização e Liberação das Transações

Após a ativação do conector a instituição e o OpenFinance precisam sincronizar os dados da conta recém aprovada para serem consultados e essa interação pode levar um tempo variável entre instituições. 

Para saber mais detalhes, consulte essa documentação!

Quer saber como gerar um Extrato Open Finance? Clique aqui!