BAbankly
Conta pessoa física

Consulta de contas

<div class="bkly-ref-description"> <p>Realize a consulta de todas as contas que determinado cliente do tipo <b>pessoa física</b> possui.</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 contas](/docs/consulta-contas-cliente-pessoa-fisica)." } [/block]
get/customers/{documentNumber}/accounts

Request

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

Path parameters

documentNumberstring required

Número do documento CPF do cliente do cliente pessoal ou representante legal.

Número do documento CPF do cliente pessoa física ou representante legal da empresa. Informe somente números.

Query parameters

codestring

Código do banco da conta consultada.

branchstring

Número da agência associada à conta consultada.

type'checking' | 'payment'

Tipo de conta.

status'active' | 'closed'

Situação da conta.

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

Número da agência bancária.

numberstring

Número da conta de pagamento.

type'checking' | '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.