> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Check boleto

> Check a boleto barcode or line code



## OpenAPI

````yaml v2/api-reference/openapi.json POST /v2/out/boleto/check
openapi: 3.0.0
info:
  title: Trio API v2
  version: 2026-10-19.v2
servers:
  - url: https://api.sandbox.trio.com.br
    variables: {}
  - url: https://api.qa.trio.com.br
    variables: {}
  - url: https://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /v2/out/boleto/check:
    parameters:
      - description: >-
          Version of the v2 contract the client is written against. Each
          breaking change publishes a new version.
        example: 2026-10-19.v2
        in: header
        name: Trio-Version
        required: true
        schema:
          enum:
            - 2026-10-19.v2
          type: string
          x-struct: null
          x-validate: null
      - description: >-
          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.
        in: header
        name: Trio-Target-Org-Id
        required: false
        schema:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
    post:
      tags:
        - Payments (out)
        - Boleto
      summary: Check boleto
      description: Check a boleto barcode or line code
      operationId: TrioFoundationWeb.V2.Out.BoletoController.check
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Check_boleto_request_params'
        description: Check boleto payload
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_Check_Boleto_Response'
          description: Check
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Malformed request: a body that is not valid JSON
            (MALFORMED_REQUEST), or a Trio-Version header that is missing or not
            the current one (INVALID_TRIO_VERSION).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: Missing or invalid API key credentials (INVALID_CREDENTIALS).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            The API key may not do this (FORBIDDEN): for instance
            Trio-Target-Org-Id names an org it has no access to, or writes
            through a read-only access.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of
            the rule the request breaks). A request outside the operation's
            schema lists the offending fields in `errors`.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            A service needed to answer is unavailable
            (TRIO_SERVICE_UNAVAILABLE).
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    Check_boleto_request_params:
      description: Check boleto request params
      example:
        code: '81620000001482115872026022712600000000001207'
      properties:
        code:
          description: Boleto barcode or digitable_line
          type: string
          x-struct: null
          x-validate: null
      required:
        - code
      title: Check_boleto_request_params
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V1.Cashout.Boleto.BoletoSchema.CheckRequest
      x-validate: null
    V2_Check_Boleto_Response:
      description: A boleto checked before it is paid
      example:
        data:
          amount:
            amount: 100
            currency: BRL
          barcode: '63394124500000777770001112265643601771960649'
          counterparty:
            name: ACME LTDA
            tax_number: '11222333000181'
          digitable_line: '63390001161226564360601640626576412451771960649'
          id: 019c9115-c950-a3bf-1052-5cb80f0d1a77
          inserted_at: '2026-02-24T19:17:30.066277Z'
          original_amount:
            amount: 100
            currency: BRL
          payer:
            name: John Doe
            tax_number: '***982247**'
          payment_limit_date: '2026-03-11'
          type: boleto
          updated_at: '2026-02-24T19:17:30.066277Z'
      properties:
        data:
          properties:
            amount:
              description: Amount due (valor total), after any discount, interest and fine
              properties:
                amount:
                  description: Amount in cents
                  type: integer
                  x-struct: null
                  x-validate: null
                currency:
                  description: Currency
                  type: string
                  x-struct: null
                  x-validate: null
              type: object
              x-struct: null
              x-validate: null
            barcode:
              description: Barcode
              type: string
              x-struct: null
              x-validate: null
            counterparty:
              description: Beneficiary that receives the payment
              properties:
                name:
                  description: Name
                  nullable: true
                  type: string
                  x-struct: null
                  x-validate: null
                tax_number:
                  description: >-
                    Tax number. A CPF is masked (e.g. ***982247**); a CNPJ is
                    published as is
                  nullable: true
                  type: string
                  x-struct: null
                  x-validate: null
              type: object
              x-struct: null
              x-validate: null
            digitable_line:
              description: Digitable line
              type: string
              x-struct: null
              x-validate: null
            id:
              description: Check ID
              format: uuid
              type: string
              x-struct: null
              x-validate: null
            inserted_at:
              description: When the check was made
              format: date-time
              type: string
              x-struct: null
              x-validate: null
            original_amount:
              description: Face value of the boleto (valor nominal)
              nullable: true
              properties:
                amount:
                  description: Amount in cents
                  type: integer
                  x-struct: null
                  x-validate: null
                currency:
                  description: Currency
                  type: string
                  x-struct: null
                  x-validate: null
              type: object
              x-struct: null
              x-validate: null
            payer:
              description: Payer the boleto was issued to
              properties:
                name:
                  description: Name
                  nullable: true
                  type: string
                  x-struct: null
                  x-validate: null
                tax_number:
                  description: >-
                    Tax number. A CPF is masked (e.g. ***982247**); a CNPJ is
                    published as is
                  nullable: true
                  type: string
                  x-struct: null
                  x-validate: null
              type: object
              x-struct: null
              x-validate: null
            payment_limit_date:
              description: Last day the boleto can be paid
              format: date
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            type:
              description: Barcode type
              type: string
              x-struct: null
              x-validate: null
            updated_at:
              description: When the check was last updated
              format: date-time
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
      title: V2 Check_Boleto_Response
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Boleto.BoletoSchema.CheckResponse
      x-validate: null
    V2_error:
      example:
        error:
          error_code: INVALID_PARAMETER
          error_message: 'Invalid parameters: /amount: Invalid integer. Got: string'
          errors:
            - field: /amount
              message: 'Invalid integer. Got: string'
      properties:
        error:
          properties:
            error_code:
              description: >-
                Stable UPPER_SNAKE identifier of the error, for programs and
                logs. Branch on this, not on the message.
              type: string
              x-struct: null
              x-validate: null
            error_message:
              description: Human readable explanation of the error.
              type: string
              x-struct: null
              x-validate: null
            errors:
              description: >-
                Only on INVALID_PARAMETER for a request outside the operation's
                schema: one entry per offending field.
              items:
                properties:
                  field:
                    description: JSON pointer to the field, e.g. /amount.
                    type: string
                    x-struct: null
                    x-validate: null
                  message:
                    description: What is wrong with it.
                    type: string
                    x-struct: null
                    x-validate: null
                required:
                  - field
                  - message
                type: object
                x-struct: null
                x-validate: null
              type: array
              x-struct: null
              x-validate: null
          required:
            - error_code
            - error_message
          type: object
          x-struct: null
          x-validate: null
      required:
        - error
      title: V2 error
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.