API BaaSBoleto

Get boleto payment status

Returns the current status of a boleto payment. If the payment is still processing, the system polls the payment provider for the latest status and updates accordingly.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.
paymentIdstringRequired
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

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

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.

paymentIdstringOptional

Canonical boleto id (bol_ + UUID). Present when resolvable.

boletoIdstringOptional

Deprecated alias of paymentId (same value).

partnerIdstringOptional

Partner-side reference (operationReferenceId).

statusenumOptional
occurredAtdatetimeOptional

Timestamp of the status at the partner, in Brasília time (offset -03:00).

errorMessagestringOptional
notestringOptional

Present only in the local-fallback case (partner reference not yet available).

Errors

404
Not Found Error