Geração de tickets

Gestão de consentimentos

<div class="bkly-ref-description"> <p>Gere um <i>ticket</i> que dará acesso ao <i>WebView</i> para efetuar a gestão dos consentimentos de seu cliente.</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 [Gestão de consentimentos](/docs/gestao-consentimentos)." } [/block]
post/consent-management/ticket

Request

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

Parameters

#/paths/~1consent-flow~1ticket/post/parameters/0 (unresolved $ref)
#/paths/~1consent-flow~1ticket/post/parameters/2 (unresolved $ref)
#/paths/~1consent-flow~1ticket/post/parameters/1 (unresolved $ref)
#/paths/~1consent-flow~1ticket/post/parameters/3 (unresolved $ref)

Request body

documentNumberstring required

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

accountNumberstring required

Número de uma conta ativa do cliente. Informe somente os números.

Response

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

accountNumberstring

Número da conta do cliente.

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.

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": "b17eed4d-cd0f-45ec-8c35-d47006c25acf",
  "companyKey": "ACESSO",
  "documentNumber": "47742663023",
  "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.