Geração do ticket de acesso ao WebView
stable
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://api-mtls.sandbox.bankly.com.br/openfinance/consent-flow/ticket
--request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/openfinance/consent-flow/ticket' \
--header 'idempotencyKey: 04106038-4063-48bc-a0e4-13c178dd058f' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"requestUri": "17307eb8-e9e6-4ce1-a14d-6f30923746f2",
"clientId": "7481c175-4a50-4af2-b3b1-b24a109f92ad",
"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:
| Scope | Descrição |
|---|---|
openfinance.ticket.write | Concede acesso para criar um ticket para a transmissão de dados no contexto Open Finance. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-correlation-id | Informe um GUID, sendo um novo cada requisição. |
idempotencyKey | Chave de idempotêcia. Informe um GUID, sendo um novo cada requisição. |
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:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
requestUri | string | Obrigatório. Valor coletado pelo parceiro via querystring através do deep link de redirecionamento. | O valor expira em 60 segundos. |
clientId | string | Obrigatório. Código do cliente. Este valor é coletado pelo parceiro via querystring através do deep link de redirecionamento. | — |
documentNumber | string | Obrigatório. Número do documento do cliente. | Informe somente os números. |
Nota
Em sandbox , é possível enviar valores fictícios nos campos
requestUrieclientIdpara a realização de testes.
{
"requestUri": "17307eb8-e9e6-4ce1-a14d-6f30923746f2",
"clientId": "7481c175-4a50-4af2-b3b1-b24a109f92ad",
"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:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
ticketId | string | Identifica o ticket gerado pelo parceiro, com tempo de vida de 60 segundos. | 32 |
companyKey | string | Chave que identifica o parceiro dentro do Bankly. | 36 |
documentNumber | string | Número do documento do cliente. | — |
requestUri | string | Valor coletado pelo parceiro via querystring através do deep link de redirecionamento, com tempo de vida de 60 segundos. | — |
clientId | string | Valor coletado pelo parceiro via querystring através do deep link de redirecionamento. | — |
status | string | Situação do ticket, a qual pode ser USED (o ticket foi utilizado pelo usuário) e UNUSED (o ticket não foi utilizado pelo usuário). | — |
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. | — |
{
"ticketId": "5e68b45d-4910-4c40-9c3e-ec57c835120d",
"companyKey": "ACESSO",
"documentNumber": "47742663023",
"requestUri": "6891d1bd-60af-4fd5-b3ab-82b8580cf27e",
"clientId": "9f58c6cf-34d7-44d6-835d-5211aecdbffb",
"status": "UNUSED",
"createdAt": "2024-10-15T18:55:15",
"updatedAt": "2024-10-15T18:55:15"
}
Eventos
Este endpoint não possui eventos relacionados a ele
Updated about 14 hours ago