Get boleto payment status
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Accepts either the canonical boleto id (bol_<uuid> — the same
value returned by POST /boleto/pay and sent as transactionId in
webhooks) or the partner reference (operationReferenceId,
legacy). Prefer the canonical id.
Headers
Response
Payment status. Served live from the partner; when the partner
reference is not yet available (boleto just requested), the last
known local status is returned with a note and X-Source: local.
Canonical boleto id (bol_ + UUID). Present when resolvable.
Deprecated alias of paymentId (same value).
Partner-side reference (operationReferenceId).
Instant of the status at the partner, in Brasília time
(offset -03:00). Present only when the partner sent a
real clock time — a date-only PaymentDate is omitted
here (it used to become 21:00 of the previous day).
Civil payment date at the settlement bank (YYYY-MM-DD).
May be the next business day when the request falls
after the partner’s cutoff, on a weekend, or on a holiday.
Present only in the local-fallback case (partner reference not yet available).