BAbankly
Consulta e encerramento

Consulta de dados de uma conta

<div class="bkly-ref-description"> <p>Realize a consulta dos dados de uma conta específica. Opcionalmente, é possível obter o saldo dessa conta (exceto o saldo bloqueado).</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: account.read</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Consulta de dados de uma conta](/docs/consulta-de-dados-de-uma-conta)." } [/block]
get/accounts/{accountNumber}

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}
  • Auth
    HTTP bearer

Path parameters

accountNumberstring required

Número da conta de pagamento.

Número da conta.

Query parameters

includeBalanceboolean

Inclua o saldo da conta na pesquisa.

codestring

Código do banco da conta consultada. Para conta corrente, este campo é <b>obrigatório</b>.

branchstring

Número da agência associada à conta consultada. Para conta corrente, este campo é <b>obrigatório</b>.

Parameters

#/paths/~1legal-agreements~1file/get/parameters/0 (unresolved $ref)
#/paths/~1legal-agreements~1file/get/parameters/1 (unresolved $ref)

Response

Recurso encontrado.

status'ACTIVE' | 'CLOSED'

Situação da conta.

branchstring

Agência bancária. Default: 0001.

numberSchema (unresolved $ref)
type'payment'

Tipo de conta.

programIdstring

Identificador do programa de contas que determina o tipo de conta.

Changes

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