Pular para o conteúdo principal
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

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
obrigatório

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.

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
ledgerId
string
obrigatório

Midaz ledger the boleto was written with. Always present.

organizationId
string
obrigatório

Midaz organization the boleto was written with. Always present.

providerId
string
obrigatório
status
string
obrigatório