Gestão de consentimentos

Este endpoint permite que nosso parceiro gere um ticket que dará acesso ao WebView para efetuar a gestão dos consentimentos de seu cliente.

A gestão dos consentimentos deverá ocorrer numa tela acessada pelo cliente por meio do botão "Meus compartilhamentos”, disponível no Menu Open Finance do aplicativo do parceiro.

Nessa tela, o cliente dará o consentimento para o compartilhamento de seus dados e encontrará todos os detalhes do termo, como o nome da instituição receptora, informações a serem compartilhadas, período de compartilhamento, a conta que originará o compartilhamento de dados etc. Ainda na mesma tela, o cliente poderá revogar o consentimento dado anteriormente.

🚧

Importante

Quando o evento 'EventCloseWebview' for acionado, a aplicação do parceiro deverá reconhecê-lo e fechar o WebView.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

• O parceiro tenha implementado toda a jornada de transmissão de dados Open Finance.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/openfinance/consent-management/ticket

--request POST \
--uri 'https://api-mtls.sandbox.bankly.com.br/openfinance/consent-management/ticket' \
--header 'idempotency-key: 04106038-4063-48bc-a0e4-13c178dd058f' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>'  \
--data '{
    "accountNumber": "15164",
    "documentNumber": "47742663023"
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
    "accountNumber": "15164",
    "documentNumber": "47742663023"
}

Resposta (Response)

O status code 201 indicará que o ticket foi gerado com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "accountNumber": "15164",
    "ticketId": "a8059ba3-496f-47c5-8736-812aedb3b148",
    "companyKey": "ACESSO",
    "documentNumber": "39367935064",
    "status": "UNUSED",
    "createdAt": "2024-10-15T18:50:59",
    "updatedAt": "2024-10-15T18:50:59"
}

Eventos

Este endpoint não possui eventos relacionados a ele.