Skip to main content
Cancela o registro de um boleto bancário previamente registrado.
Through this endpoint, the partner can cancel the registration of a boleto as long as it has not yet been paid.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Headers

IdempotencyKey
string
required
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

listaCodigos
string<uuid>[] | null

Lista de códigos UUID identificadores dos boletos.

Observação:

  • Quando a 'lista de códigos UUID de identificadores dos boletos' (listaCodigos) for informada, a 'lista de códigos de barras dos boletos' (listaCodigosBarras) não deve ser preenchida.
listaCodigosBarras
string[] | null

Lista de códigos de barras dos boletos.

Observação:

  • Quando a 'lista de códigos de barras dos boletos' (listaCodigosBarras) for informada, a 'lista de códigos UUID de identificadores dos boletos' (listaCodigos) não deve ser preenchida.

Response

Success

sucesso
boolean
mensagem
string | null
listaCodigosCancelamento
object[] | null