title | position | en | layout |
---|---|---|---|
Changelog |
12 |
/en/changelog |
pt |
A documentação da API é um projeto público no Github. Você pode acompanhar as mudanças na documentação na página dos commits.
- Inclui endpoint de Lotes
- Adiciona
customer_update
em Boletos - Adiciona
customer_update
em Assinaturas - Adiciona
customer_update
em Carnês
- Adiciona filtro por
created_at
para CNAB (Remessa) Listar CNABs - Adiciona filtro por
created_at
para CNAB (Retorno) Listar CNABs
- Adicionado novo endpoint para Download do CNAB de Retorno
- Ajusta documentação em Webhook Enviados
- Ajusta documentação em E-mails enviados
- Documenta o campo
resource_owner_id
em Eventos
- Retiramos a documentação sobre o banco S4fr4 por solicitação do banco.
- Remove obrigatoriedade do campo
description
em Boletos, Assinaturas e Carnês - Remove campos descontinuados
interest_daily_percentage
,interest_daily_value
,interest_monthly_percentage
,late_payment_interest
,discount_limit_date
,fine_for_delay
em Boletos, Assinaturas e Carnês - Remove endpoints descontinuados
GET /api/v1/bank_billets/cnpj_cpf
,GET /api/v1/bank_billets/our_number
eGET /api/v1/bank_billets/status
ePOST /api/v1/bank_billets/bulk
em Boletos - Documenta os campos
customer_ignore_sms
,customer_contact_person
epayment_count
em Boletos - Documenta os campos
customer_ignore_sms
,customer_contact_person
,payment_count
,days_for_sue
,days_for_revoke
edays_for_negativation
em Assinaturas - Documenta os campos
customer_ignore_sms
,customer_contact_person
,payment_count
,days_for_sue
,days_for_revoke
,days_for_negativation
,document_date
,document_type
,document_number
ecustom_bank_billets
em Carnês
- Adiciona informações sobre o módulo TOTVS Microsiga Protheus
- Documenta o campo
allow_expiration_on_weekends
em Carteiras de Cobrança
-
Adiciona os campos
pix_enabled
epix_qrcode
em Boletos -
Adiciona o campo
paid_by_pix
em Pagamentos de Boleto
- Atualiza slug de carteira
cecred-bs-1
paraailos-bs-1
em Ailos
- Atualiza o módulo do Totvs RM
-
Adiciona os campos
guarantor_name
,guarantor_cnpj_cpf
,guarantor_zipcode
,guarantor_address
,guarantor_city_name
,guarantor_state
,guarantor_neighborhood
,guarantor_address_number
,guarantor_address_complement
eguarantor_phone_number
em Carnês -
Adiciona os campos
guarantor_name
,guarantor_cnpj_cpf
,guarantor_zipcode
,guarantor_address
,guarantor_city_name
,guarantor_state
,guarantor_neighborhood
,guarantor_address_number
,guarantor_address_complement
eguarantor_phone_number
em Assinaturas
- Adiciona o campo
allow_expiration_on_weekends
em Carteiras de Cobrança - Documenta o campo
customer_ignore_email
em Boletos - Documenta o campo
customer_ignore_email
em Carnês - Documenta o campo
customer_ignore_email
em Assinaturas - Documenta o campo
ignore_email
em Boletos - Documenta o campo
ignore_email
em Clientes
- Adiciona o campo
days_for_negativation
em Boletos
- Depreciado o campo
default_to_import
em Carteiras de Cobrança
- Adiciona novo formato de endereço do beneficiário em Carteiras de Cobrança, a antiga maneira continua funcionando da mesma forma mas será depreciada.
- Adiciona o campo
default_to_import
em Carteiras de Cobrança
- Adiciona campo
tags
em Clientes - Adiciona filtro por
tags
nos Clientes - Corrige erro de digitação do campo
nickname
em Clientes - Endpoint de atualização dos Clientes não retorna conteúdo
- Adiciona módulo WHMCS
- Adiciona Política de Retenção de Dados
- Atualiza documentação do Zapier com as funções disponíveis na versão 2.0.0
- Remove eventos de webhook que não são mais usados.
- Remove a documentação do campo
source_type
na Importação de Boletos - Melhora a documentação dos formatos de arquivos aceitos na Importação de Boletos
- Documenta
charge_type
em Boletos - Documenta
dispatch_type
em Boletos - Documenta
register_type
em Boletos
- Documenta
split_payment
em Boletos - Documenta
floating
em Contas para Split
- Atualiza parâmentros de Contas para Split
- Depreca o endpoint em Criar boletos em lote
- Documenta o campo
created_from
ecreated_to
em Registro de Retorno
- Documenta ABC
- Documenta ARBI
- Documenta BIB
- Documenta BNP Paribas
- Atualiza Documenta Sofisa
- Altera nome da cooperativa CECRED para AILOS
- Documenta o campo
credit_at
em Registro de Retorno
- Documenta Relatórios
- Documenta filtro por
ID da Remessa
em Registro de Remessa - Documenta novos eventos de usuários em Eventos
- Documenta filtro por
ID do Objeto
em Webhooks enviados
- Atualiza lista de Tipo de Documento
- Remove status
downloaded
não utilizado em Remessas
- Atualiza lista de ocorrências Banrisul
- Adiciona filtro por ID do Objeto nos emails enviados
- Adiciona tabela de códigos de ocorrência do Boleto Simples
- Documenta Kind em Carteiras de Cobrança
- Documenta Registros de Boleto
- Adicionado novo endpoint para Excluir pendências.
- Documenta o campo
line_parsed
em Registro de Retorno
- Documenta o campo
truncated_address
em Clientes
- Adiciona o campo
control_number
em Boletos - Descontinuando o endpoint de filtro de Boletos por status
- Descontinuando o endpoint de filtro de Boletos por CPF/CNPJ
- Descontinuando o endpoint de filtro de Boletos por nosso número
- Documenta Pagamentos de Boleto
- Atualiza lista de Eventos
- Documenta E-mails enviados
- Atualiza lista de carteiras do Safra
- Documenta Cancelar boletos em lote.
- Atualiza lista de carteiras do Banco do Brasil
- Atualiza lista de carteiras do Itaú
- Documenta Importações
- Documenta o campo
bank_billet_discharges
em Retornos - Remove o campo
bank_billets_with_transactions
em Retornos - Adicionado novo endpoint para Reprocessar CNAB de Retorno.
- Adicionado novo endpoint para Criar boletos em lote.
- Adicionado tabela de Ocorrências disponíveis em cada banco.
- Adicionado tabela com código de instruções de cobrança para Itaú
- Inclui
first_instruction
,second_instruction
,sue_code
erevoke_code
nos Boletos
- Adicionado novos parâmetros ao endpoint para filtrar Boletos.
-
Adicionado novo parâmetro ao endpoint para criação de Carnês: tags.
-
Adicionado novo parâmetro ao endpoint para criação de Assinaturas: tags.
- Adicionado modelo de dados para Tipos de documentos
-
Adicionado endpoint de listar Registro de Remessas pendentes ou não pendentes
-
Adicionado endpoint de listar apenas Registro de Remessas pendentes
-
Adicionado endpoint para criar Registro de Remessas a partir do código de operação banco
-
Adicionado novos parâmetros ao endpoint de filtro de Boletos por
status
: Filtro por período de vencimento a partir deexpire_from
e até data de vencimentoexpire_to
-
Adicionado novos parâmetros ao endpoint de filtro de Boletos por
cnpj_cpf
: Filtro por período de vencimento a partir deexpire_from
e até data de vencimentoexpire_to
-
Adicionado novo endpoint de cancelamento coletivo de Boletos:
- Adicionado endpoint de alteração de Carteiras de cobrança para padrão ou deixar de ser padrão
-
Adicionado novos parâmetros ao endpoint de criação de Carnês:
-
Novos campos para Desconto
-
Adicionado novos parâmetros ao endpoint de criação e alteração de Assinaturas:
-
Novos campos para Desconto
-
Adicionado novos parâmetros ao endpoint de criação e alteração de Assinaturas:
-
Novos campos para Multa
-
Novos campos para Juros
-
Adicionado novos parâmetros ao endpoint de criação de Carnes:
-
Novos campos para Multa
-
Novos campos para Juros
- Adicionado novos parâmetros ao endpoint de alteração de Boletos
- Adicionado endpoint de alteração de Boletos
-
Inclui
notes
nos Carnês -
Inclui
notes
nas Assinaturas
- Documentando endpoint para RAW da Remessa
- Inclui
nickname
nos Clientes
- Adicionado endpoint de pagamento aos Boletos
- Inclui eventos
bank_billet_discharge.*
ebank_billet_remittance.*
na página de eventos dos webhooks
- Documenta informações sobre retentativas de entrega de Webhooks
-
Documenta eventos de carnês
-
Inclusão de valor padrão para o campo
cycle
em Assinaturas e Carnês
-
Documenta o campo
default
em Carteira de Cobrança -
Adicionado novo scope para retornar url de checkout
-
Adicionado novo scope para subscription
- Incluída informação sobre a limpeza do ambiente de sandbox
- Adicionando novos endpoints aos Boletos
-
Revisão e atualização dos modelos de dados dos endpoints da API
-
Revisão das Carteiras
-
Inclui endpoint de busca por CPF ou CNPJ nos clientes
-
Inclui endpoint de busca por E-mail nos clientes
- Adiciona
bank_billet_layout_id
aos Boletos
-
Adiciona
fine_for_delay
elate_payment_interest
aos Carnês -
Adiciona
fine_for_delay
elate_payment_interest
às Assinaturas
- Adiciona
bank_billet_ids
a Remessa.
- Melhora a explicação de como o limite de requisições é calculado e aumenta o limite por segundo de 1 para 5 requisições.
- Retira a obrigatoriedade do campo
bank_billet_account_id
e documenta a existência da carteira de cobrança padrão.
-
Melhora a explicação sobre status da carteira de cobrança.
-
Inclui aviso na página de eventos dos webhooks de que os eventos
bank_billet_account.homologated
ebank_billet_account.validated
serão renomeados em breve parabank_billet_account.homologation_started
ebank_billet_account.validation_released
respectivamente.
- Inclui endpoint de Carnês
- Corrige campos
amount
,cycle
edays_in_advance
da assinatura
- Corrige endpoint de geração da próxima cobrança da assinatura
- Inclui endpoint de Assinaturas
- Novo endpoint para gerar segunda via de boletos
-
Inclui 'status' nas informações retornadas nas carteiras de cobrança
-
Novo endpoint para homologar carteiras de cobrança
- Padronizando CEP
-
Atualiza as informações retornadas nas carteiras (
BankBilletAccount
) -
Inclui dicionário de dados de CNAB Retorno
-
Atualiza status faltando no dicionário de dados de CNAB Remessa
-
Inclui informações de payload dos webhooks de usuário, CNAB Remessa e CNAB Retorno
-
Atualização dos campos obrigatórios dos boletos
-
Atualização dos campos obrigatórios dos clientes
-
Revisão de todos os códigos de exemplo
- Tabela com lista atual de retornos e remessas disponíveis
-
Atualizada lista de carteiras do Itaú
-
Atualizada lista de carteiras do Bradesco
-
Atualizada lista de carteiras do Banco do Brasil
- Atualizada lista de carteiras do Santander
-
Atualiza informações de convênio de remessa
-
Atualiza lista de atributos opcionais do boleto
- Atualiza lista de carteiras da Caixa
- Adicionado carteiras do Banestes
- Adicionado endpoint destroy na remessa
- Adicionado campo URL do arquivo de remessa
- Adicionado campo extra3 para uso em remessas
-
Adicionado eventos de remessa
-
Adicionado eventos de retorno
-
Adicionado ID da carteira a documentação de boletos
-
Adicionado exemplos a API de Parceiros
-
Renomeado endpoint de CNAB de Retorno
-
Adicionado endpoint de CNAB de Remessa
-
Adicionado endpoint
pay_off
na API de CNAB -
Correção exemplo de cancelamento de boleto
-
Adicionado novo scopo
balance
-
Inclusão de account_level na resposta sobre usuários
-
Adicionado API de CNAB (Retorno)
-
Adicionado endpoints(novo saque, solicitar saque, informações do saque e listagem de saques) na API de transações
-
Adicionado novos eventos de webhooks
-
Inclusão de carteiras de cobrança.
-
Correções nos exemplos em Bash do endpoint de Clientes
-
Adicionado opção de usar PUT para cancelar Boletos
- As notificações antigas ficaram obsoletas e não devem ser mais utilizadas. Para receber notificações sobre os eventos que ocorrem no sistema é necessário usar os Webhooks.
- O código do status (
BankBillet#status
) de um boleto vencido mudou dedue
paraoverdue
.