Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Boletos

Cancelar Boletos em Lote

Cancelar boletos em lote

post/v1/bank_billets/cancel_all

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Request body

status'generating' | 'draft' | 'generation_failed' | 'validation_failed' | 'opened' | 'canceled' | 'paid' | 'overdue' | 'blocked' | 'chargeback'

Situação do boleto:

  • generating Gerando
  • draft Rascunho
  • generation_failed Falha ao gerar
  • opened Aberto
  • canceled Cancelado
  • paid Pago
  • overdue Vencido
  • validation_failed Inválido
  • chargeback Estornado
expire_fromstring date

A partir de Data de vencimento

expire_tostring date

Até a Data de vencimento

cnpj_cpfstring

CNPJ ou CPF do Pagador

bank_billet_idsinteger[] nullable

IDs de boletos a serem cancelados

Example request

{
  "expire_from": "2023-12-12",
  "expire_to": "2023-12-12",
  "cnpj_cpf": "16.974.923/0001-84"
}

Response

Solicitação realizada com sucesso