API Reference
Log In
API Reference

Cancelar boleto

Endpoint responsável por realizar o cancelamento do boleto emitido

Log in to see full request history

Resposta da requisição

VariávelTipoDescrição
idstringId de identificação do boleto.
valueTotalLongValor total do boleto.
valuePayLongValor pago.
valueRefundedLongValor recusado.
barCodestringCódigo de barras.
dueDatestringData de vencimento.
externalReferencestringReferência externa de parceria.
statusstringStatus do boleto. Ex.: PENDING, PAID, CANCELED, ERROR, GENERATED, WAITING.
descriptionstringDescrição do boleto.
urlstringUrl com o pdf do boleto.
createdAtstringData de criação do boleto.
detailsObjectDetalhes do boleto gerado.
Path Params
string
required

Identificador único do boleto a ser cancelado.

Headers
string
required

Token único gerado para o estabelecimento no momento de onboarding.

string
required

Autenticação do tipo Bearer a ser enviada. O atributo {access_token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento.

string
Defaults to ID que identifica o integrador e é repassado pelo técnico responsável por sua integração
Responses

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