Saltar al contenido principal
POST
Cancel an issued boleto

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

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
requerido

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 ruta

id
string<uuid>
requerido

Boleto identifier (UUID).

Ejemplo:

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

Cuerpo

application/json
reason
string
requerido

Respuesta

OK

canceledAt
string
requerido
cancellationReason
string
requerido
id
string
requerido
ledgerId
string
requerido

Midaz ledger the boleto was written with. Always present.

organizationId
string
requerido

Midaz organization the boleto was written with. Always present.

providerId
string
requerido
status
string
requerido