Fluxo de Acesso a Informações de Conta

Quando o desenvolvedor deseja testar as APIs destinadas a Informações de Conta, é necessário criar um aplicativo em seu painel do tipo de produto BRAZIL AISP

O cliente consente com seu parceiro que gostaria de compartilhar suas informações bancárias e escolhe o PSP
O desenvolvedor contata o PSP e envia uma solicitação de consentimento de conta
- O PSP verifica se o Id do aplicativo do desenvolvedor (client_id) tem as autorizações necessárias
- PSP usa as informações e cria recursos de consentimento e inicializa o processo, alterando o status para AwaitingAuthorisation
O PSP responde ao desenvolvedor com uma resposta de consentimento, que também instrui o desenvolvedor sobre como proceder com a autenticação e autorização
O desenvolvedor redireciona o cliente do PSP para o site do PSP para autenticação e confirmação de consentimento
Após as verificações necessárias, o PSP envia o token de acesso ao desenvolvedor, que por sua parte, o utiliza para recuperar as informações da conta do Usuário

Teste através do Portal do Desenvolvedor

Os seguintes passos devem ser realizados para o Acesso a Informações de Conta

1. Selecionar APP

Clique Test para o APP selecionado, sendo redirecionado ao Swagger UI

2. Autenticação do Desenvolvedor

Primeiro passo no fluxo é a autenticação do App-Id do desenvolvedor. Clique no botão Autorizar e preencha o APP secret para obter o token de acesso específico para o Desenvolvedor

3. Chamada de Solicitação de Consentimento para Informações de Conta

O bearer token obtido pelo passo anterior deve ser preenchido no Endpoint de Consentimento para Informações de Conta - /v1/consents/

Como exemplo, use a chave privada abaixo para assinar a solicitação (corresponde aos JWKs fornecidos em App creation), cole no campo application signing private key acima do botão Autorizar

Utilize o payload abaixo para enviar requisições de informações de conta. A lista de contas está vazia neste momento, mas após a autorização do Usuário, a lista será populada com a conta que foi selecionada

{
   "data": {
      "loggedUser": {
         "document": {
            "identification": "11111111111",
            "rel": "CPF"
         }
      },
      "businessEntity": {
         "document": {
            "identification": "11111111111111",
            "rel": "CNPJ"
         }
      },
      "permissions": [
         "ACCOUNTS_BALANCES_READ",
         "ACCOUNTS_READ",
         "ACCOUNTS_OVERDRAFT_LIMITS_READ",
         "RESOURCES_READ",
         "ACCOUNTS_TRANSACTIONS_READ",
         "CREDIT_CARDS_ACCOUNTS_READ",
         "CREDIT_CARDS_ACCOUNTS_BILLS_READ",
         "CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ",
         "CREDIT_CARDS_ACCOUNTS_LIMITS_READ",
         "CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ",
         "CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ",
         "CUSTOMERS_BUSINESS_ADITTIONALINFO_READ",
         "FINANCINGS_READ",
         "FINANCINGS_SCHEDULED_INSTALMENTS_READ",
         "FINANCINGS_PAYMENTS_READ",
         "FINANCINGS_WARRANTIES_READ",
         "INVOICE_FINANCINGS_READ",
         "INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ",
         "INVOICE_FINANCINGS_PAYMENTS_READ",
         "INVOICE_FINANCINGS_WARRANTIES_READ",
         "LOANS_READ",
         "LOANS_SCHEDULED_INSTALMENTS_READ",
         "LOANS_PAYMENTS_READ",
         "LOANS_WARRANTIES_READ",
         "UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ",
         "UNARRANGED_ACCOUNTS_OVERDRAFT_READ",
         "UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ",
         "UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ"
      ],
      "expirationDateTime": "2025-03-01T00:00:00Z",
      "transactionFromDateTime": "2022-01-01T00:00:00Z",
      "transactionToDateTime": "2022-02-01T23:59:59Z"
   }
}

Se a solicitação for bem sucedida, o desenvolvedor receberá a seguinte resposta:

{
  "data": {
    "consentId": "urn:bancoex:C1DD33123",
    "creationDateTime": "2022-02-01T08:30:00Z",
    "status": "AWAITING_AUTHORISATION",
    "statusUpdateDateTime": "2021-05-21T08:30:00Z",
    "permissions": [
      "ACCOUNTS_READ",
      "ACCOUNTS_OVERDRAFT_LIMITS_READ",
      "RESOURCES_READ"
    ],
    "expirationDateTime": "2022-03-01T00:00:00Z",
    "transactionFromDateTime": "2022-01-01T00:00:00Z",
    "transactionToDateTime": "2022-02-01T23:59:59Z"
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2022-02-01T08:30:00Z"
  }
}

A resposta contém a identificação do consentimento, seu status, e o endpoint scaOAuth. Desenvolvedor deve utilizar a URI do endpoint do banco para redirecionar o Usuário para a autenticação.

4. Autenticação de Usuário

Clique em Autorizar no topo para iniciar a autenticação do Usuário.

O botão Authorizar é utilizado para autenticar o Usuário. Após login e captura de consentimento, o token do Usuário já estará disponível para acesso a informações de conta.

5. Chamada API para Informações de Conta

O cabeçalho para autorização de informações de conta é automaticamente preenchido. Teste na API obie-aisp/v1/aisp/accounts. Um exemplo de resposta será:

{
  "data": [
    {
      "brandName": "Organização A",
      "companyCnpj": "21128159000166",
      "type": "CONTA_DEPOSITO_A_VISTA",
      "compeCode": "001",
      "branchCode": "6272",
      "number": "94088392",
      "checkDigit": "4",
      "accountId": "92792126019929279212650822221989319252576"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2022-02-01T08:30:00Z"
  }
}