> ## 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.

# Search Payment Refunds

> Search out document refund by IDs



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/documents/out/refunds/search
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/documents/out/refunds/search:
    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
    get:
      tags:
        - Documents
        - Out
        - Refunds
      summary: Search out document refund
      description: Search out document refund by IDs
      operationId: TrioFoundationWeb.V2.Documents.Out.RefundController.search
      parameters:
        - description: End To End ID
          in: query
          name: end_to_end_id
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: External ID
          in: query
          name: external_id
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: From datetime
          in: query
          name: from_datetime
          required: false
          schema:
            $ref: '#/components/schemas/DATETIME'
        - description: To datetime
          in: query
          name: to_datetime
          required: false
          schema:
            $ref: '#/components/schemas/DATETIME'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_out_document_refund_response'
          description: Refund
        '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:
    DATETIME:
      description: Datetime schema
      format: date-time
      title: DATETIME
      type: string
      x-struct: null
      x-validate: null
    V2_out_document_refund_response:
      description: Out document refund response
      example:
        data:
          amount:
            amount: 1
            currency: BRL
          bank_account_id: 019ddfe9-e64b-b642-36fd-efdaef77d05e
          counterparty:
            bank_account_id: 0008d49c-e6d5-a58e-a742-449e9b38f795
            id: 0008d49c-e6d5-4d86-232a-a6f4b9138f10
            name: John Doe
            tax_number: '***982247**'
          description: md06
          end_to_end_id: D60746948202610091618a4900N5mYsE
          external_id: Pix Console 01a1210c-076e-daf3-8d7b-8000a8e5c6fc
          id: 01a12175-3994-6649-4e0b-f645e45459ea
          inserted_at: '2026-10-09T16:18:13.012356Z'
          origin:
            id: d4abaabe-5ebf-4628-ba34-5a1b17da4c6b
            type: console_user
          out_document_id: 01a1210c-4914-9972-f8a2-14b30f6b60f6
          receipt_url: >-
            https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/out_refund/01a12175-3994-6649-4e0b-f645e45459ea
          reconciliation_id: 01a12175-3994-450a-4ff2-129a15a79b0b
          stages:
            - error_code: null
              error_message: null
              id: 01a12175-3994-1769-f302-ff90c917b627
              inserted_at: '2026-10-09T16:18:13.020169Z'
              status: created
            - error_code: null
              error_message: null
              id: 01a12175-3994-c354-a724-745e098967f5
              inserted_at: '2026-10-09T16:18:14.231252Z'
              status: settled
          status: settled
          transaction_date: '2026-10-09T16:18:13.361000Z'
          updated_at: '2026-10-09T16:18:14.231252Z'
      properties:
        data:
          $ref: '#/components/schemas/V2_out_document_refund'
      title: V2 out document refund response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Refund.Response
      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
    V2_out_document_refund:
      description: >-
        Out document refund, as returned by the listing, show and search.
        `bank_account_id` is the account that received the refund; the
        counterparty is the one of the refunded out document.
      example:
        amount:
          amount: 1
          currency: BRL
        bank_account_id: 019ddfe9-e64b-b642-36fd-efdaef77d05e
        counterparty:
          bank_account_id: 0008d49c-e6d5-a58e-a742-449e9b38f795
          id: 0008d49c-e6d5-4d86-232a-a6f4b9138f10
          name: John Doe
          tax_number: '***982247**'
        description: md06
        end_to_end_id: D60746948202610091618a4900N5mYsE
        external_id: Pix Console 01a1210c-076e-daf3-8d7b-8000a8e5c6fc
        id: 01a12175-3994-6649-4e0b-f645e45459ea
        inserted_at: '2026-10-09T16:18:13.012356Z'
        origin:
          id: d4abaabe-5ebf-4628-ba34-5a1b17da4c6b
          type: console_user
        out_document_id: 01a1210c-4914-9972-f8a2-14b30f6b60f6
        receipt_url: >-
          https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/out_refund/01a12175-3994-6649-4e0b-f645e45459ea
        reconciliation_id: 01a12175-3994-450a-4ff2-129a15a79b0b
        stages:
          - error_code: null
            error_message: null
            id: 01a12175-3994-1769-f302-ff90c917b627
            inserted_at: '2026-10-09T16:18:13.020169Z'
            status: created
          - error_code: null
            error_message: null
            id: 01a12175-3994-c354-a724-745e098967f5
            inserted_at: '2026-10-09T16:18:14.231252Z'
            status: settled
        status: settled
        transaction_date: '2026-10-09T16:18:13.361000Z'
        updated_at: '2026-10-09T16:18:14.231252Z'
      properties:
        amount:
          description: Amount
          properties:
            amount:
              description: Amount integer
              minimum: 1
              type: integer
              x-struct: null
              x-validate: null
            currency:
              description: Amount currency string
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        bank_account_id:
          description: Bank account ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        counterparty:
          description: Counterparty of the refunded out document
          properties:
            bank_account_id:
              description: Counterparty bank account ID
              format: uuid
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            id:
              description: Counterparty ID
              format: uuid
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            name:
              description: Counterparty name
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            tax_number:
              description: >-
                Counterparty 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
        description:
          description: Description
          type: string
          x-struct: null
          x-validate: null
        end_to_end_id:
          description: End to end ID
          type: string
          x-struct: null
          x-validate: null
        external_id:
          description: External ID
          type: string
          x-struct: null
          x-validate: null
        id:
          description: Refund document ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: When the refund was created
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        origin:
          description: Who or what originated the refund
          properties:
            id:
              description: Origin ID
              format: uuid
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            type:
              allOf:
                - $ref: '#/components/schemas/V2_out_document_origin_type'
              description: Origin type; null on a refund embedded in its document
              nullable: true
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        out_document_id:
          description: ID of the refunded out document
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        receipt_url:
          description: Receipt URL
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        reconciliation_id:
          description: Reconciliation ID
          format: uuid
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        stages:
          $ref: '#/components/schemas/V2_out_refund_document_stage_list_response'
        status:
          $ref: '#/components/schemas/Refund_document_status'
        transaction_date:
          description: Refund document transaction date
          format: date-time
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        updated_at:
          description: When the refund was last updated
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      title: V2 out document refund
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Refund.RefundOutDocumentData
      x-validate: null
    V2_out_document_origin_type:
      description: Who or what originated the out document
      enum:
        - none
        - api_client
        - console_user
        - billing
        - reconciliation
        - checkout
        - account_holder
        - bridge
      title: V2 out document origin type
      type: string
      x-struct: null
      x-validate: null
    V2_out_refund_document_stage_list_response:
      description: Refund document stage list response
      items:
        $ref: '#/components/schemas/V2_out_refund_document_stage_response'
      title: V2 out refund document stage list response
      type: array
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Refund.StageListResponse
      x-validate: null
    Refund_document_status:
      description: Refund document status
      enum:
        - created
        - confirmed
        - settled
        - onhold
        - refunded
        - reversed
        - failed
      title: Refund document status
      type: string
      x-struct: null
      x-validate: null
    V2_out_refund_document_stage_response:
      description: Refund document stage response
      example:
        error_code: null
        error_message: null
        id: 01a12175-3994-c354-a724-745e098967f5
        inserted_at: '2026-10-09T16:18:14.231252Z'
        status: settled
      properties:
        error_code:
          description: Refund document stage error code when present
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        error_message:
          description: Refund document stage error message when present
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        id:
          description: Refund document stage ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: When the stage was recorded
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        status:
          $ref: '#/components/schemas/Refund_document_status'
      title: V2 out refund document stage response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Refund.StageResponse
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

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