> ## 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. # List Payments > List all out documents ## OpenAPI ````yaml v2/api-reference/openapi.json GET /v2/documents/out 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: 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 summary: List all out documents description: List all out documents operationId: TrioFoundationWeb.V2.Documents.OutController.index parameters: - description: Bank account ID in: query name: bank_account_id required: false schema: $ref: '#/components/schemas/UUID' - description: From datetime in: query name: from_datetime required: true schema: $ref: '#/components/schemas/DATETIME' - description: To datetime in: query name: to_datetime required: true schema: $ref: '#/components/schemas/DATETIME' - description: >- Counterparty tax number (CPF/CNPJ). Filters to documents whose counterparty has this tax number. in: query name: tax_number required: false schema: type: string x-struct: null x-validate: null - description: Reconciliation ID in: query name: reconciliation_id required: false schema: $ref: '#/components/schemas/UUID' - description: How the document was initiated, as `reference.type` renders it in: query name: ref_type required: false schema: $ref: '#/components/schemas/V2_out_document_ref_type' - description: Out document status in: query name: status required: false schema: $ref: '#/components/schemas/V2_out_document_status' - description: Out document type in: query name: type required: false schema: $ref: '#/components/schemas/V2_out_document_type' - description: >- Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page. example: >- g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ== in: query name: before required: false schema: type: string x-struct: null x-validate: null - description: >- Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page. example: >- g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ== in: query name: after required: false schema: type: string x-struct: null x-validate: null responses: '200': content: application/json: schema: $ref: '#/components/schemas/V2_list_of_out_documents' description: Documents '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: UUID: description: Unique identifier format: uuid title: UUID type: string x-struct: null x-validate: null DATETIME: description: Datetime schema format: date-time title: DATETIME type: string x-struct: null x-validate: null V2_out_document_ref_type: description: How the out document was initiated enum: - boleto - initiation_document - manual - pix_automatic - pix_key - pix_payment_qrcode - pix_qrcode - pix_static_qrcode title: V2 out document ref type type: string x-struct: null x-validate: null V2_out_document_status: description: Out document status enum: - created - confirmed - settled - onhold - refunded - reversed - failed title: V2 out document status type: string x-struct: null x-validate: null V2_out_document_type: description: Out document type enum: - pix - boleto - ted - tef - utility - tax - internal - card - pix_internal - pix_automatic - pix_initiation - receivable - pix_boleto title: V2 out document type type: string x-struct: null x-validate: null V2_list_of_out_documents: description: List of out documents 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: . end_to_end_id: E49931906202610091423uRPkCyeusfB external_id: Pix Console 01a1210c-076e-daf3-8d7b-8000a8e5c6fc id: 01a1210c-4914-9972-f8a2-14b30f6b60f6 inserted_at: '2026-10-09T14:23:35.700406Z' origin: id: d4abaabe-5ebf-4628-ba34-5a1b17da4c6b type: console_user receipt_url: >- https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/out/01a1210c-4914-9972-f8a2-14b30f6b60f6 reconciliation_id: 01a1210c-4a23-4df0-d68f-3f8239adc2a1 reference: id: null type: pix_key refunds: [] stages: - error_code: null error_message: null id: 01a1210c-4914-db7b-7700-4617d96022f7 inserted_at: '2026-10-09T14:23:35.700406Z' status: created - error_code: null error_message: null id: 01a1210c-4914-936c-fa61-1bc67deb38e7 inserted_at: '2026-10-09T14:23:35.700406Z' status: settled status: settled transaction_date: '2026-10-09T14:23:37.128000Z' type: pix updated_at: '2026-10-09T14:23:37.128000Z' metadata: after: null before: null has_more: false properties: data: items: $ref: '#/components/schemas/V2_out_document' type: array x-struct: null x-validate: null metadata: description: Pagination cursors properties: after: description: Cursor to the next page nullable: true type: string x-struct: null x-validate: null before: description: Cursor to the previous page nullable: true type: string x-struct: null x-validate: null has_more: description: Whether a next page exists type: boolean x-struct: null x-validate: null type: object x-struct: null x-validate: null title: V2 list of out documents type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Document.ListResponse 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: description: >- Out document, as returned by the listing, show and search. `bank_account_id` is the account that paid it; the counterparty carries the bank account it was paid to as `bank_account_id`. 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: . end_to_end_id: E49931906202610091423uRPkCyeusfB external_id: Pix Console 01a1210c-076e-daf3-8d7b-8000a8e5c6fc id: 01a1210c-4914-9972-f8a2-14b30f6b60f6 inserted_at: '2026-10-09T14:23:35.700406Z' origin: id: d4abaabe-5ebf-4628-ba34-5a1b17da4c6b type: console_user receipt_url: >- https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/out/01a1210c-4914-9972-f8a2-14b30f6b60f6 reconciliation_id: 01a1210c-4a23-4df0-d68f-3f8239adc2a1 reference: id: null type: pix_key refunds: [] stages: - error_code: null error_message: null id: 01a1210c-4914-db7b-7700-4617d96022f7 inserted_at: '2026-10-09T14:23:35.700406Z' status: created - error_code: null error_message: null id: 01a1210c-4914-936c-fa61-1bc67deb38e7 inserted_at: '2026-10-09T14:23:35.700406Z' status: settled status: settled transaction_date: '2026-10-09T14:23:37.128000Z' type: pix updated_at: '2026-10-09T14:23:37.128000Z' 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 that received the payment 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: Unique identifier format: uuid type: string x-struct: null x-validate: null inserted_at: description: When the document was created format: date-time type: string x-struct: null x-validate: null origin: description: Who or what originated the document properties: id: description: Origin ID format: uuid nullable: true type: string x-struct: null x-validate: null type: $ref: '#/components/schemas/V2_out_document_origin_type' type: object 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 reference: description: What the document pays, such as a Pix QR code or a Pix key properties: id: description: Reference ID format: uuid nullable: true type: string x-struct: null x-validate: null type: allOf: - $ref: '#/components/schemas/V2_out_document_ref_type' description: >- How the document was initiated; null when trio-spi recorded no initiation nullable: true x-struct: null x-validate: null type: object x-struct: null x-validate: null refunds: description: >- Refunds of the document; empty in the listing, which does not load them items: $ref: '#/components/schemas/V2_refund_within_an_out_document' type: array x-struct: null x-validate: null stages: $ref: '#/components/schemas/V2_list_of_stages_within_an_out_document' status: $ref: '#/components/schemas/V2_out_document_status' transaction_date: description: Transaction date format: date-time type: string x-struct: null x-validate: null type: $ref: '#/components/schemas/V2_out_document_type' updated_at: description: When the document was last updated format: date-time type: string x-struct: null x-validate: null title: V2 out document type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Document.OutDocumentData 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_refund_within_an_out_document: description: >- Refund of the out document, as `GET /v2/documents/out/refunds/{id}` renders it without `out_document_id`. trio-spi embeds it without its origin and stages. 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 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 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 refund within an out document type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Refund.EmbeddedRefundData x-validate: null V2_list_of_stages_within_an_out_document: description: List of stages within an out document items: $ref: '#/components/schemas/V2_stage_of_an_out_document' title: V2 list of stages within an out document type: array x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Document.StageListResponse 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_stage_of_an_out_document: description: Stage of an out document example: error_code: null error_message: null id: 01a1210c-4914-936c-fa61-1bc67deb38e7 inserted_at: '2026-10-09T14:23:35.700406Z' status: settled properties: error_code: description: Error code when the stage represents an error nullable: true type: string x-struct: null x-validate: null error_message: description: Error message detail when the stage represents an error nullable: true type: string x-struct: null x-validate: null id: description: 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: description: Status the document reached at this stage enum: - created - confirmed - settled - failed - refund_link - onhold type: string x-struct: null x-validate: null title: V2 stage of an out document type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Document.StageResponse 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.