Skip to main content
GET
Get boleto by ID

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

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.

Parámetros de ruta

id
string<uuid>
requerido

Boleto identifier (UUID).

Ejemplo:

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

Respuesta

OK

amount
string
requerido
cancelable
boolean
requerido

Whether cancelling this boleto would effect a cancellation at the provider. Always present. Derived from the boleto's state, not from any request field: true only for a CREATED boleto that carries a providerId. An already-canceled boleto reads false even though POST /v1/boletos/{id}/cancel answers it 200 as an idempotent replay.

createdAt
string
requerido
dueDate
string
requerido
id
string
requerido
kind
string
requerido
payer
object
requerido
status
string
requerido
type
string
requerido
updatedAt
string
requerido
barcode
string
canceledAt
string
cancellationReason
string
digitableLine
string
discount
object
errorMessage
string
failedAt
string
fine
object
guarantor
object
inactivatedAt
string
installmentLabel
string
instructions
string
interest
object
midazOperationId
string
providerId
string
qrCode
string
seriesId
string
settledAmount
string
settledAt
string