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

Midaz organization the boleto to cancel belongs to. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. A boleto of another organization is answered 404, exactly as one that does not exist.

Idempotency-Key
string
required

Client-supplied idempotency key, a UUID. Required: a request without it, or with a value that is not a UUID, 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
ledgerId
string
required

Midaz ledger the boleto was written with. Always present.

organizationId
string
required

Midaz organization the boleto was written with. Always present.

providerId
string
required
status
string
required