Skip to main content
POST
Cancel an issued boleto

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

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.

Path Parameters

id
string<uuid>
required

Boleto identifier (UUID).

Example:

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

Body

application/json
reason
string
required

Response

OK

canceledAt
string
required
cancellationReason
string
required
id
string
required
providerId
string
required
status
string
required