Introdução

API’S

Gestão de Contas

Conta pocket
Informe de Rendimentos
- Dados para informe de rendimentosget

Gestão de boletos

Emissão de boleto
Baixa efetiva
- Simulação de pagamentopost
Cancelamento de boleto
- Solicitação de cancelamentodelete

Gestão de Faturas

Consulta de faturas
Limite de crédito
- Consulta do limite de créditoget
Pagamento de faturas
- Geração de uma forma de pagamentopost

Introdução

API’S

Gestão de Contas

Conta pocket
Informe de Rendimentos
- Dados para informe de rendimentosget

Gestão de boletos

Emissão de boleto
Baixa efetiva
- Simulação de pagamentopost
Cancelamento de boleto
- Solicitação de cancelamentodelete

Gestão de Faturas

Consulta de faturas
Limite de crédito
- Consulta do limite de créditoget
Pagamento de faturas
- Geração de uma forma de pagamentopost

Dados para informe de rendimentos

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

Obtenha os dados necessários para gerar o Informe de Rendimentos de contas de pagamentos (pessoa física ou jurídica) e de outras fontes pagadoras.
É possível refinar a busca informando o ano calendário desejado (o padrão é sempre o ano vigente).
stable scope: income.report.read

🚧
Importante
Para mais detalhes sobre os campos retornados nessa requisição, consulte o Manual do dev.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

accountNumber

string | null

required

Número da conta da qual se deseja obter os dados para o informe.

Query Params

calendar

int32

Ano para a geração das informações do informe de rendimento. O valor padrão será o ano atual da consulta menos um.

Headers

api-version

string

required

Defaults to 2

Versão da API.
Utilize este endpoint na versão 2.0.

Authorization

string

required

Token de autorização do tipo Bearer.

Responses

Response body

object

data

object

holder

object

Dados do titular da conta.

account

object

payers

array of objects | null

payers

object

source

object

Objeto que contém informações sobre a fonte pagadora.

group

string

Grupo da ficha de bens e direitos a ser informado na declaração.

currencies

object

netIncome

object

links

array of objects | null

links

object

url

string | null

URLs que podem ser utilizadas em um próximo estado da entidade. Nesse caso, trata-se da própria requisição realizada.

rel

string | null

Descrição de como a URL se relaciona com o recurso atual.

method

string | null

Tipo de verbo que deve ser utilizado para acessar a URL. Nesse caso, é o GET.

metadata

object | null

Metadados da requisição.

Headers

object

x-bkly-correlation-id

string

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

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

Encerramento de uma conta pocket

Emissão de boleto

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-mtls.sandbox.bankly.com.br/accounts/accountNumber/income-report \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 2'

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

application/json

*/*

Updated about 2 months ago

Encerramento de uma conta pocket

Emissão de boleto

Did this page help you?

Introdução
API’S

Gestão de Contas
Conta pocket
Encerramento de uma conta pocketpatch
Consulta de uma transaçãoget
Resgate de um valor da conta pocketpost
Depósito em uma conta pocketpost
Alteração do usuáriopatch
Consulta do saldo de uma conta pocketget
Consulta dos dados de uma conta pocketget
Consulta dos dados de todas as contas pocketsget
Criação de conta pocketpost
Informe de Rendimentos
Dados para informe de rendimentosget

Gestão de boletos
Emissão de boleto
Impressão do boletoget
Consulta por authenticationCodeget
Solicitação de emissão de boletospost
Baixa efetiva
Simulação de pagamentopost
Cancelamento de boleto
Solicitação de cancelamentodelete

Gestão de Faturas
Consulta de faturas
Consulta de transações por cartãoget
Consulta de fatura por IDget
Consulta do sumário da faturaget
Limite de crédito
Consulta do limite de créditoget
Pagamento de faturas
Geração de uma forma de pagamentopost

Introdução
API’S

Gestão de Contas
Conta pocket
Encerramento de uma conta pocketpatch
Consulta de uma transaçãoget
Resgate de um valor da conta pocketpost
Depósito em uma conta pocketpost
Alteração do usuáriopatch
Consulta do saldo de uma conta pocketget
Consulta dos dados de uma conta pocketget
Consulta dos dados de todas as contas pocketsget
Criação de conta pocketpost
Informe de Rendimentos
Dados para informe de rendimentosget

Gestão de boletos
Emissão de boleto
Impressão do boletoget
Consulta por authenticationCodeget
Solicitação de emissão de boletospost
Baixa efetiva
Simulação de pagamentopost
Cancelamento de boleto
Solicitação de cancelamentodelete

Gestão de Faturas
Consulta de faturas
Consulta de transações por cartãoget
Consulta de fatura por IDget
Consulta do sumário da faturaget
Limite de crédito
Consulta do limite de créditoget
Pagamento de faturas
Geração de uma forma de pagamentopost

200Recurso encontrado.

204Recurso encontrado, mas não existe conteúdo na sua requisição.

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

404Recurso não encontrado.

500Ocorreu algum erro inexperado em nosso servidor.