Geração do ticket de acesso ao WebView

Este endpoint permite que nosso parceiro gere um ticket que dará acesso ao WebView para iniciar a transmissão de dados de seu cliente.

Pré-requisitos

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

O parceiro tenha cumprido os pré-requisitos descritos na documentação Transmissão de dados por WebView.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/open-finance/ticket

--request POST 'https://sandbox.hiperbanco.com.br/open-finance/ticket' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "requestUri": "string",
  "openFinanceClientId": "string"
}'

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)

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:

Campo	Tipo	Descrição
`requestUri`	`string`	URI da requisição
`openFinanceClientId`	`string`	Identificador do cliente no Open Finance

📘
Nota
Em sandbox , é possível enviar valores fictícios nos campos requestUri e openFinanceClientId para a realização de testes.

{
  "requestUri": "string",
  "openFinanceClientId": "string"
}

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
`ticketId`	`string`	Identifica o ticket gerado pelo parceiro, com tempo de vida de 60 segundos.

{
    "ticketId": "d0eda1ef-b6b6-4d0f-bffc-f3e8b6776fc9"
}

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