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.

Já a gestão dos pagamentos deverá ocorrer numa tela acessada pelo cliente por meio dos botões "Meus pagamentos" e “Minhas autorizações", também disponível no Menu Open Finance do aplicativo do parceiro.

⚠️
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://sandbox.hiperbanco.com.br/open-finance/consents

--request POST 'https://sandbox.hiperbanco.com.br/open-finance/consents' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição	Especificação
`redirectType`	`query`	Informe 1 para redirecionar para a seção "Meus compartilhamentos", 2 para redirecionar para a seção "Meus pagamentos" e 3 para redirecionar para a seção "Minhas autorizações".	Informe apenas números neste campo.

Corpo da requisição (Body)

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

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:

Nome	Tipo	Descrição
`accountNumber`	`string`	Número da conta do cliente.
`redirectType`	`number`	Tipo de redirecionamento.
`ticketId`	`string`	Identifica o ticket gerado pelo parceiro, com tempo de vida de 60 segundos.
`companyKey`	`string`	Chave que identifica o parceiro dentro do Banco liquidante.
`documentNumber`	`string`	Número do documento do cliente.
`status`	`string`	Situação do ticket, que pode ser `"USED"` (o ticket foi utilizado pelo usuário) e `"UNUSED"` (não utilizado).
`createdAt`	`string`	Data e hora de criação do ticket, no formato ISO 8601 - UTC.
`updatedAt`	`string`	Data e hora de atualização do ticket, no formato ISO 8601 - UTC.

{
  "accountNumber": "1104714229",
  "redirectType": 2,
  "ticketId": "7b163356-9fc0-4521-bc04-aabbba58101b",
  "companyKey": "SDB2_HIPERBANCO",
  "documentNumber": "73379344915",
  "status": "UNUSED",
  "createdAt": "2025-10-20T21:28:20",
  "updatedAt": "2025-10-20T21:28:20"
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.