Skip to main content
POST
Cancel an issued boleto

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Organization-Id
string

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Idempotency-Key
string

Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012.

Parâmetros de caminho

id
string<uuid>
obrigatório

Boleto identifier (UUID).

Exemplo:

"123e4567-e89b-12d3-a456-426614174000"

Corpo

application/json
reason
string
obrigatório

Resposta

OK

canceledAt
string
obrigatório
cancellationReason
string
obrigatório
id
string
obrigatório
providerId
string
obrigatório
status
string
obrigatório