Documentação para Desenvolvedores

Changelog

Código fonte da documentação

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.

Receba as atualizações por e-mail

Você também pode se inscrever para receber as notificações de alterações da API por e-mail.

Últimas alterações realizadas na API.

20/09/2017

  • Adicionado novos parâmetros ao endpoint de alteração de Boletos

09/08/2017

  • Adicionado endpoint de alteração de Boletos

31/05/2017

24/05/2017

  • Documentando endpoint para RAW da Remessa

23/05/2017

22/05/2017

  • Adicionado endpoint de pagamento aos Boletos

18/05/2017

  • Inclui eventos bank_billet_discharge.* e bank_billet_remittance.* na página de eventos dos webhooks

17/04/2017

  • Documenta informações sobre retentativas de entrega de Webhooks
  • Documenta o campo bank_billets_with_transactions em Retornos

17/02/2017

08/02/2017

06/02/2017

19/01/2017

  • Adicionando novos endpoints aos Boletos

13/01/2017

  • Atualizando modelo de dados dos Boletos

  • Adicionado opções amount e with_fines ao Boletos

26/12/2016

  • Revisão e atualização dos modelos de dados dos endpoints da API
  • Revisão das Carteiras

19/11/2016

  • Inclui endpoint de busca por CPF ou CNPJ nos clientes
  • Inclui endpoint de busca por E-mail nos clientes

31/10/2016

  • Adiciona bank_billet_layout_id aos Boletos

28/10/2016

  • Adiciona fine_for_delay e late_payment_interest aos Carnês
  • Adiciona fine_for_delay e late_payment_interest às Assinaturas

24/10/2016

  • Adiciona bank_billet_ids a Remessa.

12/10/2016

  • Melhora a explicação de como o limite de requisições é calculado e aumenta o limite por segundo de 1 para 5 requisições.

14/09/2016

  • Retira a obrigatoriedade do campo bank_billet_account_id e documenta a existência da carteira de cobrança padrão.

29/08/2016

  • 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 e bank_billet_account.validated serão renomeados em breve para bank_billet_account.homologation_started e bank_billet_account.validation_released respectivamente.

15/08/2016

10/08/2016

  • Corrige campos amount, cycle e days_in_advance da assinatura

20/05/2016

18/05/2016

06/05/2016

04/05/2016

03/05/2016

  • Inclui ‘status’ nas informações retornadas nas carteiras de cobrança
  • Novo endpoint para homologar carteiras de cobrança

24/02/2016

  • Padronizando CEP

24/12/2015

  • 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

09/12/2015

  • 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

28/10/2015

  • Tabela com lista atual de retornos e remessas disponíveis

22/10/2015

  • Atualizada lista de carteiras do Itaú
  • Atualizada lista de carteiras do Bradesco
  • Atualizada lista de carteiras do Banco do Brasil

09/10/2015

  • Atualizada lista de carteiras do Santander

06/10/2015

  • Atualiza informações de convênio de remessa
  • Atualiza lista de atributos opcionais do boleto

30/09/2015

  • Atualiza lista de carteiras da Caixa

14/09/2015

  • Adicionado carteiras do Banestes

27/08/2015

  • Adicionado endpoint destroy na remessa

24/08/2015

  • Adicionado campo URL do arquivo de remessa

10/08/2015

  • Adicionado campo extra3 para uso em remessas

23/06/2015

  • Adicionado eventos de remessa
  • Adicionado eventos de retorno

18/06/2015

  • Adicionado ID da carteira a documentação de boletos
  • Adicionado exemplos a API de Parceiros

12/06/2015

  • Renomeado endpoint de CNAB de Retorno
  • Adicionado endpoint de CNAB de Remessa

11/06/2015

  • Adicionado endpoint pay_off na API de CNAB
  • Correção exemplo de cancelamento de boleto

17/04/2015

  • 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

31/03/2015

  • 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

08/03/2015

  • 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.

16/02/2015

  • O código do status (BankBillet#status) de um boleto vencido mudou de due para overdue.