Skip to main content
POST
Check a brcode hash

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Body

application/json

Check brcode payload

Body params to check a Pix brcode (QR code) before paying it

entity_id
string<uuid>
required

Entity that will pay the Pix

hash
string
required

Pix copy and paste code of the brcode

Response

Check

A Pix brcode checked before it is paid. amount_editable, expires_at and due_date come from the brcode payload: they are null for a static brcode without them and for a check fetched by ID.

data
object
required