Introdução

API’S

Segurança e Autenticação

Autenticação com mTLS
- Token para gerar certificado mTLSpost
- Download do certificado mTLSpost

TOTP

Validação TOTP
- Geração do hash e do código numéricopost
- Validação do hash e do código numéricopatch

Webhooks

Configurações dos webhooks
Mensagens
- Consulta de mensagens enviadasget
- Reprocessamento de mensagenspost

Open Finance

Geração de tickets
- Geração do ticket de acesso ao WebViewpost
- Gestão de consentimentospost

ID One

Análise de documentos
- Consulta do status da análiseget
Token de autenticação de identidade
- Solicitação de novo tokenpost

Registro do cliente

Pessoa física
Pessoa jurídica

Gestão de Contas

Acordos legais
- Obtenção do documento (acordo legal)get
- Aceite do acordo legalpost
Conta pessoa física
- Abertura de contapost
- Consulta de contasget
Conta pessoa jurídica
- Abertura de contapost
- Consulta de contasget
Consulta e encerramento
- Consulta de dados de uma contaget
- Encerramento de contapatch
Informe de Rendimentos
- Informe de rendimentosget

Limites transacionais

Gestão de limites
- Consulta de limite por featureget
- Criação e atualização de limites personalizadosput

Gestão de cartões

Emissão de cartão
Cartões No Name
Consulta de cartões
Rastreio de cartões
- Por proxyget
- Alteração de endereçopost
Gestão de limite de crédito
- Alteração de limite ativo de cartão pós-pagopatch
Gestão do status
Carteiras digitais
- Geração de tokenpost
- Geração de dados de ativaçãopost
Gestão de senha
- Alteração de senhapatch
- Consulta de senha com criptografiaget
Configuração do cartão
- Configuração do contactlesspatch
- Alteração da data de vencimentoput
Consulta de transações
- Consulta de transações por cartãoget

Gestão de Faturas

Consulta de faturas
Limite de crédito
- Consulta do limite de créditoget
Refinanciamento de fatura
- Simulação de parcelamentos de uma faturapost
Pagamento de faturas
- Geração de uma forma de pagamentopost
- Consulta de opções de pagamentoget
Antecipação de parcelas
- Simulação de antecipação de parcelasget
- Confirmação de antecipação de parcelaspost

Gestão de crédito

Pré-análise de crédito
- Criação de pré-análise de créditopost
Análise de crédito

Transações bandeiradas com cartões

Autenticação 3DS
- Simulação de criação do desafio (challengeId)post
- Confirmação do desafiopatch

Pix

Diretório de chaves - DICT
Reivindicação de chaves
Pagamentos instantâneos
QR Codes

TED

Operações via TED

Pagamento de contas

Pagamento de contas
- Validação do títulopost
- Confirmação do pagamentopost
Consultas
- Consulta de pagamento por contaget
- Consulta por código de autenticaçãoget

API de Eventos

Feed de eventosget

Serviços Auxiliares

Endereços
- Consulta de endereço por CEPget
- Listagem de cidades por sigla do estadoget
Instituições Financeiras
- Listagem de instituições financeirasget
- Consulta de instituições financeiras por ISPB ou código bancárioget

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]

Criar nova análise de crédito
- Análise de créditopost

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]

Criar nova análise de crédito
- Análise de créditopost

Introdução

API’S

Segurança e Autenticação

Autenticação com mTLS
- Token para gerar certificado mTLSpost
- Download do certificado mTLSpost

TOTP

Validação TOTP
- Geração do hash e do código numéricopost
- Validação do hash e do código numéricopatch

Webhooks

Configurações dos webhooks
Mensagens
- Consulta de mensagens enviadasget
- Reprocessamento de mensagenspost

Open Finance

Geração de tickets
- Geração do ticket de acesso ao WebViewpost
- Gestão de consentimentospost

ID One

Análise de documentos
- Consulta do status da análiseget
Token de autenticação de identidade
- Solicitação de novo tokenpost

Registro do cliente

Pessoa física
Pessoa jurídica

Gestão de Contas

Acordos legais
- Obtenção do documento (acordo legal)get
- Aceite do acordo legalpost
Conta pessoa física
- Abertura de contapost
- Consulta de contasget
Conta pessoa jurídica
- Abertura de contapost
- Consulta de contasget
Consulta e encerramento
- Consulta de dados de uma contaget
- Encerramento de contapatch
Informe de Rendimentos
- Informe de rendimentosget

Limites transacionais

Gestão de limites
- Consulta de limite por featureget
- Criação e atualização de limites personalizadosput

Gestão de cartões

Emissão de cartão
Cartões No Name
Consulta de cartões
Rastreio de cartões
- Por proxyget
- Alteração de endereçopost
Gestão de limite de crédito
- Alteração de limite ativo de cartão pós-pagopatch
Gestão do status
Carteiras digitais
- Geração de tokenpost
- Geração de dados de ativaçãopost
Gestão de senha
- Alteração de senhapatch
- Consulta de senha com criptografiaget
Configuração do cartão
- Configuração do contactlesspatch
- Alteração da data de vencimentoput
Consulta de transações
- Consulta de transações por cartãoget

Gestão de Faturas

Consulta de faturas
Limite de crédito
- Consulta do limite de créditoget
Refinanciamento de fatura
- Simulação de parcelamentos de uma faturapost
Pagamento de faturas
- Geração de uma forma de pagamentopost
- Consulta de opções de pagamentoget
Antecipação de parcelas
- Simulação de antecipação de parcelasget
- Confirmação de antecipação de parcelaspost

Gestão de crédito

Pré-análise de crédito
- Criação de pré-análise de créditopost
Análise de crédito

Transações bandeiradas com cartões

Autenticação 3DS
- Simulação de criação do desafio (challengeId)post
- Confirmação do desafiopatch

Pix

Diretório de chaves - DICT
Reivindicação de chaves
Pagamentos instantâneos
QR Codes

TED

Operações via TED

Pagamento de contas

Pagamento de contas
- Validação do títulopost
- Confirmação do pagamentopost
Consultas
- Consulta de pagamento por contaget
- Consulta por código de autenticaçãoget

API de Eventos

Feed de eventosget

Serviços Auxiliares

Endereços
- Consulta de endereço por CEPget
- Listagem de cidades por sigla do estadoget
Instituições Financeiras
- Listagem de instituições financeirasget
- Consulta de instituições financeiras por ISPB ou código bancárioget

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]

Criar nova análise de crédito
- Análise de créditopost

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]

Criar nova análise de crédito
- Análise de créditopost

Consulta de dados de uma conta

get https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}

Realize a consulta dos dados de uma conta específica. Opcionalmente, é possível obter o saldo dessa conta (exceto o saldo bloqueado).

stable scope: account.read

📘
Nota
Para mais informações, confira a documentação Consulta de dados de uma conta.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

accountNumber

string

required

length between 3 and 13

Número da conta.

Query Params

includeBalance

boolean

Defaults to false

Inclua o saldo da conta na pesquisa.

code

string

Defaults to 332

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

branch

string

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

Headers

api-version

string

required

Defaults to 1

Versão da API.
Atualmente estamos na 1.0.

Authorization

string

required

Token de autorização do tipo Bearer.

Responses

Response body

object

balance

object

Objeto que contém informações sobre o saldo sumarizado da conta.

inProcess

object

Saldo em processamento (cash-in).

available

object

Saldo disponível.

blocked

object

Este objeto está obsoleto e, portanto, deve ser desconsiderado, pois sempre retornará o valor zero. Para obter informações sobre o saldo bloqueado, por favor, abra um chamado no Service Desk ou utilize os eventos de webhook de bloqueio de saldo.

status

string

Situação da conta.

ACTIVE CLOSED

branch

string

length between 4 and 4

Agência bancária.
Default: 0001.

number

string

length between 3 and 13

Número da conta de pagamento.

type

string

Tipo de conta.

payment

bank

object

Objeto que contém os dados bancários da conta.

ispb

string

ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.

code

string

Código do banco.

name

string

Nome do banco.

programId

string

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

Headers

object

x-bkly-correlation-id

string

Id correlação da operação requisitada.

Response body

object

errors

array of objects | null

Lista de erros identificados. Trate-os antes de tentar novamente.

errors

object

code

string | null

Código do erro.

propertyName

string | null

Parâmetro ou propriedade com problema. Somente será retornado quando o erro for de sintaxe (Bad Request).

message

array of strings | null

Lista de descrições do problema encontrado.

message

reference

string

Headers

object

x-bkly-correlation-id

string

Id correlação da operação requisitada.

Response body

object

errors

array of objects | null

Lista de erros identificados. Trate-os antes de tentar novamente.

errors

object

code

string | null

Código do erro.

propertyName

string | null

Parâmetro ou propriedade com problema. Somente será retornado quando o erro for de sintaxe (Bad Request).

message

array of strings | null

Lista de descrições do problema encontrado.

message

reference

string

Headers

object

x-bkly-correlation-id

string

Id correlação da operação requisitada.

Response body

object

errors

array of objects | null

Lista de erros identificados. Trate-os antes de tentar novamente.

errors

object

code

string | null

Código do erro.

propertyName

string | null

Parâmetro ou propriedade com problema. Somente será retornado quando o erro for de sintaxe (Bad Request).

message

array of strings | null

Lista de descrições do problema encontrado.

message

reference

string

Headers

object

x-bkly-correlation-id

string

Id correlação da operação requisitada.

Response body

object

errors

array of objects | null

Lista de erros identificados. Trate-os antes de tentar novamente.

errors

object

code

string | null

Código do erro.

propertyName

string | null

Parâmetro ou propriedade com problema. Somente será retornado quando o erro for de sintaxe (Bad Request).

message

array of strings | null

Lista de descrições do problema encontrado.

message

reference

string

Headers

object

x-bkly-correlation-id

string

Id correlação da operação requisitada.

Response body

object

errors

array of objects | null

Lista de erros identificados. Trate-os antes de tentar novamente.

errors

object

code

string | null

Código do erro.

propertyName

string | null

Parâmetro ou propriedade com problema. Somente será retornado quando o erro for de sintaxe (Bad Request).

message

array of strings | null

Lista de descrições do problema encontrado.

message

reference

string

Headers

object

x-bkly-correlation-id

string

Id correlação da operação requisitada.

Updated about 2 months ago

Consulta de contas

Encerramento de conta

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api-mtls.sandbox.bankly.com.br/accounts/?includeBalance=false&code=332' \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 1'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 months ago

Consulta de contas

Encerramento de conta

Did this page help you?

Introdução
API’S

Segurança e Autenticação
Autenticação com mTLS
Download do certificado mTLSpost
Token para gerar certificado mTLSpost

TOTP
Validação TOTP
Validação do hash e do código numéricopatch
Geração do hash e do código numéricopost

Webhooks
Configurações dos webhooks
Habilitar uma configuraçãopatch
Desabilitar uma configuraçãopatch
Exclusão de configuraçãodelete
Alteração da configuraçãopatch
Consulta de configurações de webhook específicoget
Consulta de todas as configurações de webhooksget
Registro de um novo webhookpost
Mensagens
Reprocessamento de mensagenspost
Consulta de mensagens enviadasget

Open Finance
Geração de tickets
Gestão de consentimentospost
Geração do ticket de acesso ao WebViewpost

ID One
Análise de documentos
Consulta do status da análiseget
Token de autenticação de identidade
Solicitação de novo tokenpost

Registro do cliente
Pessoa física
Offboarding de pessoa físicapatch
Atualização cadastralpatch
Consulta do registro do clienteget
Registro de pessoa físicaput
Pessoa jurídica
Offboarding de pessoa jurídicapatch
Registro de pessoa jurídica (LTDA, S.A. ou TS)put
Envio de documentos de pessoa jurídica (LTDA, S.A. e TS)put
Consulta do registro da empresaget
Registro de pessoa jurídica (MEI, EI, EIRELI ou SLU)put

Gestão de Contas
Acordos legais
Aceite do acordo legalpost
Obtenção do documento (acordo legal)get
Conta pessoa física
Consulta de contasget
Abertura de contapost
Conta pessoa jurídica
Consulta de contasget
Abertura de contapost
Consulta e encerramento
Encerramento de contapatch
Consulta de dados de uma contaget
Informe de Rendimentos
Informe de rendimentosget

Limites transacionais
Gestão de limites
Criação e atualização de limites personalizadosput
Consulta de limite por featureget

Gestão de cartões
Emissão de cartão
Segunda via de cartãopost
Cartão físico múltiplopost
Cartão físicopost
Cartão virtualpost
Cartões No Name
Consulta dos lotesget
Consulta de lote por IDget
Vinculação do cartão com uma conta bancáriapatch
Emissão de cartão em lotepost
Consulta de cartões
Dados de segurança do cartãopost
Por contaget
Por código de ativaçãoget
Por documento (CPF ou CNPJ)get
Por proxyget
Rastreio de cartões
Alteração de endereçopost
Por proxyget
Gestão de limite de crédito
Alteração de limite ativo de cartão pós-pagopatch
Gestão do status
Consulta dos próximos statusget
Alteração do status do cartãopatch
Ativação de cartãopatch
Carteiras digitais
Geração de dados de ativaçãopost
Geração de tokenpost
Gestão de senha
Consulta de senha com criptografiaget
Alteração de senhapatch
Configuração do cartão
Alteração da data de vencimentoput
Configuração do contactlesspatch
Consulta de transações
Consulta de transações por cartãoget

Gestão de Faturas
Consulta de faturas
Consulta de fatura por períodoget
Consulta de fatura por IDget
Consulta de fatura abertaget
Limite de crédito
Consulta do limite de créditoget
Refinanciamento de fatura
Simulação de parcelamentos de uma faturapost
Pagamento de faturas
Consulta de opções de pagamentoget
Geração de uma forma de pagamentopost
Antecipação de parcelas
Confirmação de antecipação de parcelaspost
Simulação de antecipação de parcelasget

Gestão de crédito
Pré-análise de crédito
Criação de pré-análise de créditopost
Análise de crédito
Aceite do novo limite de contrato de créditoput
Reanálise do limite de contrato de créditoput
Consulta de contrato de créditoget
Aceite da proposta do contrato de créditopost
Criação de análise de créditopost

Transações bandeiradas com cartões
Autenticação 3DS
Confirmação do desafiopatch
Simulação de criação do desafio (challengeId)post

Pix
Diretório de chaves - DICT
Exclusão de chavesdelete
Consulta de chaves para transferênciaget
Cadastro de chavespost
Consulta de chaves de uma contaget
Reivindicação de chaves
Cancelamento de um pedido de reivindicaçãopatch
Simulação de reconhecimento de pedido de reivindicaçãopost
Completando um pedido de reivindicaçãopatch
Confirmação do pedido de reivindicaçãopatch
Consulta dos pedidos de reivindicaçãoget
Criação de pedido de reivindicaçãopost
Pagamentos instantâneos
Devolução de transferência Pixpost
Consulta do status da transaçãoget
Transferência via Pixpost
QR Codes
Decodificação de QR Codes estáticos e dinâmicospost
Emissão de QR Codes dinâmicospost
Emissão de QR Codes estáticospost

TED
Operações via TED
Consulta por código de autenticaçãoget
Consulta por contaget
Transferência via TEDpost

Pagamento de contas
Pagamento de contas
Confirmação do pagamentopost
Validação do títulopost
Consultas
Consulta por código de autenticaçãoget
Consulta de pagamento por contaget

API de Eventos
Feed de eventosget

Serviços Auxiliares
Endereços
Listagem de cidades por sigla do estadoget
Consulta de endereço por CEPget
Instituições Financeiras
Consulta de instituições financeiras por ISPB ou código bancárioget
Listagem de instituições financeirasget

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]
Criar nova análise de crédito
Análise de créditopost

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]
Criar nova análise de crédito
Análise de créditopost

Introdução
API’S

Segurança e Autenticação
Autenticação com mTLS
Download do certificado mTLSpost
Token para gerar certificado mTLSpost

TOTP
Validação TOTP
Validação do hash e do código numéricopatch
Geração do hash e do código numéricopost

Webhooks
Configurações dos webhooks
Habilitar uma configuraçãopatch
Desabilitar uma configuraçãopatch
Exclusão de configuraçãodelete
Alteração da configuraçãopatch
Consulta de configurações de webhook específicoget
Consulta de todas as configurações de webhooksget
Registro de um novo webhookpost
Mensagens
Reprocessamento de mensagenspost
Consulta de mensagens enviadasget

Open Finance
Geração de tickets
Gestão de consentimentospost
Geração do ticket de acesso ao WebViewpost

ID One
Análise de documentos
Consulta do status da análiseget
Token de autenticação de identidade
Solicitação de novo tokenpost

Registro do cliente
Pessoa física
Offboarding de pessoa físicapatch
Atualização cadastralpatch
Consulta do registro do clienteget
Registro de pessoa físicaput
Pessoa jurídica
Offboarding de pessoa jurídicapatch
Registro de pessoa jurídica (LTDA, S.A. ou TS)put
Envio de documentos de pessoa jurídica (LTDA, S.A. e TS)put
Consulta do registro da empresaget
Registro de pessoa jurídica (MEI, EI, EIRELI ou SLU)put

Gestão de Contas
Acordos legais
Aceite do acordo legalpost
Obtenção do documento (acordo legal)get
Conta pessoa física
Consulta de contasget
Abertura de contapost
Conta pessoa jurídica
Consulta de contasget
Abertura de contapost
Consulta e encerramento
Encerramento de contapatch
Consulta de dados de uma contaget
Informe de Rendimentos
Informe de rendimentosget

Limites transacionais
Gestão de limites
Criação e atualização de limites personalizadosput
Consulta de limite por featureget

Gestão de cartões
Emissão de cartão
Segunda via de cartãopost
Cartão físico múltiplopost
Cartão físicopost
Cartão virtualpost
Cartões No Name
Consulta dos lotesget
Consulta de lote por IDget
Vinculação do cartão com uma conta bancáriapatch
Emissão de cartão em lotepost
Consulta de cartões
Dados de segurança do cartãopost
Por contaget
Por código de ativaçãoget
Por documento (CPF ou CNPJ)get
Por proxyget
Rastreio de cartões
Alteração de endereçopost
Por proxyget
Gestão de limite de crédito
Alteração de limite ativo de cartão pós-pagopatch
Gestão do status
Consulta dos próximos statusget
Alteração do status do cartãopatch
Ativação de cartãopatch
Carteiras digitais
Geração de dados de ativaçãopost
Geração de tokenpost
Gestão de senha
Consulta de senha com criptografiaget
Alteração de senhapatch
Configuração do cartão
Alteração da data de vencimentoput
Configuração do contactlesspatch
Consulta de transações
Consulta de transações por cartãoget

Gestão de Faturas
Consulta de faturas
Consulta de fatura por períodoget
Consulta de fatura por IDget
Consulta de fatura abertaget
Limite de crédito
Consulta do limite de créditoget
Refinanciamento de fatura
Simulação de parcelamentos de uma faturapost
Pagamento de faturas
Consulta de opções de pagamentoget
Geração de uma forma de pagamentopost
Antecipação de parcelas
Confirmação de antecipação de parcelaspost
Simulação de antecipação de parcelasget

Gestão de crédito
Pré-análise de crédito
Criação de pré-análise de créditopost
Análise de crédito
Aceite do novo limite de contrato de créditoput
Reanálise do limite de contrato de créditoput
Consulta de contrato de créditoget
Aceite da proposta do contrato de créditopost
Criação de análise de créditopost

Transações bandeiradas com cartões
Autenticação 3DS
Confirmação do desafiopatch
Simulação de criação do desafio (challengeId)post

Pix
Diretório de chaves - DICT
Exclusão de chavesdelete
Consulta de chaves para transferênciaget
Cadastro de chavespost
Consulta de chaves de uma contaget
Reivindicação de chaves
Cancelamento de um pedido de reivindicaçãopatch
Simulação de reconhecimento de pedido de reivindicaçãopost
Completando um pedido de reivindicaçãopatch
Confirmação do pedido de reivindicaçãopatch
Consulta dos pedidos de reivindicaçãoget
Criação de pedido de reivindicaçãopost
Pagamentos instantâneos
Devolução de transferência Pixpost
Consulta do status da transaçãoget
Transferência via Pixpost
QR Codes
Decodificação de QR Codes estáticos e dinâmicospost
Emissão de QR Codes dinâmicospost
Emissão de QR Codes estáticospost

TED
Operações via TED
Consulta por código de autenticaçãoget
Consulta por contaget
Transferência via TEDpost

Pagamento de contas
Pagamento de contas
Confirmação do pagamentopost
Validação do títulopost
Consultas
Consulta por código de autenticaçãoget
Consulta de pagamento por contaget

API de Eventos
Feed de eventosget

Serviços Auxiliares
Endereços
Listagem de cidades por sigla do estadoget
Consulta de endereço por CEPget
Instituições Financeiras
Consulta de instituições financeiras por ISPB ou código bancárioget
Listagem de instituições financeirasget

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]
Criar nova análise de crédito
Análise de créditopost

[Nome da API. Ex: Gestão de Contas, Gestão de Cartões]
Criar nova análise de crédito
Análise de créditopost

200Recurso encontrado.

400Há algum problema com a sua requisição.

403O acesso ao recurso foi negado pelo servidor.

409A solicitação conflitou com o estado atual do recurso existente no servidor.

422A sintaxe da requisição está correta, mas não foi possível processá-la devido a uma regra de negócio.

500Ocorreu algum erro inexperado em nosso servidor.