BAbankly
Geração de tickets

Geração do ticket de acesso ao WebView

<div class="bkly-ref-description"> <p>Gere um <i>ticket</i> que dará acesso ao <i>WebView</i> para iniciar a transmissão de dados de seu cliente no ecossistema Open Finance.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: openfinance.ticket.write</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Geração do ticket de acesso ao WebView](/docs/geracao-ticket-webview)." } [/block]
post/consent-flow/ticket

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/consent-flow/ticket
  • Auth
    HTTP bearer

Headers

Authorizationstring required

<i>Token</i> de autorização do tipo Bearer.

api-versionstring required

Versão da API. Atualmente estamos na 1.0.

x-correlation-idstring required

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Idempotency-Keystring

Chave de idempotêcia para a requisição (UUID v4).

Request body

documentNumberstring required

Número do documento do cliente. Informe somente números

requestUristring required

Valor coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento.

clientIdstring required

Código do cliente. Esse valor é coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento.

Example request

{
  "requestUri": "urn:ietf:params:oauth:requestUri:d3a7230c-9caa-4f19-aaba-9deee8fb36ec",
  "clientId": "iUmcxvmD13G8rshtpOZ5tCbQKLvaF4O7"
}

Response

<i>Ticket</i> criado com sucesso.

ticketIdstring

Identifica o <i>ticket</i> gerado pelo parceiro, com tempo de vida de 60 segundos.

companyKeystring

Chave que identifica o parceiro dentro do Bankly.

documentNumberstring

Número do documento do cliente.

requestUristring

Valor coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento, com tempo de vida de 60 segundos.

clientIdstring

Código do cliente. Esse valor é coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento, com tempo de vida de 60 segundos.

status'USED' | 'UNUSED'

Situação do ticket.

createdAtstring date-time

Data e hora de criação do <i>ticket</i>.

updatedAtstring date-time

Data e hora de atualização do <i>ticket</i>.

Example response

{
  "ticketId": "107e4d99-b23a-4fbe-ab23-3dcc44aa995f",
  "companyKey": "ACESSO",
  "documentNumber": "47742663023",
  "requestUri": "urn:ietf:params:oauth:requestUri:d3a7230c-9caa-4f19-aaba-9deee8fb36ec",
  "clientId": "iUmcxvmD13G8rshtpOZ5tCbQKLvaF4O7",
  "status": "UNUSED",
  "createdAt": "2024-10-22T17:13:44",
  "updatedAt": "2024-10-22T17:13:44"
}

Changes

No recorded changes to this operation across all 1 revision of this API.