Skip to main content
GET
Get boleto by ID

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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 caminho

id
string<uuid>
obrigatório

Boleto identifier (UUID).

Exemplo:

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

Resposta

OK

amount
string
obrigatório
cancelable
boolean
obrigatório

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
obrigatório
dueDate
string
obrigatório
id
string
obrigatório
kind
string
obrigatório
payer
object
obrigatório
status
string
obrigatório
type
string
obrigatório
updatedAt
string
obrigatório
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