{ "components": { "responses": {}, "schemas": { "V2_Org_webhook_update_parameters": { "description": "The webhook replacing the current one: send every field, as an omitted field is cleared. A url_secret webhook needs notification_url and notification_secret; an oauth webhook needs oauth_client_id, oauth_client_secret, oauth_url and oauth_scope.", "example": { "api_version": "v100", "authentication_method": "url_secret", "entity_id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7c", "event_categories_allowed": [ { "category": "boleto", "types": [ "settled", "created" ] } ], "group_id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7d", "notification_secret": "some_notification_secret", "notification_url": "https://mynotificationurl.com/endpoint" }, "properties": { "api_version": { "description": "Version of the event payloads sent to the webhook. Defaults to v100", "enum": [ "v100", "v200" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "authentication_method": { "description": "How Trio authenticates to the notification URL", "enum": [ "url_secret", "oauth" ], "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "Entity to limit the webhook to. Omitted, the webhook is no longer limited", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "event_categories_allowed": { "description": "Events to send to the webhook. Empty, null or omitted sends every event", "items": { "properties": { "category": { "description": "Event category", "type": "string", "x-struct": null, "x-validate": null }, "types": { "description": "Event types of the category. Empty sends every type", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "category", "types" ], "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "group_id": { "description": "Group of the entity to limit the webhook to. Omitted, the webhook is no longer limited", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "notification_secret": { "description": "Secret sent with every event, for url_secret webhooks", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "notification_url": { "description": "URL the events are sent to", "type": "string", "x-struct": null, "x-validate": null }, "oauth_client_id": { "description": "OAuth client ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "oauth_client_secret": { "description": "OAuth client secret", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "oauth_scope": { "description": "OAuth scope", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "oauth_url": { "description": "OAuth token URL", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "notification_url", "authentication_method" ], "title": "V2 Org webhook update parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.IAM.V2.OrgWebhook.UpdateParameters", "x-validate": null }, "Check_tax_request_params": { "description": "Check tax request params", "example": { "code": "81620000001482115872026022712600000000001207" }, "properties": { "code": { "description": "Tax barcode or digitable_line", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "code" ], "title": "Check_tax_request_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.Cashout.Tax.TaxSchema.CheckRequest", "x-validate": null }, "RecurrenceStatus": { "description": "Types of recurrence status", "enum": [ "created", "approved", "rejected", "expired", "cancelled" ], "title": "RecurrenceStatus", "type": "string", "x-struct": null, "x-validate": null }, "V2_CollectionUpdateParams": { "description": "Body params to update the amount of a collection", "example": { "amount": 10000 }, "properties": { "amount": { "description": "Updated amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "amount" ], "title": "V2 CollectionUpdateParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.UpdateParams", "x-validate": null }, "V2_entity_address": { "description": "Entity address", "example": { "address_additional_details": "Apto 42", "address_line": "Rua das Flores", "address_number": "123", "city_name": "Curitiba", "district": "Centro", "zip_code": "80000000" }, "properties": { "address_additional_details": { "description": "Additional address details, such as the apartment", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line": { "description": "Street", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_number": { "description": "Street number", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city_name": { "description": "City name", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "district": { "description": "District", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "zip_code": { "description": "Zip code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 entity address", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityAddressData", "x-validate": null }, "RecurrenceType": { "description": "Types of recurrence type", "enum": [ "in", "out" ], "title": "RecurrenceType", "type": "string", "x-struct": null, "x-validate": null }, "V2_card_transfer_balance_params": { "description": "Moves balance from the card in the path to `to_card_id`", "example": { "amount": { "amount": 1000, "currency": "BRL" }, "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "to_card_id": "019514eb-5d5c-7c3d-8e2f-0a1b2c3d4e5f" }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_amount_params" }, "entity_id": { "description": "ID of the entity that holds both cards", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "to_card_id": { "description": "ID of the card that receives the balance", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "entity_id", "to_card_id", "amount" ], "title": "V2 card transfer balance params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.TransferBalanceParams", "x-validate": null }, "V2_out_document_response": { "description": "Out document 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": ".", "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": { "data": { "$ref": "#/components/schemas/V2_out_document" } }, "title": "V2 out document response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Document.Response", "x-validate": null }, "V2_created_in_document_refund_response": { "description": "Created in document refund response", "example": { "data": { "in_refund_id": "01a12175-3994-6649-4e0b-f645e45459ea" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_created_in_document_refund" } }, "title": "V2 created in document refund response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.RefundResponse", "x-validate": null }, "V2_list_out_document_refunds_response": { "description": "A list of out document refunds 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" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_out_document_refund" }, "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 out document refunds response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Refund.ListResponse", "x-validate": null }, "V2_list_of_in_documents": { "description": "List of in documents", "example": { "data": [ { "amount": { "amount": 100, "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": "E60746948202610072016A0049Tfmiks", "external_id": "01M4C040NGQ5VKGKZRR3SXRZ7E", "id": "01a11802-3da7-052e-3f8f-19cfe127e4b8", "inserted_at": "2026-10-07T20:16:02.471297Z", "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in/01a11802-3da7-052e-3f8f-19cfe127e4b8", "reconciliation_id": "01a11802-3da7-09df-060e-0ca0747a1876", "reference": { "id": "01a11802-b618-fcd7-94f4-88f533fe41cc", "type": "pix_qrcode" }, "refunds": [], "stages": [ { "error_code": null, "error_message": null, "id": "01a11802-3da7-2381-58a7-54b90a2ffa9a", "inserted_at": "2026-10-07T20:17:02.479108Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11802-3da7-af9b-756c-9522bbd3b87f", "inserted_at": "2026-10-07T20:17:03.475249Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-07T20:17:02.795000Z", "type": "pix", "updated_at": "2026-10-07T20:17:03.475249Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_in_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 in documents", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.ListResponse", "x-validate": null }, "V2_GenerateRecurrenceParameters": { "description": "GenerateRecurrenceParameters", "example": { "amounts": { "minimum": 100 }, "bank_account_id": "019f4198-8913-1ec9-52c6-706c618a1c5d", "contract_number": "123456789", "counterparty": { "bank_account": { "branch": "1234", "digit": "1", "ispb": "12345678", "number": "123456" }, "name": "Payer Name", "tax_number": "12345678000100" }, "description": "Monthly payment for services", "external_id": "external_id_123", "first_payment": { "amount": 100, "dict_key": "pixkey@mail.com", "due_detail": { "discount": { "per_day_antecipated": { "amount": 2, "calculation_days": "working", "calculation_type": "amount" } }, "due_date": "2026-10-30", "fine": { "calculation_type": "percentage", "value": 10 }, "interest": { "amount": 20, "calculation_days": "calendar", "calculation_period": "month", "calculation_type": "amount" }, "rebate": { "calculation_type": "percentage", "value": 50 } } }, "options": { "authorization_type": "app", "automated_attempt_retry": false, "automatic_schedule": false, "next_working_day": true, "qrcode_expiration_seconds": 86400, "retry_policy": "3r_7d" }, "periodicity": "mnth", "start_date": "2026-10-25" }, "properties": { "amounts": { "description": "Recurrence Amount, use fixed for fixed amount recurences. For variable amount recurrences, a minimum can be defined. If defined, the counterparty cannot define a limit lower than the minimum. Variable amount recurrences need to be updated with the amount before each collecting date. If left blank, a variable amount recurrence will be created with no minimum", "nullable": true, "properties": { "fixed": { "description": "Fixed Amount in cents, used for fixed amount recurrences", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum Amount in cents, used for variable amount recurrences", "nullable": true, "type": "integer", "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 }, "contract_number": { "description": "Contract Number", "maxLength": 35, "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Counterparty", "properties": { "bank_account": { "description": "Counterparty Bank Account, required for authorization type 'app', this is the bank account that will receive the request to approve the recurrence", "nullable": true, "properties": { "branch": { "description": "Counterparty Bank Account Branch", "pattern": "^[0-9]+$", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Counterparty Bank Account Digit", "pattern": "^[0-9]$", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "Counterparty Bank Account ISPB", "pattern": "^[0-9]{8}$", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Counterparty Bank Account Number", "pattern": "^[0-9]+$", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "ispb", "number", "branch", "digit" ], "type": "object", "x-struct": null, "x-validate": null }, "info": { "description": "Counterparty Info", "nullable": true, "properties": { "address": { "description": "Counterparty Address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "Counterparty City", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "email": { "description": "Counterparty Email", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Counterparty Postal Code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "state": { "description": "Counterparty State", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "name": { "description": "Counterparty Name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Counterparty Tax Number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "name" ], "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "maxLength": 35, "type": "string", "x-struct": null, "x-validate": null }, "end_date": { "description": "Last day of the recurrence", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "Recurrence External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "first_payment": { "$ref": "#/components/schemas/V2_FirstPaymentWithDueDetail" }, "options": { "description": "Recurrence options", "nullable": true, "properties": { "authorization_type": { "default": "qrcode", "description": "Authorization type of the recurrence. Use 'qrcode' for requesting directly to the counterparty banking app or 'qrcode' for generating a QRCode", "enum": [ "app", "qrcode" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "automated_attempt_retry": { "default": true, "description": "Automated Attempt Retry. If not set, all the attempts retries should be scheduled each time after the previous one is not settled. i.e. if the attempt is not settled, the next attempt needs to be rescheduled. If the parameter is true, it will be done automatically", "nullable": true, "type": "boolean", "x-struct": null, "x-validate": null }, "automatic_schedule": { "default": true, "description": "Automated Collecting on the defined periodicity. If not set, the recurrence must be scheduled each time. i.e. if periodicity is 'mnth', the recurrence needs to be scheduled each month, between 2 and 10 days before the next payment date", "nullable": true, "type": "boolean", "x-struct": null, "x-validate": null }, "next_working_day": { "default": false, "description": "Do not bill on Holidays, bill on the counterparty's next working day", "nullable": true, "type": "boolean", "x-struct": null, "x-validate": null }, "qrcode_expiration_seconds": { "default": 86400, "description": "Expiration time in seconds for the dynamic QR code. If the generated QR code is static, this field is disconsidered as the static QR code does not expire.", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "retry_policy": { "default": "3r_7d", "description": "Recurrence retry policy. '3r_7d': if the collecting fails, it will be retried 3 times in a 7 days period, on alternating days. 'none': no retry", "enum": [ "none", "3r_7d" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "periodicity": { "description": "'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year", "enum": [ "week", "mnth", "qurt", "mian", "year" ], "type": "string", "x-struct": null, "x-validate": null }, "start_date": { "description": "First day of the recurrence", "format": "date", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "bank_account_id", "counterparty", "description", "periodicity", "contract_number", "start_date" ], "title": "V2 GenerateRecurrenceParameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.GenerateRecurrenceParams", "x-validate": null }, "V2_in_document_refund_response": { "description": "In 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": "Devolução manual", "end_to_end_id": "D49931906202610081927B4HdgiWHdjH", "external_id": null, "id": "01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "in_document_id": "01a117fc-bb66-88e2-942b-0ce8cd702c5c", "inserted_at": "2026-10-08T19:27:19.400000Z", "med": false, "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in_refund/01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "reconciliation_id": "01a11cfb-fc1a-e185-85ce-75c67ff0ad87", "stages": [ { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-9ee4-7389-d989b8d525ff", "inserted_at": "2026-10-08T19:27:19.400000Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-91ab-04df-8d348772400b", "inserted_at": "2026-10-08T19:27:19.600000Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-08T19:27:19.524000Z", "updated_at": "2026-10-08T19:27:19.600000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_in_document_refund" } }, "title": "V2 in document refund response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Refund.Response", "x-validate": null }, "V2_Pix_Key_single_response": { "description": "Pix Key response", "example": { "data": { "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2020-01-10T10:00:00Z", "key": "12345678900", "status": "created", "tax_number": "12345678900", "type": "tax_number", "updated_at": "2020-01-10T10:00:00Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_Pix_Key_response" } }, "title": "V2 Pix Key single response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.Response", "x-validate": null }, "Counterparty_recipient_data": { "description": "Body response of the counterparty recipient", "example": { "bank_account": null, "counterparty": { "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "name": "Random", "tax_number": "34842155000197" }, "id": "1fb05245-a185-0ec1-2661-3390353a35e3", "pix_key": "some-pix-key", "ref_type": "pix_key" }, "properties": { "bank_account": { "$ref": "#/components/schemas/Counterparty_recipient_bank_account_data" }, "counterparty": { "$ref": "#/components/schemas/Counterparty_recipient_counterparty_data" }, "id": { "$ref": "#/components/schemas/UUID" }, "pix_key": { "description": "Pix key", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "ref_type": { "description": "How the recipient is referenced", "enum": [ "pix_key", "bank_account_detailed" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "Counterparty recipient data", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.RecipientData", "x-validate": null }, "V2_card_purchase_response": { "description": "A card purchase with its stages", "example": { "data": { "amount": { "amount": 10000, "currency": "BRL" }, "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-e630-609a-18a0447ee30b", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchased_at": "2025-06-11T14:06:10.430838Z", "purpose": "purchase", "receipt_url": "https://receipt.example.com/purchase/0192f790-170e-e630-609a-18a0447ee30b", "stages": [ { "amount": { "amount": 10000, "currency": "BRL" }, "callback_amount": { "amount": 10000, "currency": "BRL" }, "callback_type": "confirmed", "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-1639-9f94-b0296ef109c2", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchase_document_id": "0192f790-170e-e630-609a-18a0447ee30b", "purpose": "purchase", "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null } ], "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null } }, "properties": { "data": { "$ref": "#/components/schemas/V2_card_purchase_with_stages" } }, "required": [ "data" ], "title": "V2 card purchase response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.Response", "x-validate": null }, "V2_counterparty_bank_account_create_params": { "description": "The bank account to add to the counterparty", "example": { "branch": "0001", "digit": "1", "ispb": "12345678", "number": "87654321", "type": "checking" }, "properties": { "branch": { "description": "Branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "ISPB of the institution", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Account number", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Account type", "enum": [ "checking", "payment", "salary", "savings" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "ispb", "branch", "number", "digit", "type" ], "title": "V2 counterparty bank account create params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.BankAccount.CreateParams", "x-validate": null }, "V2_transfer_create_params": { "description": "Body params to generate a transfer", "example": { "amount": 100, "description": "Transferência interna", "external_id": "external_id", "from_bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "to_bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010" }, "properties": { "amount": { "description": "Amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Transfer description", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "type": "string", "x-struct": null, "x-validate": null }, "from_bank_account_id": { "description": "From bank account ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "to_bank_account_id": { "description": "To bank account ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "from_bank_account_id", "to_bank_account_id" ], "title": "V2 transfer create params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Transfer.CreateParams", "x-validate": null }, "V2_RecurrenceStageData": { "description": "A stage of a recurrence. `error_code` and `error_message` carry the rejection reason when there is one.", "example": { "error_code": null, "error_message": null, "id": "01997d8e-85b2-98fa-623f-8108b6aa8b8d", "inserted_at": "2025-09-24T21:08:36.423774Z", "status": "created" }, "properties": { "error_code": { "description": "Error code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Error message", "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": "Recurrence status the stage recorded", "enum": [ "created", "approved", "rejected", "expired", "cancelled", "collection_link" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceStageData", "type": "object", "x-struct": null, "x-validate": null }, "V2_listed_counterparty": { "description": "A counterparty as the listing returns it, without its bank accounts", "example": { "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "name": "participant_1", "tax_number": "***456789**", "updated_at": "2024-10-17T13:32:59.374149Z" }, "properties": { "id": { "description": "ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "Creation date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name of the counterparty", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the counterparty. A CPF is masked (e.g. ***456789**); a CNPJ is published as is", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Last update date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 listed counterparty", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.ListedCounterpartyData", "x-validate": null }, "RecurrencePeriodicity": { "description": "'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year", "enum": [ "week", "mnth", "qurt", "mian", "year" ], "title": "RecurrencePeriodicity", "type": "string", "x-struct": null, "x-validate": null }, "V2_card_purchase_stage": { "description": "One card network callback recorded for the purchase", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "callback_amount": { "amount": 10000, "currency": "BRL" }, "callback_type": "confirmed", "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-1639-9f94-b0296ef109c2", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchase_document_id": "0192f790-170e-e630-609a-18a0447ee30b", "purpose": "purchase", "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_money" }, "callback_amount": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "callback_type": { "description": "Callback type", "enum": [ "authorization", "approved", "denied", "canceled", "reversed", "voided", "confirmed" ], "type": "string", "x-struct": null, "x-validate": null }, "card_id": { "description": "Card ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "category_code": { "description": "Category code", "type": "string", "x-struct": null, "x-validate": null }, "category_type": { "description": "Category type", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "end_to_end_id": { "$ref": "#/components/schemas/V2_card_purchase_end_to_end_id" }, "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "error_code": { "description": "Why the purchase was declined, as a code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Why the purchase was declined", "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 }, "is_partially_allowed": { "description": "Is partially allowed", "type": "boolean", "x-struct": null, "x-validate": null }, "issuer_amount": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "merchant": { "$ref": "#/components/schemas/V2_card_purchase_merchant" }, "method_code": { "$ref": "#/components/schemas/V2_card_purchase_method_code" }, "purchase_document_id": { "description": "Purchase ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "purpose": { "description": "Purpose", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/V2_card_purchase_status" }, "tax": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "updated_at": { "description": "When the stage was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "zip_code": { "description": "Zip code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 card purchase stage", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.Stage", "x-validate": null }, "V2_counterparty_response": { "description": "Counterparty response", "example": { "data": { "bank_accounts": [ { "branch": "0001", "digit": "1", "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "12345678", "number": "87654321", "type": "checking", "updated_at": "2024-10-17T13:32:59.374149Z" } ], "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "name": "participant_1", "tax_number": "***456789**", "updated_at": "2024-10-17T13:32:59.374149Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_counterparty" } }, "title": "V2 counterparty response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Response", "x-validate": null }, "V2_bank_account_response": { "description": "A bank account response", "example": { "data": { "balances": { "available": { "amount": 150000, "currency": "BRL" }, "blocked": { "amount": 10000, "currency": "BRL" }, "updated_at": "2026-10-07T12:00:00.000000Z" }, "branch": "0001", "category": "owner", "description": "Conta", "digit": "1", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2024-10-12T00:00:00.000000Z", "limits": { "payments": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "pix": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "ted": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "tef": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } } }, "number": "12345678", "parameters": { "automatic_refund_for_person_dead": false, "automatic_refund_for_person_invalid_tax_number": false, "automatic_refund_for_person_underage": false, "in_block_for_legal_entity": false, "in_block_for_pix_qrcode_different_amount_payment": false, "in_block_for_pix_qrcode_different_counterparty_bank_account": false, "in_block_for_pix_qrcode_different_tax_number": false, "in_block_for_pix_qrcode_duplicated_payment": false, "in_block_for_unauthorized_participant": false, "in_block_for_unidentified_deposit": false, "out_block_for_legal_entity": false, "out_blocked": false }, "status": "approved", "type": "checking", "updated_at": "2024-10-12T00:00:00.000000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_bank_account" } }, "title": "V2 bank account response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Response", "x-validate": null }, "V2_card_list_metadata": { "description": "Pagination cursors", "example": { "after": null, "before": null, "has_more": false }, "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 } }, "required": [ "after", "before", "has_more" ], "title": "V2 card list metadata", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.ListMetadata", "x-validate": null }, "Onboarding_entity_representative_parameters": { "description": "Onboard legal representatives parameters for creating entity", "example": { "email": "john@gcorp.com", "is_pep": false, "is_us_person": false, "name": "John", "phone": "+5541999990000", "tax_number": "04969361908" }, "properties": { "email": { "description": "Legal representative email", "type": "string", "x-struct": null, "x-validate": null }, "is_pep": { "default": false, "description": "Whether the legal representative is a politically exposed person", "type": "boolean", "x-struct": null, "x-validate": null }, "is_us_person": { "default": false, "description": "Whether the legal representative is a US person", "type": "boolean", "x-struct": null, "x-validate": null }, "name": { "description": "Legal representative name", "type": "string", "x-struct": null, "x-validate": null }, "phone": { "description": "Legal representative phone number in e.164 format", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Legal representative tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "email", "phone", "name" ], "title": "Onboarding entity representative parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.Entity.EntityRepresentativeParams", "x-validate": null }, "V2_pledged_advance_request": { "description": "Pledged advance request", "example": { "amount": { "amount": 100000, "currency": "BRL" }, "approved_at": null, "assignor": { "bank_account_digit": "2", "bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7c", "bank_account_number": "0023123", "tax_number": "63558804023" }, "bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7b", "canceled_at": null, "charges": [], "contract_file_reference": "pledged/contracts/1_contract.pdf", "description": "Antecipação de recebíveis", "entity_id": "019084f3-ea10-3691-38dc-bda6ac03cb7a", "id": "019084f3-ea10-3691-38dc-bda6ac03cb70", "inserted_at": "2026-09-10T12:00:00.000000Z", "payer": { "tax_number": "80617053000195" }, "pledged_amount": { "amount": 100000, "currency": "BRL" }, "pledged_balance": { "amount": 100000, "currency": "BRL" }, "pledged_by": "payer_tax_number", "rejected_at": null, "status": "created", "updated_at": "2026-09-10T12:00:00.000000Z" }, "properties": { "amount": { "description": "Advance amount requested", "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency code (ISO 4217)", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "approved_at": { "description": "When the advance request was approved", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "assignor": { "description": "Assignor of the pledged receivables", "properties": { "bank_account_digit": { "description": "Assignor bank account digit", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Assignor bank account ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "bank_account_number": { "description": "Assignor bank account number", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Assignor tax number", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that receives the advance", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "canceled_at": { "description": "When the advance request was canceled", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "charges": { "description": "Charges pledged to the advance request", "items": { "$ref": "#/components/schemas/V2_pledged_advance_request_charge" }, "type": "array", "x-struct": null, "x-validate": null }, "contract_file_reference": { "description": "Reference of the contract file uploaded with the request", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Advance request ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the advance request was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "payer": { "description": "Payer whose charges are pledged", "properties": { "tax_number": { "description": "Payer tax number", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "pledged_amount": { "description": "Total amount of the charges pledged to the advance", "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency code (ISO 4217)", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "pledged_balance": { "description": "Pledged amount not yet received from the charges", "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency code (ISO 4217)", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "pledged_by": { "description": "What the receivables are pledged by: every charge of the payer, or the charges listed", "enum": [ "payer_tax_number", "charge_id" ], "type": "string", "x-struct": null, "x-validate": null }, "rejected_at": { "description": "When the advance request was rejected", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Advance request status", "enum": [ "created", "approved", "rejected", "canceled" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the advance request was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 pledged advance request", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Pledged.AdvanceRequest.Data", "x-validate": null }, "V2_list_of_stages_within_an_in_document": { "description": "List of stages within an in document", "items": { "$ref": "#/components/schemas/V2_stage_of_an_in_document" }, "title": "V2 list of stages within an in document", "type": "array", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.StageListResponse", "x-validate": null }, "Limit": { "description": "Limit list", "minimum": 10, "title": "Limit", "type": "integer", "x-struct": null, "x-validate": null }, "V2_onboarding_parameters": { "description": "Onboard parameters for creating entity", "example": { "business_infos": { "annual_revenue": { "amount": 500000, "currency": "BRL" }, "average_ticket": { "amount": 10000000, "currency": "BRL" } }, "consent": { "consent_at": "2026-08-25T07:00:00.000Z", "ip_address": "8.8.8.8", "tax_number": "04969361908" }, "external_id": "12345ET", "name": "Entity Test", "representatives": [ { "email": "john@gcorp.com", "is_pep": false, "is_us_person": false, "name": "John", "phone": "+5541999990000", "tax_number": "04969361908" } ], "tax_number": "61775921000110" }, "properties": { "business_infos": { "$ref": "#/components/schemas/V2_onboarding_entity_business_information_parameters" }, "consent": { "$ref": "#/components/schemas/Onboarding_entity_consent_parameters" }, "external_id": { "description": "External ID of the Entity", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name of the Entity", "type": "string", "x-struct": null, "x-validate": null }, "representatives": { "items": { "$ref": "#/components/schemas/Onboarding_entity_representative_parameters" }, "type": "array", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the Entity", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "name", "business_infos", "representatives", "consent" ], "title": "V2 onboarding parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.V2.Entity.OnboardParams", "x-validate": null }, "V2_DynamicQRCodeWithDueData": { "description": "A dynamic QRCode with due date, as returned by show and create. `image` is present only when create was asked for it with `options.show_qrcode_image`.", "example": { "amount": { "amount": 1000, "currency": "BRL" }, "bank_account_id": "01a0d98d-7547-22cf-f4f6-e8a63cd72cf5", "counterparty": { "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" }, "description": "description", "due_detail": { "due_date": "2026-09-30", "fine": { "calculation_type": "percentage", "value": 200 } }, "expiration_datetime": "2026-10-06T02:59:59.999999Z", "external_id": "external_id", "fee": { "amount": 0, "currency": "BRL" }, "hash": "00020101021226640014br.gov.bcb.pix2542qrcode.trio.com.br/cobv/01M3CRTXYFDDFTA8MF4XH2183B5204000053039865802BR5909NAME TEST6009NAME TEST62070503***63042C42", "id": "01a0d98d-77cf-6b5f-a522-8f276220a06b", "inserted_at": "2026-09-25T17:12:02.255000Z", "options": { "allow_change_the_amount_on_payment": true }, "origin": { "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "type": "none" }, "status": "created", "updated_at": "2026-09-25T17:12:02.255000Z" }, "properties": { "amount": { "description": "Amount value of the dynamic QRCode", "properties": { "amount": { "description": "Amount integer", "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 that receives the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Payer the QRCode is issued to", "properties": { "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the dynamic QRCode", "type": "string", "x-struct": null, "x-validate": null }, "due_detail": { "$ref": "#/components/schemas/V2_PixDueDetail" }, "expiration_datetime": { "description": "Datetime after which the QRCode can no longer be paid", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the dynamic QRCode", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee charged on the payment", "nullable": true, "properties": { "amount": { "description": "Fee 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 }, "hash": { "description": "Hash (Pix copy and paste) of the QRCode", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Unique identifier", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "image": { "description": "Base64 QRCode image, only when requested on create", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the QRCode was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "options": { "description": "Payment options of the QRCode", "properties": { "allow_change_the_amount_on_payment": { "description": "Whether the payer may change the amount", "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what created the QRCode", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "status": { "description": "Status of the dynamic QRCode", "enum": [ "created", "settled", "deleted" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the QRCode was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 DynamicQRCodeWithDueData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcodeWithDue.QrCodeData", "x-validate": null }, "V2_Generate_Boleto_async_create_params": { "description": "Body params to generate an async boleto", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "code": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Consectetur esse sed irure incididunt est culpa nostrud.", "external_id": "5b760495-cb55-4043-95e8-0cff5776b014" }, "properties": { "amount": { "description": "Amount of the boleto in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "code": { "description": "Barcode or digitable_line of the boleto", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boleto", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the boleto for reference", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "amount", "bank_account_id", "code" ], "title": "V2 Generate_Boleto_async_create_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Boleto.BoletoSchema.GenerateAsyncRequest", "x-validate": null }, "V2_Boleto_recreate_params": { "description": "Body params to recreate a boleto: it is cancelled and a new boleto is created with the same fields, the new amount and the new due date (or the current one when `due_detail` is omitted).", "example": { "amount": 15000, "due_detail": { "due_date": "2026-12-16" } }, "properties": { "amount": { "description": "New amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "due_detail": { "nullable": true, "properties": { "due_date": { "description": "New due date of the boleto", "format": "date", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "due_date" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "amount" ], "title": "V2 Boleto_recreate_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.RecreateRequest", "x-validate": null }, "V2_CreateNextCollectionParams": { "description": "Body params to create the next collection of a recurrence", "example": { "recurrence_id": "019a0d9e-d161-cd70-e9bd-f90cf4b50e33" }, "properties": { "recurrence_id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "recurrence_id" ], "title": "V2 CreateNextCollectionParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.CreateNextCollectionParams", "x-validate": null }, "V2_card_with_balance": { "description": "Card, with its current balance", "example": { "balance": { "amount": 0, "currency": "BRL" }, "display_name": "marketing card", "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "id": "019514eb-5d5c-b395-5a77-449d12701ce7", "masked_number": "•••• •••• •••• 1234", "status": "active", "type": "virtual" }, "properties": { "balance": { "$ref": "#/components/schemas/V2_card_money" }, "display_name": { "description": "Display name", "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "ID of the entity that holds the card", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Card ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "masked_number": { "description": "Masked card number", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Card status", "enum": [ "created", "pending", "active", "blocked", "expired", "canceled" ], "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Card type", "enum": [ "virtual" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "balance", "display_name", "entity_id", "masked_number", "status", "type" ], "title": "V2 card with balance", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.DataWithBalance", "x-validate": null }, "V2_CancelRecurrenceParams": { "description": "Body params to cancel a recurrence", "example": { "requester_tax_number": "12345678000100" }, "properties": { "requester_tax_number": { "description": "Requester Tax Number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "requester_tax_number" ], "title": "V2 CancelRecurrenceParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.CancelParams", "x-validate": null }, "V2_Pix_check_counterparty": { "description": "Owner of the checked Pix key, who receives the payment. A person (CPF) has the tax number masked and only the ISPB of their bank account published; a company (CNPJ) is published as is.", "example": { "bank_account": { "branch": null, "digit": null, "id": "0008d49c-e6d5-a58e-a742-449e9b38f795", "ispb": "12345678", "number": null, "type": null }, "id": "0008d49c-e6d5-4d86-232a-a6f4b9138f10", "name": "John Doe", "tax_number": "***982247**" }, "properties": { "bank_account": { "description": "Bank account the Pix key points to", "properties": { "branch": { "description": "Branch. Null for a CPF", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit. Null for a CPF", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty bank account ID, once Trio has registered the account", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "ISPB of the bank", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Account number. Null for a CPF", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Account type. Null for a CPF", "enum": [ "checking", "payment", "salary", "savings" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "ispb", "branch", "number", "digit", "type" ], "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID, once Trio has registered the counterparty", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name", "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", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "name", "tax_number", "bank_account" ], "title": "V2 Pix check counterparty", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.PixCheck.Counterparty", "x-validate": null }, "V2_entity_list_response": { "description": "A list of entities from TrioCore's compliance", "example": { "data": [ { "addresses": [ { "address_additional_details": "Apto 42", "address_line": "Rua das Flores", "address_number": "123", "city_name": "Curitiba", "district": "Centro", "zip_code": "80000000" } ], "business_infos": { "annual_revenue": { "amount": 500000, "currency": "BRL" }, "average_ticket": { "amount": 10000000, "currency": "BRL" }, "company_activity": "6201501", "company_secondary_activity": [ "6202300" ] }, "contact": { "email": "entity@gmail.com", "phone_number": "41999999999" }, "id": "01a163ec-8dd5-8386-b33a-70a4713ecdb2", "inserted_at": "2026-10-22T14:03:29.651178Z", "legal_name": "Entity Test LLC", "status": "approved", "tax_number": "DN0O5N510HG833", "updated_at": "2026-10-22T14:03:29.651187Z" } ] }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_entity" }, "type": "array", "x-struct": null, "x-validate": null } }, "title": "V2 entity list response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.ListResponse", "x-validate": null }, "V2_Static_QRCode_single_response": { "description": "Response for a single static QRCode", "example": { "data": { "amount": { "amount": 10, "currency": "BRL" }, "bank_account_id": "019252ca-4859-55f0-0f20-6f02250b5acd", "description": "description", "external_id": "external_id", "fee": { "amount": 0, "currency": "BRL" }, "hash": "00020126580014br.gov.bcb.pix0136019252ca-48b2-e95e-c398-3133a04a5b3e52040000530398654040.105802BR5911brcode_name6011brcode_city622605222HwV3MJojKRR2FxvgYTgYF6304C4D0", "id": "019252ca-4a5b-b711-2371-0a0142807c75", "inserted_at": "2024-10-03T14:30:42.011732Z", "origin": { "id": null, "type": null }, "status": "created", "updated_at": "2024-10-03T14:30:42.011732Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_Static_QRCode_response" } }, "title": "V2 Static QRCode single response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.StaticBrcode.Response", "x-validate": null }, "DynamicBrcodeDueDetailDiscountCalculationType": { "description": "Discount calculation type of dynamic brcode with due detail", "enum": [ "amount", "percentage" ], "nullable": true, "title": "DynamicBrcodeDueDetailDiscountCalculationType", "type": "string", "x-struct": null, "x-validate": null }, "V2_Pix_key_check_params": { "description": "Body params to check a Pix key before paying it", "example": { "entity_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "key": "john.doe@example.com" }, "properties": { "entity_id": { "description": "Entity that will pay the Pix", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "key": { "description": "Pix key: a CPF, a CNPJ, an email, a phone number (+5511999999999) or a random key", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "entity_id", "key" ], "title": "V2 Pix key check params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.PixCheck.KeyCheckParams", "x-validate": null }, "V2_RecurrenceCollectionAttemptEmbeddedData": { "description": "An attempt to charge a recurrence collection. `stages` is present only when they were loaded.", "example": { "due_date": "2025-07-14", "end_to_end_id": "E33333333202507141500duiiTl1rnpc", "external_id": null, "id": "019809e6-c836-fe49-0b1a-ccd48befb6b8", "inserted_at": "2025-07-14T17:06:16.606122Z", "status": "requested", "transaction_date": null, "updated_at": "2025-07-14T17:06:16.606122Z" }, "properties": { "due_date": { "description": "Day the attempt is due", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "end_to_end_id": { "description": "Pix end to end ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Attempt ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the attempt was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "stages": { "description": "Attempt stages", "items": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptStage" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Attempt status", "enum": [ "requested", "scheduled", "settled", "cancelled", "rejected", "expired", "failed" ], "type": "string", "x-struct": null, "x-validate": null }, "transaction_date": { "description": "When the attempt was paid", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the attempt was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceCollectionAttemptEmbeddedData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Attempt.EmbeddedData", "x-validate": null }, "V2_list_counterparties_response": { "description": "A page of counterparties", "example": { "data": [ { "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "name": "participant_1", "tax_number": "***456789**", "updated_at": "2024-10-17T13:32:59.374149Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_listed_counterparty" }, "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 counterparties response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.ListResponse", "x-validate": null }, "Counterparty_recipient_counterparty_data": { "example": { "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "name": "Random", "tax_number": "34842155000197" }, "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "description": "Name of the counterparty", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the counterparty", "type": "string", "x-struct": null, "x-validate": null } }, "title": "Counterparty recipient counterparty data", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.CounterpartyData", "x-validate": null }, "V2_RecurrenceRequestResponse": { "description": "Recurrence request response", "example": { "data": { "counterparty": { "bank_account": { "id": "019809db-4baf-07f7-7767-e32734e5b636" }, "id": "019809db-4baf-039f-be7a-ed7d1f147ab5" }, "expires_at": "2025-08-13T13:53:43.287296Z", "id": "019809db-4af7-47fc-1add-28b582f08576", "inserted_at": "2025-07-14T16:53:43.471712Z", "recurrence": { "id": "019809db-4af7-c377-de68-c1f56b542305" }, "status": "created", "updated_at": "2025-07-14T16:53:43.471712Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_RecurrenceRequestData" } }, "title": "V2 RecurrenceRequestResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.Response", "x-validate": null }, "V2_onboard_response": { "description": "Entity onboard response", "example": { "data": { "business_infos": { "annual_revenue": { "amount": 5000000, "currency": "BRL" }, "average_ticket": { "amount": 500000, "currency": "BRL" } }, "consent": { "consent_at": "2026-08-25T07:00:00.000000Z", "ip_address": "8.8.8.8", "tax_number": "52998224725" }, "entity_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f", "external_id": "404ANVIL", "inserted_at": "2026-09-29T19:23:42.485921Z", "name": "ACME INC", "org_id": "92b0f620-7105-4c10-84a1-f5a034a14efa", "representatives": [ { "email": "w.coyote@acme.com", "id": "8c61c7fd-3509-4306-9fec-9090e82fe121", "name": "Willy Coyote", "phone": "+5541999990000", "required_documents": [ "identification" ], "status": "in_validation", "tax_number": "52998224725" } ], "required_documents": [ "company_contract" ], "status": "in_validation", "tax_number": "61775921000110", "updated_at": "2026-09-29T19:23:42.485921Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_entity_onboard_data" } }, "title": "V2 onboard response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.V2.Entity.OnboardResponse", "x-validate": null }, "V2_card_invoice_statement_CSV_response": { "description": "Where to download the CSV statement of an invoice", "example": { "data": { "from_datetime": "2025-06-01T03:00:00.000000Z", "to_datetime": "2025-07-01T02:59:59.999999Z", "url": "https://storage.example.com/invoice_statements/0182b3d0-0b3b-4b3b-8b3b-0b3b4b3b8b3b.csv" } }, "properties": { "data": { "properties": { "from_datetime": { "description": "When the invoice period starts", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "to_datetime": { "description": "When the invoice period ends", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "Temporary download URL of the CSV", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "url", "from_datetime", "to_datetime" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 card invoice statement CSV response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Invoice.StatementCSVResponse", "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_bank_account_limits": { "description": "Daily and overnight shift limits and maximum amount of a single transaction.", "example": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "nullable": true, "properties": { "daily": { "allOf": [ { "$ref": "#/components/schemas/V2_bank_account_shift_limit" } ], "description": "Daily shift limit", "x-struct": null, "x-validate": null }, "overnight": { "allOf": [ { "$ref": "#/components/schemas/V2_bank_account_shift_limit" } ], "description": "Overnight shift limit", "x-struct": null, "x-validate": null }, "transaction": { "description": "Single transaction limit", "properties": { "max": { "allOf": [ { "$ref": "#/components/schemas/V2_bank_account_amount" } ], "description": "Maximum amount of a single transaction", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "V2 bank account limits", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Limits", "x-validate": null }, "V2_Pix_Key_response": { "description": "Pix Key response", "example": { "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2020-01-10T10:00:00Z", "key": "12345678900", "status": "created", "tax_number": "12345678900", "type": "tax_number", "updated_at": "2020-01-10T10:00:00Z" }, "properties": { "bank_account_id": { "description": "Bank Account ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Unique identifier", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "Inserted at", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "key": { "description": "Pix Key key", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Pix Key Status", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the key owner", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Pix Key type", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Updated at", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 Pix Key response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.KeyData", "x-validate": null }, "V2_card": { "description": "Card, without its balance", "example": { "display_name": "marketing card", "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "id": "019514eb-5d5c-b395-5a77-449d12701ce7", "masked_number": "•••• •••• •••• 1234", "status": "active", "type": "virtual" }, "properties": { "display_name": { "description": "Display name", "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "ID of the entity that holds the card", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Card ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "masked_number": { "description": "Masked card number", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Card status", "enum": [ "created", "pending", "active", "blocked", "expired", "canceled" ], "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Card type", "enum": [ "virtual" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "display_name", "entity_id", "masked_number", "status", "type" ], "title": "V2 card", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Data", "x-validate": null }, "V2_create_pledged_advance_request_params": { "description": "Body params to create a pledged advance request", "example": { "amount": 100000, "assignor": { "bank_account_digit": "2", "bank_account_number": "0023123", "branch_code": "0001", "tax_number": "63558804023" }, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "description": "Antecipação de recebíveis", "file_binary": "Q09OVFJBVE8=", "payer": { "tax_number": "80617053000195" }, "pledged_by": "payer_tax_number" }, "properties": { "amount": { "description": "Amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "assignor": { "description": "Assignor of the pledged receivables and its Trio bank account", "properties": { "bank_account_digit": { "description": "Assignor bank account digit", "type": "string", "x-struct": null, "x-validate": null }, "bank_account_number": { "description": "Assignor bank account number", "type": "string", "x-struct": null, "x-validate": null }, "branch_code": { "description": "Assignor branch code", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Assignor tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "branch_code", "bank_account_number", "bank_account_digit" ], "type": "object", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that receives the advance", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "charges": { "default": [], "description": "Charge IDs, used when pledged_by is charge_id", "items": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "file_binary": { "description": "Contract file content encoded in base64", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "payer": { "description": "Payer of the pledged receivables. Required for both pledged_by values, since the payer is always registered as the counterparty", "properties": { "tax_number": { "description": "Payer tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "pledged_by": { "description": "What the receivables are pledged by: every charge of the payer, or the charges listed", "enum": [ "payer_tax_number", "charge_id" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "bank_account_id", "amount", "pledged_by", "payer", "assignor" ], "title": "V2 create pledged advance request params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Pledged.AdvanceRequest.CreateParams", "x-validate": null }, "V2_card_invoice": { "description": "The card spending of an entity over a period", "example": { "balance": { "amount": 9000, "currency": "BRL" }, "entity_id": "0182b3d3-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "from_datetime": "2025-06-01T03:00:00.000000Z", "id": "0182b3d0-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "pending_confirmation_amount": { "amount": 0, "currency": "BRL" }, "purchase_balance": { "amount": 10000, "currency": "BRL" }, "status": "open", "to_datetime": "2025-07-01T02:59:59.999999Z" }, "properties": { "balance": { "$ref": "#/components/schemas/V2_card_money" }, "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "from_datetime": { "description": "When the invoice period starts", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Invoice ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "pending_confirmation_amount": { "$ref": "#/components/schemas/V2_card_money" }, "purchase_balance": { "$ref": "#/components/schemas/V2_card_money" }, "status": { "description": "Status", "enum": [ "open", "closed", "paid" ], "type": "string", "x-struct": null, "x-validate": null }, "to_datetime": { "description": "When the invoice period ends", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "entity_id", "from_datetime", "to_datetime", "status", "balance", "purchase_balance", "pending_confirmation_amount" ], "title": "V2 card invoice", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Invoice.Data", "x-validate": null }, "V2_bank_account": { "description": "A bank account v2.", "example": { "balances": { "available": { "amount": 150000, "currency": "BRL" }, "blocked": { "amount": 10000, "currency": "BRL" }, "updated_at": "2026-10-07T12:00:00.000000Z" }, "branch": "0001", "category": "owner", "description": "Conta", "digit": "1", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2024-10-12T00:00:00.000000Z", "limits": { "payments": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "pix": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "ted": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "tef": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } } }, "number": "12345678", "parameters": { "automatic_refund_for_person_dead": false, "automatic_refund_for_person_invalid_tax_number": false, "automatic_refund_for_person_underage": false, "in_block_for_legal_entity": false, "in_block_for_pix_qrcode_different_amount_payment": false, "in_block_for_pix_qrcode_different_counterparty_bank_account": false, "in_block_for_pix_qrcode_different_tax_number": false, "in_block_for_pix_qrcode_duplicated_payment": false, "in_block_for_unauthorized_participant": false, "in_block_for_unidentified_deposit": false, "out_block_for_legal_entity": false, "out_blocked": false }, "status": "approved", "type": "checking", "updated_at": "2024-10-12T00:00:00.000000Z" }, "properties": { "balances": { "$ref": "#/components/schemas/V2_bank_account_balances" }, "branch": { "description": "Branch code", "type": "string", "x-struct": null, "x-validate": null }, "category": { "description": "Bank account category", "enum": [ "linked", "owner", "transactional", "operational" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Bank account description", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit", "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": "Creation date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "limits": { "$ref": "#/components/schemas/V2_bank_account_limits_by_transaction_type" }, "number": { "description": "Account number", "type": "string", "x-struct": null, "x-validate": null }, "parameters": { "$ref": "#/components/schemas/V2_bank_account_parameters" }, "status": { "$ref": "#/components/schemas/V2_bank_account_status" }, "type": { "description": "Account type", "enum": [ "checking", "payment", "salary", "savings", "card" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Last update date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 bank account", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.BankAccountData", "x-validate": null }, "V2_in_refund_document_stage_list_response": { "description": "Refund document stage list response", "items": { "$ref": "#/components/schemas/V2_in_refund_document_stage_response" }, "title": "V2 in refund document stage list response", "type": "array", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Refund.StageListResponse", "x-validate": null }, "V2_RecurrenceCollectionListData": { "description": "A list data of automatic recurrence collections", "example": [ { "additional_info": null, "amount": { "amount": 100, "currency": "BRL" }, "bank_account_id": "019a0d9e-d21f-32d2-7b68-d4e55e72e528", "final_date": null, "id": "019a0d9e-d21f-0bf6-36be-abb0e6be5792", "inserted_at": "2025-10-22T20:31:43.647903Z", "next_working_day": false, "recurrence": { "id": "019a0d9e-d161-cd70-e9bd-f90cf4b50e33" }, "status": "active", "transaction_date": null, "updated_at": "2025-10-22T20:31:46.843629Z" } ], "items": { "$ref": "#/components/schemas/V2_RecurrenceCollectionData" }, "title": "V2 RecurrenceCollectionListData", "type": "array", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.ListData", "x-validate": null }, "V2_RecurrenceCollectionAttemptResponse": { "description": "Recurrence collection attempt response", "example": { "data": { "collection": { "id": "019809e6-c8ef-843e-28fb-9ade27a8043b" }, "due_date": "2025-07-14", "end_to_end_id": "E33333333202507141500duiiTl1rnpc", "external_id": null, "id": "019809e6-c836-fe49-0b1a-ccd48befb6b8", "inserted_at": "2025-07-14T17:06:16.606122Z", "status": "requested", "transaction_date": null, "updated_at": "2025-07-14T17:06:16.606122Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptData" } }, "title": "V2 RecurrenceCollectionAttemptResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Attempt.Response", "x-validate": null }, "V2_RecurrenceRequestStage": { "description": "A stage of a recurrence request", "example": { "error_code": null, "error_message": null, "id": "019809db-4bb0-5a1e-0c1d-9e5f2b8a7c31", "inserted_at": "2025-07-14T16:53:43.471712Z", "status": "created" }, "properties": { "error_code": { "description": "Error code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Error message", "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": "Request status the stage recorded", "enum": [ "created", "sent", "received", "rejected", "accepted", "expired", "cancelled" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceRequestStage", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.Stage", "x-validate": null }, "V2_RecurrenceResponse": { "description": "Recurrence response with stages", "example": { "data": { "amounts": { "fixed": { "amount": 10000, "currency": "BRL" }, "maximum": { "amount": 10000, "currency": "BRL" }, "minimum": { "amount": 10000, "currency": "BRL" } }, "authorized_at": "2020-04-20T16:20:00Z", "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6", "contract_number": "", "counterparty": { "bank_account": { "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6" }, "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6" }, "description": "", "end_date": "2020-04-20", "external_id": "", "first_payment": { "amount": { "amount": 10000, "currency": "BRL" }, "date": "2020-04-20" }, "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6", "inserted_at": "2020-04-20T16:20:00Z", "number_of_collections": 0, "options": { "automatic_schedule": false, "next_working_day": false, "retry_policy": "none" }, "origin": { "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6", "type": "" }, "periodicity": "week", "reference": { "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6", "type": "requ" }, "requests": [ { "counterparty": { "bank_account": { "id": "019809db-4baf-07f7-7767-e32734e5b636" }, "id": "019809db-4baf-039f-be7a-ed7d1f147ab5" }, "expires_at": "2025-08-13T13:53:43.287296Z", "id": "019809db-4af7-47fc-1add-28b582f08576", "inserted_at": "2025-07-14T16:53:43.471712Z", "status": "created", "updated_at": "2025-07-14T16:53:43.471712Z" } ], "stages": [ { "error_code": null, "error_message": null, "id": "01997d8e-85b2-98fa-623f-8108b6aa8b8d", "inserted_at": "2025-09-24T21:08:36.423774Z", "status": "created" } ], "start_date": "2020-04-20", "status": "created", "type": "in", "updated_at": "2020-04-20T16:20:00Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_DataWithStageAndRequest" } }, "title": "V2 RecurrenceResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Response", "x-validate": null }, "V2_CancelCollectionParams": { "description": "Body params to cancel a collection", "example": { "entity_id": "019a0d9e-d0a1-4f2b-9c3d-5e6f7a8b9c0d", "requester_tax_number": "12345678900" }, "properties": { "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "requester_tax_number": { "description": "Requester Tax Number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "requester_tax_number" ], "title": "V2 CancelCollectionParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.CancelParams", "x-validate": null }, "V2_PixDueDetailParams": { "description": "Due detail of a Pix charge with due date. Each rule takes `amount` (cents) for the `amount` calculation type and `value` (basis points, 100 = 1%) for `percentage`.", "example": { "discount": { "per_day_antecipated": { "amount": 50, "calculation_days": "working", "calculation_type": "amount" } }, "due_date": "2026-09-30", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "calculation_days": "calendar", "calculation_period": "month", "calculation_type": "percentage", "value": 100 } }, "properties": { "discount": { "description": "Discount for payments before the due date; set only one option", "properties": { "fixed_until_due": { "description": "Discount granted until each date", "properties": { "amounts": { "items": { "properties": { "amount": { "description": "Amount in cents, for the `amount` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "date": { "description": "Last date on which the discount applies", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "date" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType" } }, "required": [ "calculation_type", "amounts" ], "type": "object", "x-struct": null, "x-validate": null }, "per_day_antecipated": { "description": "Discount per day paid in advance", "properties": { "amount": { "description": "Amount in cents, for the `amount` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_days": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationDays" }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type" ], "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "fine": { "description": "Fine charged after the due date", "properties": { "amount": { "description": "Amount in cents, for the `amount` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailFineCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type" ], "type": "object", "x-struct": null, "x-validate": null }, "interest": { "description": "Interest charged after the due date", "properties": { "amount": { "description": "Amount in cents, for the `amount` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_days": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailInterestCalculationDays" }, "calculation_period": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailInterestCalculationPeriod" }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailInterestCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type" ], "type": "object", "x-struct": null, "x-validate": null }, "rebate": { "description": "Rebate applied to the amount", "properties": { "amount": { "description": "Amount in cents, for the `amount` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailRebateCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "due_date" ], "title": "V2 PixDueDetailParams", "type": "object", "x-struct": null, "x-validate": null }, "DynamicBrcodeDueDetailInterestCalculationDays": { "description": "Interest calculation days of dynamic brcode with due detail", "enum": [ "calendar", "working" ], "nullable": true, "title": "DynamicBrcodeDueDetailInterestCalculationDays", "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 }, "V2_dynamic_QRCode_hash_response": { "description": "Hash (Pix copy and paste) of a dynamic QRCode", "example": { "data": { "hash": "00020101021226630014br.gov.bcb.pix2541qrcode.trio.com.br/cob/01JAXF36NZQAS2041671EZ7FN95204000053039865802BR5911brcode_name6011brcode_city62070503***6304B527" } }, "properties": { "data": { "properties": { "hash": { "description": "QRCode hash (Pix copy and paste)", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "hash" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 dynamic QRCode hash response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcode.HashResponse", "x-validate": null }, "Counterparty_recipient_list_response": { "example": { "data": [ { "bank_account": null, "counterparty": { "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "name": "Random", "tax_number": "34842155000197" }, "id": "1fb05245-a185-0ec1-2661-3390353a35e3", "pix_key": "some-pix-key", "ref_type": "pix_key" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/Counterparty_recipient_data" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "after": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "before": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "has_more": { "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "Counterparty recipient list response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.ListResponse", "x-validate": null }, "V2_in_document": { "description": "In document, as returned by the listing, show and search. `bank_account_id` is the account that received it; the counterparty carries the bank account it was paid from as `bank_account_id`.", "example": { "amount": { "amount": 100, "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": "E60746948202610072016A0049Tfmiks", "external_id": "01M4C040NGQ5VKGKZRR3SXRZ7E", "id": "01a11802-3da7-052e-3f8f-19cfe127e4b8", "inserted_at": "2026-10-07T20:16:02.471297Z", "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in/01a11802-3da7-052e-3f8f-19cfe127e4b8", "reconciliation_id": "01a11802-3da7-09df-060e-0ca0747a1876", "reference": { "id": "01a11802-b618-fcd7-94f4-88f533fe41cc", "type": "pix_qrcode" }, "refunds": [], "stages": [ { "error_code": null, "error_message": null, "id": "01a11802-3da7-2381-58a7-54b90a2ffa9a", "inserted_at": "2026-10-07T20:17:02.479108Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11802-3da7-af9b-756c-9522bbd3b87f", "inserted_at": "2026-10-07T20:17:03.475249Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-07T20:17:02.795000Z", "type": "pix", "updated_at": "2026-10-07T20:17:03.475249Z" }, "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 paid the 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": "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_in_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 settles, such as the Pix QR code it paid", "properties": { "id": { "description": "Reference ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "allOf": [ { "$ref": "#/components/schemas/V2_in_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_in_document" }, "type": "array", "x-struct": null, "x-validate": null }, "stages": { "$ref": "#/components/schemas/V2_list_of_stages_within_an_in_document" }, "status": { "$ref": "#/components/schemas/V2_in_document_status" }, "transaction_date": { "description": "Transaction date", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "type": { "$ref": "#/components/schemas/V2_in_document_type" }, "updated_at": { "description": "When the document was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 in document", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.InDocumentData", "x-validate": null }, "V2_list_cards_response": { "description": "A page of cards. Read a card for its balance.", "example": { "data": [ { "display_name": "marketing card", "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "id": "019514eb-5d5c-b395-5a77-449d12701ce7", "masked_number": "•••• •••• •••• 1234", "status": "active", "type": "virtual" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_card" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "$ref": "#/components/schemas/V2_card_list_metadata" } }, "required": [ "data", "metadata" ], "title": "V2 list cards response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.ListResponse", "x-validate": null }, "V2_transfer_document": { "description": "Transfer document, as returned by the listing and show. `from_bank_account_id` and `to_bank_account_id` are the accounts it moves money between.", "example": { "amount": { "amount": 1, "currency": "BRL" }, "description": "Transferência interna", "external_id": "01M4H104PKKZ0CGC013Y8FE4G2", "from_bank_account_id": "019ddfe9-e64b-b642-36fd-efdaef77d05e", "id": "01a12210-33a8-ae95-5333-213dfa0bda47", "inserted_at": "2026-10-09T19:07:29.576442Z", "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "reconciliation_id": "01a12210-33a8-2e7e-1d38-9e7eb34e6946", "stages": [ { "error_code": null, "error_message": null, "id": "01a12210-33a8-5cca-32f5-c8662a1e8c40", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a12210-33a8-b520-e507-7f570c825c11", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "settled" } ], "status": "settled", "to_bank_account_id": "01a1220f-79cc-5e5d-4342-b78b9dacd592", "transaction_date": "2026-10-09T19:07:29.778267Z", "updated_at": "2026-10-09T19:07:29.778267Z" }, "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 }, "description": { "description": "Description", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "from_bank_account_id": { "description": "From bank account ID", "format": "uuid", "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 transfer was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what originated the transfer", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type", "enum": [ "none", "api_client", "console_user", "billing", "reconciliation", "checkout", "bridge" ], "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "reconciliation_id": { "description": "Reconciliation UUID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "stages": { "description": "Transfer document stages", "items": { "$ref": "#/components/schemas/V2_stage_of_a_transfer_document" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/V2_transfer_document_status" }, "to_bank_account_id": { "description": "To bank account ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "transaction_date": { "description": "Transfer document transaction date", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the transfer was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 transfer document", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Transfer.TransferData", "x-validate": null }, "V2_card_purchase_status": { "description": "Purchase status", "enum": [ "authorized", "approved", "denied", "confirmed", "canceled", "reversed", "voided" ], "title": "V2 card purchase status", "type": "string", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.Status", "x-validate": null }, "V2_static_QRCode_hash_response": { "description": "Hash (Pix copy and paste) of a static QRCode", "example": { "data": { "hash": "00020126580014br.gov.bcb.pix0136019252ca-48b2-e95e-c398-3133a04a5b3e52040000530398654040.105802BR5911brcode_name6011brcode_city622605222HwV3MJojKRR2FxvgYTgYF6304C4D0" } }, "properties": { "data": { "properties": { "hash": { "description": "QRCode hash (Pix copy and paste)", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "hash" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 static QRCode hash response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.StaticBrcode.HashResponse", "x-validate": null }, "V2_Generate_pix_create_params": { "description": "Body params to pay a Pix. A key or a brcode is paid by the check made for it (`check_id`); a bank account is paid to the `counterparty` given.", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "counterparty": { "bank_account": { "branch": "0001", "digit": "1", "ispb": "12345678", "number": "123456", "type": "checking" }, "name": "John Doe", "tax_number": "52998224725" }, "description": "description", "external_id": "external_id 1", "type": "bank_account" }, "properties": { "amount": { "description": "Amount in cents", "maximum": 100000000000, "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that pays the Pix", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "check_id": { "description": "ID of the check from POST /v2/out/pix/keys/check (type key) or POST /v2/out/pix/brcodes/check (type brcode). Required for those types", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Receiver of the Pix. Required when type is bank_account", "properties": { "bank_account": { "description": "Bank account the Pix is paid to", "properties": { "branch": { "description": "Branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "ISPB of the bank", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Account number", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Account type", "enum": [ "checking", "payment", "salary", "savings" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "ispb", "branch", "number", "digit", "type" ], "type": "object", "x-struct": null, "x-validate": null }, "name": { "description": "Person or company name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF or CNPJ", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number", "bank_account" ], "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Pix description", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "type": { "description": "What the Pix pays: a checked key, a checked brcode or a bank account", "enum": [ "key", "brcode", "bank_account" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "type", "bank_account_id" ], "title": "V2 Generate pix create params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.GeneratePix.CreateParams", "x-validate": null }, "V2_list_in_document_refunds_response": { "description": "A list of in document refunds 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": "Devolução manual", "end_to_end_id": "D49931906202610081927B4HdgiWHdjH", "external_id": null, "id": "01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "in_document_id": "01a117fc-bb66-88e2-942b-0ce8cd702c5c", "inserted_at": "2026-10-08T19:27:19.400000Z", "med": false, "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in_refund/01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "reconciliation_id": "01a11cfb-fc1a-e185-85ce-75c67ff0ad87", "stages": [ { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-9ee4-7389-d989b8d525ff", "inserted_at": "2026-10-08T19:27:19.400000Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-91ab-04df-8d348772400b", "inserted_at": "2026-10-08T19:27:19.600000Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-08T19:27:19.524000Z", "updated_at": "2026-10-08T19:27:19.600000Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_in_document_refund" }, "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 in document refunds response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Refund.ListResponse", "x-validate": null }, "V2_DynamicQRCodeCreateParams": { "description": "Body params to create a dynamic QRCode", "example": { "amount": 10, "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "counterparty": { "bank_accounts": [ { "branch": "1", "digit": "1", "ispb": "00000001", "number": "80808080", "type": "checking" } ], "name": "counterparty_name", "tax_number": "12345678900" }, "description": "description", "expiration_datetime": "2026-10-22T14:03:27.395470Z", "external_id": "external_id", "options": { "allow_change_the_amount_on_payment": true, "fee": 0, "show_qrcode_image": true } }, "properties": { "amount": { "description": "Amount value of the dynamic QRCode", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank Account ID", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Counterparty information", "properties": { "bank_accounts": { "description": "Counterparty bank accounts", "items": { "$ref": "#/components/schemas/DynamicQRCodeCounterpartyBankAccountCreateParams" }, "type": "array", "x-struct": null, "x-validate": null }, "name": { "description": "Counterparty name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Counterparty tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the dynamic QRCode", "type": "string", "x-struct": null, "x-validate": null }, "expiration_datetime": { "description": "Expiration datetime", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the dynamic QRCode", "type": "string", "x-struct": null, "x-validate": null }, "merchant": { "description": "Merchant to register as the split org merchant. When sent, it is saved.", "nullable": true, "properties": { "name": { "description": "Merchant name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Merchant tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "options": { "description": "QRCode creation options", "properties": { "allow_change_the_amount_on_payment": { "description": "Allow amount change", "type": "boolean", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "show_qrcode_image": { "description": "Show qrcode image", "type": "boolean", "x-struct": null, "x-validate": null } }, "required": [ "allow_change_the_amount_on_payment", "show_qrcode_image" ], "type": "object", "x-struct": null, "x-validate": null }, "platform_id": { "description": "Platform ID of the dynamic QRCode", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "splits": { "description": "Cashin split configurations", "items": { "properties": { "counterparty_recipient_id": { "description": "Counterparty recipient UUID", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Split type", "enum": [ "percentage", "fixed" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage (0-100) or fixed amount in cents", "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "type", "value", "counterparty_recipient_id" ], "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "amount", "options", "bank_account_id" ], "title": "V2 DynamicQRCodeCreateParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcode.CreateParams", "x-validate": null }, "DynamicBrcodeDueDetailInterestCalculationType": { "description": "Interest calculation type of dynamic brcode with due detail", "enum": [ "amount", "percentage" ], "nullable": true, "title": "DynamicBrcodeDueDetailInterestCalculationType", "type": "string", "x-struct": null, "x-validate": null }, "V2_stage_of_a_transfer_document": { "description": "Stage of a transfer document", "example": { "error_code": null, "error_message": null, "id": "01a12210-33a8-b520-e507-7f570c825c11", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "settled" }, "properties": { "error_code": { "description": "Error code when stage represents an error", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Error message detail when 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 transfer reached at this stage", "enum": [ "created", "confirmed", "settled", "failed", "refund_link" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 stage of a transfer document", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Transfer.StageResponse", "x-validate": null }, "V2_Pix_brcode_check_response": { "description": "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.", "example": { "data": { "amount": { "amount": 100, "currency": "BRL" }, "amount_editable": false, "counterparty": { "bank_account": { "branch": "0001", "digit": "7", "id": "0008d49c-e6d5-a58e-a742-449e9b38f795", "ispb": "12345678", "number": "123456", "type": "checking" }, "id": "0008d49c-e6d5-4d86-232a-a6f4b9138f10", "name": "ACME LTDA", "tax_number": "11222333000181" }, "due_date": null, "expires_at": "2026-02-13T20:25:16.000000Z", "hash": "00020101021226630014br.gov.bcb.pix2541pix.example.com/cob/01JM0B0TY9BT4375S074Q00E0M5204000053039865802BR5908ACME LTDA6009Sao Paulo62070503***6304F3A0", "id": "019500b0-71d2-ac32-3712-e8ba5e06e0f7", "inserted_at": "2026-02-13T19:01:58.354481Z", "key": "11222333000181", "key_type": "tax_number", "updated_at": "2026-02-13T19:01:58.354481Z" } }, "properties": { "data": { "properties": { "amount": { "description": "Amount the brcode charges. Zero when the payer chooses it", "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 } }, "required": [ "amount", "currency" ], "type": "object", "x-struct": null, "x-validate": null }, "amount_editable": { "description": "Whether the payer may pay an amount other than `amount`", "nullable": true, "type": "boolean", "x-struct": null, "x-validate": null }, "counterparty": { "$ref": "#/components/schemas/V2_Pix_check_counterparty" }, "due_date": { "description": "Due date of a brcode with due date (cobrança com vencimento)", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "expires_at": { "description": "When the brcode stops accepting payments", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "hash": { "description": "Pix copy and paste code of the brcode", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Check ID, to pay as the check_id of POST /v2/out/pix", "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 }, "key": { "description": "Pix key the brcode pays", "type": "string", "x-struct": null, "x-validate": null }, "key_type": { "description": "Type of the Pix key", "enum": [ "tax_number", "phone", "email", "random_key" ], "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 } }, "required": [ "id", "hash", "key", "key_type", "amount", "amount_editable", "expires_at", "due_date", "counterparty", "inserted_at", "updated_at" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Pix brcode check response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.PixCheck.BrcodeCheckResponse", "x-validate": null }, "V2_stage_of_an_in_document": { "description": "Stage of an in document", "example": { "error_code": null, "error_message": null, "id": "01a11802-3da7-af9b-756c-9522bbd3b87f", "inserted_at": "2026-10-07T20:17:03.475249Z", "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", "kyc", "settled", "failed", "refund_link" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 stage of an in document", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.StageResponse", "x-validate": null }, "V2_card_create_params": { "description": "Card create params", "example": { "display_name": "marketing card", "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "holder_name": "John Doe" }, "properties": { "display_name": { "description": "Display name", "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "ID of the entity that will hold the card", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "holder_name": { "description": "Holder name", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "entity_id", "display_name" ], "title": "V2 card create params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.CreateParams", "x-validate": null }, "V2_Boleto_Response": { "description": "Response for boleto", "example": { "data": { "amount": { "amount": 10000, "currency": "BRL" }, "bank_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "barcode": "12341111222233334444555566667777888899990000", "boleto_url": "https://example.com/boleto_1", "counterparty": { "id": "000a89cb-f0c9-07ce-79c2-fc049bc253e0" }, "description": "description", "digitable_line": "12341111222233334444555566667777888899990000", "due_detail": { "discount": { "fixed_until_due": { "amounts": [ { "amount": { "amount": 300, "currency": "BRL" }, "date": "2026-12-13" }, { "amount": { "amount": 100, "currency": "BRL" }, "date": "2026-12-15" } ], "calculation_type": "amount" } }, "due_date": "2026-12-16", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "amount": { "amount": 10, "currency": "BRL" }, "calculation_type": "daily_rate" } }, "expiration_date": "2026-12-30", "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d", "fee": { "amount": 0, "currency": "BRL" }, "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "inserted_at": "2026-12-01T10:00:00.000000Z", "invoice_type": "invoice", "issue_date": "2026-12-01", "notes": [ "note 1", "note 2", "note 3" ], "status": "confirmed", "updated_at": "2026-12-01T10:00:00.000000Z", "wallet_type": "book_entry_electronic_bloquete" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_Boleto_Response_Params" } }, "title": "V2 Boleto_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.Response", "x-validate": null }, "Check_utility_request_params": { "description": "Check utility request params", "example": { "code": "81620000001482115872026022712600000000001207" }, "properties": { "code": { "description": "Utility barcode or digitable_line", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "code" ], "title": "Check_utility_request_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.Cashout.Utility.UtilitySchema.CheckRequest", "x-validate": null }, "Counterparty_recipient_response": { "example": { "data": { "bank_account": null, "counterparty": { "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "name": "Random", "tax_number": "34842155000197" }, "id": "1fb05245-a185-0ec1-2661-3390353a35e3", "pix_key": "some-pix-key", "ref_type": "pix_key" } }, "properties": { "data": { "$ref": "#/components/schemas/Counterparty_recipient_data" } }, "title": "Counterparty recipient response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.Response", "x-validate": null }, "V2_card_purchase_merchant": { "description": "Merchant where the card was used", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "properties": { "amount": { "description": "Amount charged by the merchant, in cents of the merchant's currency", "nullable": true, "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "ISO 4217 currency code", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "currency" ], "type": "object", "x-struct": null, "x-validate": null }, "country_code": { "description": "Country code", "type": "string", "x-struct": null, "x-validate": null }, "currency_symbol": { "description": "Currency symbol", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "country_code", "currency_symbol", "amount" ], "title": "V2 card purchase merchant", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.Merchant", "x-validate": null }, "V2_list_bank_accounts_response": { "description": "A list bank accounts response", "example": { "data": [ { "balances": { "available": { "amount": 150000, "currency": "BRL" }, "blocked": { "amount": 10000, "currency": "BRL" }, "updated_at": "2026-10-07T12:00:00.000000Z" }, "branch": "0001", "category": "owner", "description": "Conta", "digit": "1", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2024-10-12T00:00:00.000000Z", "limits": { "payments": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "pix": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "ted": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "tef": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } } }, "number": "12345678", "parameters": { "automatic_refund_for_person_dead": false, "automatic_refund_for_person_invalid_tax_number": false, "automatic_refund_for_person_underage": false, "in_block_for_legal_entity": false, "in_block_for_pix_qrcode_different_amount_payment": false, "in_block_for_pix_qrcode_different_counterparty_bank_account": false, "in_block_for_pix_qrcode_different_tax_number": false, "in_block_for_pix_qrcode_duplicated_payment": false, "in_block_for_unauthorized_participant": false, "in_block_for_unidentified_deposit": false, "out_block_for_legal_entity": false, "out_blocked": false }, "status": "approved", "type": "checking", "updated_at": "2024-10-12T00:00:00.000000Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_bank_account" }, "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 bank accounts response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.ListResponse", "x-validate": null }, "Currency": { "description": "Currency", "items": { "enum": [ "BRL" ], "type": "string", "x-struct": null, "x-validate": null }, "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "V2_Org_webhook_list": { "description": "Every webhook of the org, in a single page: the list is not paginated", "example": { "data": [ { "api_version": "v100", "authentication_method": "url_secret", "entity_id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7c", "event_categories_allowed": [ { "category": "boleto", "types": [ "settled", "created" ] } ], "group_id": null, "id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7b", "inserted_at": "2026-10-01T12:00:00.000000Z", "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==", "notification_secret": "some_notification_secret", "notification_url": "https://mynotificationurl.com/endpoint", "updated_at": "2026-10-01T12:00:00.000000Z" } ] }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_Org_webhook" }, "type": "array", "x-struct": null, "x-validate": null } }, "title": "V2 Org webhook list", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.IAM.V2.OrgWebhook.ListResponse", "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_card_amount_params": { "description": "Amount of money to move, in cents", "example": { "amount": 1000, "currency": "BRL" }, "properties": { "amount": { "description": "Amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency", "enum": [ "BRL" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "currency" ], "title": "V2 card amount params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.AmountParams", "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_pledged_advance_requests_list_response": { "description": "A page of pledged advance requests", "example": { "data": [ { "amount": { "amount": 100000, "currency": "BRL" }, "approved_at": null, "assignor": { "bank_account_digit": "2", "bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7c", "bank_account_number": "0023123", "tax_number": "63558804023" }, "bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7b", "canceled_at": null, "charges": [], "contract_file_reference": "pledged/contracts/1_contract.pdf", "description": "Antecipação de recebíveis", "entity_id": "019084f3-ea10-3691-38dc-bda6ac03cb7a", "id": "019084f3-ea10-3691-38dc-bda6ac03cb70", "inserted_at": "2026-09-10T12:00:00.000000Z", "payer": { "tax_number": "80617053000195" }, "pledged_amount": { "amount": 100000, "currency": "BRL" }, "pledged_balance": { "amount": 100000, "currency": "BRL" }, "pledged_by": "payer_tax_number", "rejected_at": null, "status": "created", "updated_at": "2026-09-10T12:00:00.000000Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_pledged_advance_request" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "description": "Pagination of the list", "properties": { "after": { "description": "Cursor of the next page, to send as after", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "before": { "description": "Cursor of the previous page, to send as before", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "has_more": { "description": "Whether there is a next page", "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "V2 pledged advance requests list response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Pledged.AdvanceRequest.ListResponse", "x-validate": null }, "V2_Generate_Boleto_Response": { "description": "The boleto payment requested", "example": { "data": { "out_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" } }, "properties": { "data": { "properties": { "out_document_id": { "description": "ID of the out document created for the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "out_document_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Generate_Boleto_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Boleto.BoletoSchema.GenerateResponse", "x-validate": null }, "V2_RecurrenceCollectionDataWithStages": { "description": "A recurrence collection. `stages` and `attempts` are present only when asked for with `load_stages` / `load_attempts`.", "properties": { "additional_info": { "description": "Additional information sent to the payer", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "amount": { "description": "Collection amount", "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 }, "attempts": { "items": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptEmbeddedData" }, "type": "array", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that receives the collection", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "final_date": { "description": "Last day of the collection", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Collection ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the collection was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "next_working_day": { "description": "Whether a collection on a non-working day moves to the next one", "type": "boolean", "x-struct": null, "x-validate": null }, "recurrence": { "description": "Recurrence the collection belongs to", "properties": { "id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "stages": { "items": { "$ref": "#/components/schemas/V2_RecurrenceCollectionStageData" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Collection status", "enum": [ "created", "active", "settled", "expired", "rejected", "cancelled" ], "type": "string", "x-struct": null, "x-validate": null }, "transaction_date": { "description": "Transaction date", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the collection was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceCollectionDataWithStages", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.DataWithStagesAndAttempts", "x-validate": null }, "V2_Org_webhook": { "description": "A webhook the org receives its events at", "example": { "api_version": "v100", "authentication_method": "url_secret", "entity_id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7c", "event_categories_allowed": [ { "category": "boleto", "types": [ "settled", "created" ] } ], "group_id": null, "id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7b", "inserted_at": "2026-10-01T12:00:00.000000Z", "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==", "notification_secret": "some_notification_secret", "notification_url": "https://mynotificationurl.com/endpoint", "updated_at": "2026-10-01T12:00:00.000000Z" }, "properties": { "api_version": { "description": "Version of the event payloads sent to the webhook", "enum": [ "v100", "v200" ], "type": "string", "x-struct": null, "x-validate": null }, "authentication_method": { "description": "How Trio authenticates to the notification URL", "enum": [ "url_secret", "oauth" ], "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "Entity the webhook is limited to", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "event_categories_allowed": { "description": "Events sent to the webhook. Empty or null sends every event", "items": { "properties": { "category": { "description": "Event category", "type": "string", "x-struct": null, "x-validate": null }, "types": { "description": "Event types of the category. Empty sends every type", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "group_id": { "description": "Group the webhook is limited to", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Webhook ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the webhook was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "notification_key": { "description": "Key Trio signs the events with, generated when the webhook is created", "type": "string", "x-struct": null, "x-validate": null }, "notification_secret": { "description": "Secret sent with every event, for url_secret webhooks", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "notification_url": { "description": "URL the events are sent to", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the webhook was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 Org webhook", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.IAM.V2.OrgWebhook.WebhookData", "x-validate": null }, "V2_RecurrenceData": { "description": "A recurrence, grouped like the request that generates it", "example": { "amounts": { "fixed": { "amount": 10000, "currency": "BRL" }, "maximum": null, "minimum": null }, "authorized_at": null, "bank_account_id": "019f4198-8913-1ec9-52c6-706c618a1c5d", "contract_number": "0001", "counterparty": { "bank_account": { "id": "49521ece-9203-07f7-7767-e32734e5b636" }, "id": "49521ece-9203-186b-cfc7-281c207f7f52" }, "description": "Test Recurrence", "end_date": null, "external_id": null, "first_payment": { "amount": null, "date": "2026-07-10" }, "id": "019f4198-9f53-8f20-a167-5242b634311d", "inserted_at": "2026-07-08T11:59:09.140530Z", "number_of_collections": null, "options": { "automatic_schedule": true, "next_working_day": true, "retry_policy": "none" }, "origin": { "id": "019f4198-9de7-4ba7-d718-5e9fce7cbccb", "type": "api_client" }, "periodicity": "week", "reference": { "id": null, "type": "qrdn" }, "start_date": "2026-07-08", "status": "created", "type": "in", "updated_at": "2026-07-08T11:59:09.140530Z" }, "properties": { "amounts": { "description": "Amounts of the recurrence: `fixed` for fixed amount recurrences, `minimum` (set by the receiver) and `maximum` (set by the payer) for variable ones", "properties": { "fixed": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "maximum": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "minimum": { "$ref": "#/components/schemas/V2_RecurrenceAmount" } }, "type": "object", "x-struct": null, "x-validate": null }, "authorized_at": { "description": "When the payer authorized the recurrence", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that receives the collections", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "contract_number": { "description": "Contract number", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Payer of the recurrence", "properties": { "bank_account": { "description": "Payer bank account", "properties": { "id": { "description": "Counterparty bank account ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "end_date": { "description": "Last day of the recurrence", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "first_payment": { "description": "First payment of the recurrence", "properties": { "amount": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "date": { "description": "Day of the first payment", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the recurrence was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "number_of_collections": { "description": "Number of collections", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "options": { "description": "Recurrence options", "properties": { "automatic_schedule": { "description": "Whether collections are scheduled automatically", "type": "boolean", "x-struct": null, "x-validate": null }, "next_working_day": { "description": "Whether collections falling on a non-working day move to the next one", "type": "boolean", "x-struct": null, "x-validate": null }, "retry_policy": { "$ref": "#/components/schemas/RecurrenceRetryPolicy" } }, "type": "object", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what created the recurrence", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "periodicity": { "$ref": "#/components/schemas/RecurrencePeriodicity" }, "reference": { "description": "What the recurrence was created from", "properties": { "id": { "description": "Reference ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Reference type", "enum": [ "requ", "qrdn", "qres" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "start_date": { "description": "First day of the recurrence", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/RecurrenceStatus" }, "type": { "$ref": "#/components/schemas/RecurrenceType" }, "updated_at": { "description": "When the recurrence was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Data", "x-validate": null }, "V2_pledged_advance_request_charge": { "description": "A charge pledged to the advance request", "example": { "approved_at": null, "canceled_at": null, "charge_id": "019084f3-ea10-3691-38dc-bda6ac03cb80", "inserted_at": "2026-09-10T12:00:00.000000Z", "rejected_at": null, "updated_at": "2026-09-10T12:00:00.000000Z" }, "properties": { "approved_at": { "description": "When the charge was approved for the advance", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "canceled_at": { "description": "When the charge was removed from the advance", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "charge_id": { "description": "Charge ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the charge was pledged", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "rejected_at": { "description": "When the charge was rejected for the advance", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the pledge of the charge was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 pledged advance request charge", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Pledged.AdvanceRequest.Charge", "x-validate": null }, "V2_in_document_ref_type": { "description": "How the in document was initiated", "enum": [ "boleto", "initiation_document", "manual", "pix_automatic", "pix_automatic_qrcode", "pix_automatic_static_qrcode", "pix_key", "pix_payment_qrcode", "pix_qrcode", "pix_static_qrcode" ], "title": "V2 in document ref type", "type": "string", "x-struct": null, "x-validate": null }, "V2_RecurrenceCollectionAttemptListResponse": { "description": "List of recurrence collection attempts", "example": { "data": [ { "collection": { "id": "019809e6-c8ef-843e-28fb-9ade27a8043b" }, "due_date": "2025-07-14", "end_to_end_id": "E33333333202507141500duiiTl1rnpc", "external_id": null, "id": "019809e6-c836-fe49-0b1a-ccd48befb6b8", "inserted_at": "2025-07-14T17:06:16.606122Z", "status": "requested", "transaction_date": null, "updated_at": "2025-07-14T17:06:16.606122Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptData" }, "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 RecurrenceCollectionAttemptListResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Attempt.ListResponse", "x-validate": null }, "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 }, "Counterparty_recipient_bank_account_data": { "example": { "branch": "0001", "digit": "1", "ispb": "12345678", "number": "87654321", "type": "checking" }, "nullable": true, "properties": { "branch": { "description": "Bank account branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Bank account digit", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "Bank account ispb", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Bank account number", "type": "string", "x-struct": null, "x-validate": null }, "type": { "$ref": "#/components/schemas/Counterparty_bank_account_type" } }, "title": "Counterparty recipient bank account data", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.BankAccountData", "x-validate": null }, "V2_Check_Utility_Response": { "description": "A utility bill checked before it is paid", "example": { "data": { "amount": { "amount": 55415, "currency": "BRL" }, "barcode": "81630000005541525242026031611000003743561145", "counterparty": { "name": "PM MANAUS", "tax_number": "00000001000136" }, "digitable_line": "816300000055541525242023603161100004037435611456", "id": "019cd95f-4169-924a-eda6-438fe041bff8", "inserted_at": "2026-03-10T20:10:24.499784Z", "payer": { "name": "PM MANAUS", "tax_number": "00000001000136" }, "type": "utility", "updated_at": "2026-03-10T20:10:24.499784Z" } }, "properties": { "data": { "properties": { "amount": { "description": "Utility bill amount", "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 }, "payer": { "description": "Payer the utility bill 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 }, "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_Utility_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Utility.UtilitySchema.CheckResponse", "x-validate": null }, "V2_BoletoDueDetail": { "description": "Due detail of a boleto. `due_date` is always present; each rule only when set. A rule has `amount` (money) for an amount calculation type and `value` (basis points, 100 = 1%) for a percentage one.", "example": { "discount": { "fixed_until_due": { "amounts": [ { "amount": { "amount": 300, "currency": "BRL" }, "date": "2026-12-13" }, { "amount": { "amount": 100, "currency": "BRL" }, "date": "2026-12-15" } ], "calculation_type": "amount" } }, "due_date": "2026-12-16", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "amount": { "amount": 10, "currency": "BRL" }, "calculation_type": "daily_rate" } }, "properties": { "discount": { "description": "Discount for payments before the due date; only one option is set", "properties": { "fixed_until_due": { "description": "Discount granted until each date", "properties": { "amounts": { "items": { "properties": { "amount": { "description": "Amount, for an amount calculation type", "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 }, "date": { "description": "Last date on which the discount applies", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "calculation_type": { "enum": [ "amount", "percentage" ], "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "per_day_antecipated": { "description": "Discount per day paid in advance", "properties": { "amount": { "description": "Amount, for an amount calculation type", "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 }, "calculation_days": { "enum": [ "calendar", "working" ], "type": "string", "x-struct": null, "x-validate": null }, "calculation_type": { "enum": [ "amount", "percentage" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date of the boleto", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "fine": { "description": "Fine charged after the due date", "properties": { "amount": { "description": "Amount, for an amount calculation type", "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 }, "calculation_type": { "enum": [ "amount", "percentage" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "interest": { "description": "Interest charged after the due date", "properties": { "amount": { "description": "Amount, for an amount calculation type", "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 }, "calculation_type": { "enum": [ "daily_rate", "monthly_fee", "exempt", "bank_control" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "due_date" ], "title": "V2 BoletoDueDetail", "type": "object", "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_entity": { "description": "An entity for compliance", "example": { "addresses": [ { "address_additional_details": "Apto 42", "address_line": "Rua das Flores", "address_number": "123", "city_name": "Curitiba", "district": "Centro", "zip_code": "80000000" } ], "business_infos": { "annual_revenue": { "amount": 500000, "currency": "BRL" }, "average_ticket": { "amount": 10000000, "currency": "BRL" }, "company_activity": "6201501", "company_secondary_activity": [ "6202300" ] }, "contact": { "email": "entity@gmail.com", "phone_number": "41999999999" }, "id": "01a163ec-8dd5-8386-b33a-70a4713ecdb2", "inserted_at": "2026-10-22T14:03:29.651178Z", "legal_name": "Entity Test LLC", "status": "approved", "tax_number": "DN0O5N510HG833", "updated_at": "2026-10-22T14:03:29.651187Z" }, "properties": { "addresses": { "items": { "$ref": "#/components/schemas/V2_entity_address" }, "type": "array", "x-struct": null, "x-validate": null }, "business_infos": { "$ref": "#/components/schemas/V2_entity_business_information" }, "contact": { "$ref": "#/components/schemas/V2_entity_contact" }, "id": { "$ref": "#/components/schemas/UUID" }, "inserted_at": { "description": "Entity inserted at", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "legal_name": { "description": "Entity legal name", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Entity status", "enum": [ "created", "in_validation", "in_review", "approved", "rejected", "onhold", "canceled" ], "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Entity tax number", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Entity updated at", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 entity", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityData", "x-validate": null }, "V2_Generate_Utility": { "description": "Body params to generate a utility payment", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "check_id": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Magna dolor velit duis velit ad elit anim laborum aliqua.", "external_id": "10760495-cb95-4023-96e9-0cff5776b011" }, "properties": { "amount": { "description": "Amount of the utility in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "check_id": { "$ref": "#/components/schemas/UUID" }, "description": { "description": "Description for the utility", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID for reference", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "check_id", "bank_account_id" ], "title": "V2 Generate_Utility", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Utility.UtilitySchema.GenerateRequest", "x-validate": null }, "UpdateParametersParams": { "description": "Updates an account parameters params", "example": { "automatic_refund_for_person_dead": false, "automatic_refund_for_person_invalid_tax_number": false, "automatic_refund_for_person_underage": false, "in_block_for_legal_entity": true, "in_block_for_pix_qrcode_different_amount_payment": true, "in_block_for_pix_qrcode_different_counterparty_bank_account": false, "in_block_for_pix_qrcode_different_tax_number": true, "in_block_for_pix_qrcode_duplicated_payment": true, "in_block_for_unauthorized_participant": false, "in_block_for_unidentified_deposit": true, "out_block_for_legal_entity": true, "out_blocked": true }, "properties": { "automatic_refund_for_person_dead": { "description": "Automatic refund for deceased individuals", "type": "boolean", "x-struct": null, "x-validate": null }, "automatic_refund_for_person_invalid_tax_number": { "description": "Automatic refund for invalid tax number", "type": "boolean", "x-struct": null, "x-validate": null }, "automatic_refund_for_person_underage": { "description": "Automatic refund for underage", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_legal_entity": { "description": "In block for legal entity origin", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_different_amount_payment": { "description": "In block for qrcode different amount payment", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_different_counterparty_bank_account": { "description": "In block for qrcode different counterparty bank account", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_different_tax_number": { "description": "In block for qrcode different tax number", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_duplicated_payment": { "description": "In block for qrcode duplicated payment", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_unauthorized_participant": { "description": "In block for unauthorized participant", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_unidentified_deposit": { "description": "In block for unidentified deposit", "type": "boolean", "x-struct": null, "x-validate": null }, "out_block_for_legal_entity": { "description": "Out block for legal entity destination", "type": "boolean", "x-struct": null, "x-validate": null }, "out_blocked": { "description": "Out blocked", "type": "boolean", "x-struct": null, "x-validate": null } }, "title": "UpdateParametersParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.VirtualAccount.UpdateParametersParams", "x-validate": null }, "V2_Create_bank_account_params": { "description": "Creates a bank account params", "example": { "description": "description 1", "group_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb888" }, "properties": { "description": { "description": "Description", "type": "string", "x-struct": null, "x-validate": null }, "group_id": { "description": "ID of the group the bank account is created in", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "group_id", "description" ], "title": "V2 Create bank account params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.CreateParams", "x-validate": null }, "UUID": { "description": "Unique identifier", "format": "uuid", "title": "UUID", "type": "string", "x-struct": null, "x-validate": null }, "V2_created_in_document_refund": { "description": "Refund requested for an in document. trio-spi creates it asynchronously; read it back through `GET /v2/documents/in/refunds/{id}` for its details and final state.", "example": { "in_refund_id": "01a12175-3994-6649-4e0b-f645e45459ea" }, "properties": { "in_refund_id": { "description": "ID of the in refund, read through `GET /v2/documents/in/refunds/{id}`", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 created in document refund", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.CreatedRefundData", "x-validate": null }, "V2_Org_webhook_creation_parameters": { "description": "Webhook to create. A url_secret webhook needs notification_url and notification_secret; an oauth webhook needs oauth_client_id, oauth_client_secret, oauth_url and oauth_scope.", "example": { "authentication_method": "url_secret", "entity_id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7c", "event_categories_allowed": [ { "category": "boleto", "types": [ "settled", "created" ] } ], "notification_secret": "some_notification_secret", "notification_url": "https://mynotificationurl.com/endpoint" }, "properties": { "api_version": { "description": "Version of the event payloads sent to the webhook. Defaults to v100", "enum": [ "v100", "v200" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "authentication_method": { "description": "How Trio authenticates to the notification URL", "enum": [ "url_secret", "oauth" ], "type": "string", "x-struct": null, "x-validate": null }, "entity_id": { "description": "Entity to limit the webhook to", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "event_categories_allowed": { "description": "Events to send to the webhook. Empty or null sends every event", "items": { "properties": { "category": { "description": "Event category", "type": "string", "x-struct": null, "x-validate": null }, "types": { "description": "Event types of the category. Empty sends every type", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "category", "types" ], "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "group_id": { "description": "Group of the entity to limit the webhook to", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "notification_secret": { "description": "Secret sent with every event, for url_secret webhooks", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "notification_url": { "description": "URL the events are sent to", "type": "string", "x-struct": null, "x-validate": null }, "oauth_client_id": { "description": "OAuth client ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "oauth_client_secret": { "description": "OAuth client secret", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "oauth_scope": { "description": "OAuth scope", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "oauth_url": { "description": "OAuth token URL", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "notification_url", "authentication_method" ], "title": "V2 Org webhook creation parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.IAM.V2.OrgWebhook.CreationParameters", "x-validate": null }, "V2_bank_account_status": { "description": "Status of the bank account", "enum": [ "created", "approved", "onhold", "canceled", "closed" ], "title": "V2 bank account status", "type": "string", "x-struct": null, "x-validate": null }, "V2_static_QRCode_image_response": { "description": "Image of a static QRCode, rendered from its hash. `image` is null when the image could not be rendered.", "example": { "data": { "image": "iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4CAYAAAA5ZDbSAAAAAXNSR0IArs4c6QAA" } }, "properties": { "data": { "properties": { "image": { "description": "QRCode image in base64, 120x120; null when it could not be rendered", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "image" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 static QRCode image response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.StaticBrcode.ImageResponse", "x-validate": null }, "DynamicBrcodeDueDetailInterestCalculationPeriod": { "description": "Interest calculation period of dynamic brcode with due detail", "enum": [ "day", "month", "year" ], "nullable": true, "title": "DynamicBrcodeDueDetailInterestCalculationPeriod", "type": "string", "x-struct": null, "x-validate": null }, "V2_card_response": { "description": "The card created", "example": { "data": { "display_name": "marketing card", "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "id": "019514eb-5d5c-b395-5a77-449d12701ce7", "masked_number": "•••• •••• •••• 1234", "status": "active", "type": "virtual" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_card" } }, "required": [ "data" ], "title": "V2 card response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Response", "x-validate": null }, "V2_in_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 in refund document stage response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Refund.StageResponse", "x-validate": null }, "DynamicBrcodeDueDetailDiscountCalculationDays": { "description": "Discount calculation days of dynamic brcode with due detail", "enum": [ "calendar", "working" ], "nullable": true, "title": "DynamicBrcodeDueDetailDiscountCalculationDays", "type": "string", "x-struct": null, "x-validate": null }, "V2_Pix_Key_create_payload": { "description": "Body payload to create a Pix Key", "example": { "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb333", "key": "12345678900" }, "properties": { "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "key": { "description": "Key", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "bank_account_id" ], "title": "V2 Pix Key create payload", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.CreateParams", "x-validate": null }, "V2_DynamicQRCodeWithDueResponse": { "description": "Response schema for a single dynamic QRCode with due date", "example": { "data": { "amount": { "amount": 1000, "currency": "BRL" }, "bank_account_id": "01a0d98d-7547-22cf-f4f6-e8a63cd72cf5", "counterparty": { "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" }, "description": "description", "due_detail": { "due_date": "2026-09-30", "fine": { "calculation_type": "percentage", "value": 200 } }, "expiration_datetime": "2026-10-06T02:59:59.999999Z", "external_id": "external_id", "fee": { "amount": 0, "currency": "BRL" }, "hash": "00020101021226640014br.gov.bcb.pix2542qrcode.trio.com.br/cobv/01M3CRTXYFDDFTA8MF4XH2183B5204000053039865802BR5909NAME TEST6009NAME TEST62070503***63042C42", "id": "01a0d98d-77cf-6b5f-a522-8f276220a06b", "inserted_at": "2026-09-25T17:12:02.255000Z", "options": { "allow_change_the_amount_on_payment": true }, "origin": { "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "type": "none" }, "status": "created", "updated_at": "2026-09-25T17:12:02.255000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_DynamicQRCodeWithDueData" } }, "title": "V2 DynamicQRCodeWithDueResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcodeWithDue.Response", "x-validate": null }, "V2_counterparty_bank_account_list_response": { "description": "Counterparty bank accounts", "example": { "data": [ { "branch": "0001", "digit": "1", "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "12345678", "number": "87654321", "type": "checking", "updated_at": "2024-10-17T13:32:59.374149Z" } ] }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_counterparty_bank_account" }, "type": "array", "x-struct": null, "x-validate": null } }, "title": "V2 counterparty bank account list response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.BankAccount.ListResponse", "x-validate": null }, "V2_Pix_brcode_check_params": { "description": "Body params to check a Pix brcode (QR code) before paying it", "example": { "entity_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "hash": "00020101021226630014br.gov.bcb.pix2541pix.example.com/cob/01JM0B0TY9BT4375S074Q00E0M5204000053039865802BR5908John Doe6009Sao Paulo62070503***6304F3A0" }, "properties": { "entity_id": { "description": "Entity that will pay the Pix", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "hash": { "description": "Pix copy and paste code of the brcode", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "entity_id", "hash" ], "title": "V2 Pix brcode check params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.PixCheck.BrcodeCheckParams", "x-validate": null }, "V2_list_transfer_documents_response": { "description": "A list of transfer documents response", "example": { "data": [ { "amount": { "amount": 1, "currency": "BRL" }, "description": "Transferência interna", "external_id": "01M4H104PKKZ0CGC013Y8FE4G2", "from_bank_account_id": "019ddfe9-e64b-b642-36fd-efdaef77d05e", "id": "01a12210-33a8-ae95-5333-213dfa0bda47", "inserted_at": "2026-10-09T19:07:29.576442Z", "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "reconciliation_id": "01a12210-33a8-2e7e-1d38-9e7eb34e6946", "stages": [ { "error_code": null, "error_message": null, "id": "01a12210-33a8-5cca-32f5-c8662a1e8c40", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a12210-33a8-b520-e507-7f570c825c11", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "settled" } ], "status": "settled", "to_bank_account_id": "01a1220f-79cc-5e5d-4342-b78b9dacd592", "transaction_date": "2026-10-09T19:07:29.778267Z", "updated_at": "2026-10-09T19:07:29.778267Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_transfer_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 transfer documents response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Transfer.ListResponse", "x-validate": null }, "V2_bank_account_balance_response": { "description": "Bank account balance, current balances and limits", "example": { "data": { "available_balance": { "amount": 150000, "currency": "BRL" }, "balances": { "available": { "amount": 150000, "currency": "BRL" }, "blocked": { "amount": 10000, "currency": "BRL" }, "updated_at": "2026-10-07T12:00:00.000000Z" }, "limits": { "payments": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "pix": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "ted": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "tef": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } } } } }, "properties": { "data": { "properties": { "available_balance": { "description": "Available balance at the requested datetime", "properties": { "amount": { "description": "Amount integer (in cents)", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Amount currency", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "balances": { "$ref": "#/components/schemas/V2_bank_account_balances" }, "limits": { "$ref": "#/components/schemas/V2_bank_account_limits_by_transaction_type" } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "V2 bank account balance response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.BalanceResponse", "x-validate": null }, "V2_onboarding_document_upload_response": { "description": "The onboarding document uploaded", "example": { "data": { "document_type": "financial_statement", "id": "01a0ee9f-4ff4-e363-41fe-8ced18a18eef", "inserted_at": "2026-09-29T19:23:33.236814Z", "reference_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f", "reference_type": "entity", "updated_at": "2026-09-29T19:23:33.236814Z" } }, "properties": { "data": { "properties": { "document_type": { "description": "Document type", "enum": [ "power_of_attorney", "financial_statement", "identification", "company_contract" ], "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Document ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the document was uploaded", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "reference_id": { "description": "The entity or representative the document belongs to", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "reference_type": { "description": "Whether the document is the entity's or a representative's", "enum": [ "entity", "entity_representative" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the document was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "reference_type", "reference_id", "document_type", "inserted_at", "updated_at" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 onboarding document upload response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.V2.Document.UploadDocumentResponse", "x-validate": null }, "V2_DynamicQRCodeWithDueCreateParams": { "description": "Body params to create a dynamic QRCode with due date", "example": { "amount": 1000, "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "counterparty": { "info": { "address": "Rua Exemplo, 123", "city": "Curitiba", "email": "counterparty@mail.com", "postal_code": "80000000", "state": "PR" }, "name": "counterparty_name", "tax_number": "12345678900" }, "description": "description", "due_detail": { "due_date": "2026-10-27", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "calculation_days": "calendar", "calculation_period": "month", "calculation_type": "percentage", "value": 100 } }, "expiration_days": 30, "external_id": "external_id", "options": { "allow_change_the_amount_on_payment": false, "show_qrcode_image": true } }, "properties": { "amount": { "description": "Amount value of the dynamic QRCode", "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank Account ID", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Counterparty (payer) information. Required for QRCodes with due date", "properties": { "info": { "$ref": "#/components/schemas/DynamicQRCodeWithDueCounterpartyInfo" }, "name": { "description": "Counterparty name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Counterparty tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the dynamic QRCode", "type": "string", "x-struct": null, "x-validate": null }, "due_detail": { "$ref": "#/components/schemas/V2_PixDueDetailParams" }, "expiration_days": { "description": "Number of days after the due date during which the QRCode can still be paid. Defaults to 1", "minimum": 0, "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the dynamic QRCode", "type": "string", "x-struct": null, "x-validate": null }, "merchant": { "description": "Merchant to register as the split org merchant. When sent, it is saved.", "nullable": true, "properties": { "name": { "description": "Merchant name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Merchant tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "options": { "description": "QRCode creation options", "properties": { "allow_change_the_amount_on_payment": { "description": "Allow amount change", "type": "boolean", "x-struct": null, "x-validate": null }, "show_qrcode_image": { "description": "Show qrcode image", "type": "boolean", "x-struct": null, "x-validate": null } }, "required": [ "allow_change_the_amount_on_payment", "show_qrcode_image" ], "type": "object", "x-struct": null, "x-validate": null }, "platform_id": { "description": "Platform ID of the dynamic QRCode", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "splits": { "description": "Cashin split configurations", "items": { "properties": { "counterparty_recipient_id": { "description": "Counterparty recipient UUID", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Split type", "enum": [ "percentage", "fixed" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage (0-100) or fixed amount in cents", "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "type", "value", "counterparty_recipient_id" ], "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "amount", "counterparty", "due_detail", "options", "bank_account_id" ], "title": "V2 DynamicQRCodeWithDueCreateParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcodeWithDue.CreateParams", "x-validate": null }, "V2_card_update_params": { "description": "Card update params", "example": { "display_name": "New marketing card" }, "properties": { "display_name": { "description": "Display name", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "display_name" ], "title": "V2 card update params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.UpdateParams", "x-validate": null }, "V2_bank_account_transaction": { "description": "A transaction of a bank account.", "example": { "amount": { "amount": 10, "currency": "BRL" }, "bank_account_id": "0190df9a-d08e-9574-c79c-9aa0f40ee330", "counterparty": { "bank_account_id": "0190df9a-d1b1-efb3-7521-55db2415f319", "id": "0191148f-b189-8e42-27a5-1368cc00dea8", "name": "John Doe", "tax_number": "11122233344" }, "document_type": "pix", "end_to_end_id": "E44444444202405211946Dwg1pjxgehP", "external_id": "external_id", "inserted_at": "2024-07-21T12:00:01.000000Z", "posting_type": "credit", "reconciliation_id": "018f3406-9e00-1766-05c4-4907e14ee511", "ref_id": "0190df9a-d1b1-6bfe-ad26-037579ad8588", "ref_type": "in_document", "transaction_date": "2024-07-21T12:00:01.000000Z", "transaction_type": "regular", "updated_at": "2024-07-21T12:00:01.000000Z" }, "properties": { "amount": { "description": "Amount", "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Amount currency", "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 transaction, all null when it has none", "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", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "document_type": { "description": "Kind of operation", "enum": [ "pix", "boleto", "ted", "tef", "utility", "tax", "internal", "card", "pix_internal", "pix_automatic", "pix_initiation", "receivable", "pix_boleto" ], "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 }, "inserted_at": { "description": "Creation date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "posting_type": { "description": "Whether the transaction takes money out of or into the account", "enum": [ "debit", "credit" ], "type": "string", "x-struct": null, "x-validate": null }, "reconciliation_id": { "description": "Reconciliation ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "ref_id": { "description": "ID of the referenced resource", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "ref_type": { "description": "Resource `ref_id` points to: `in_document` and `out_document` are read through `/v2/documents/in` and `/v2/documents/out`, `in_refund` and `out_refund` through their `/refunds`, `transfer` through `/v2/documents/transfer`", "enum": [ "in_document", "out_document", "in_refund", "out_refund", "transfer", "block_med", "release_block_med", "purchase", "fee", "ledger_batch", "remuneration", "cashback", "judicial_block", "cash_integration", "boleto", "receivable" ], "type": "string", "x-struct": null, "x-validate": null }, "transaction_date": { "description": "Transaction date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "transaction_type": { "description": "Transaction type", "enum": [ "regular", "tax", "fee", "indirect_fee", "direct_fee", "specific" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Last update date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 bank account transaction", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Transaction.TransactionData", "x-validate": null }, "V2_Boleto_update_params": { "description": "Body params to change the due date of a boleto. To change its amount, recreate it.", "example": { "due_detail": { "due_date": "2026-12-16" } }, "properties": { "due_detail": { "properties": { "due_date": { "description": "New due date of the boleto", "format": "date", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "due_date" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "due_detail" ], "title": "V2 Boleto_update_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.UpdateRequest", "x-validate": null }, "V2_Generate_Tax_Response": { "description": "The tax bill payment requested", "example": { "data": { "out_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" } }, "properties": { "data": { "properties": { "out_document_id": { "description": "ID of the out document created for the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "out_document_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Generate_Tax_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Tax.TaxSchema.GenerateResponse", "x-validate": null }, "V2_Generate_Darf_Response": { "description": "The DARF payment requested", "example": { "data": { "out_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" } }, "properties": { "data": { "properties": { "out_document_id": { "description": "ID of the out document created for the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "out_document_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Generate_Darf_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Darf.DarfSchema.GenerateResponse", "x-validate": null }, "V2_card_purchase": { "description": "A purchase made with a card", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-e630-609a-18a0447ee30b", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchased_at": "2025-06-11T14:06:10.430838Z", "purpose": "purchase", "receipt_url": "https://receipt.example.com/purchase/0192f790-170e-e630-609a-18a0447ee30b", "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_money" }, "card_id": { "description": "Card ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "category_code": { "description": "Category code", "type": "string", "x-struct": null, "x-validate": null }, "category_type": { "description": "Category type", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "end_to_end_id": { "$ref": "#/components/schemas/V2_card_purchase_end_to_end_id" }, "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "error_code": { "description": "Why the purchase was declined, as a code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Why the purchase was declined", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Purchase ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the purchase was recorded", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "is_partially_allowed": { "description": "Is partially allowed", "type": "boolean", "x-struct": null, "x-validate": null }, "issuer_amount": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "merchant": { "$ref": "#/components/schemas/V2_card_purchase_merchant" }, "method_code": { "$ref": "#/components/schemas/V2_card_purchase_method_code" }, "purchased_at": { "description": "When the card network authorized the purchase. `GET /v2/cards/purchases/e2e/{id}` takes it as `timestamp`.", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "purpose": { "description": "Purpose", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "receipt_url": { "description": "Receipt URL", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/V2_card_purchase_status" }, "tax": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "updated_at": { "description": "When the purchase was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "zip_code": { "description": "Zip code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 card purchase", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.Data", "x-validate": null }, "V2_Check_Darf_Response": { "description": "A DARF checked before it is paid. A DARF is always paid to Receita Federal, so it has a taxpayer and no beneficiary.", "example": { "data": { "accumulated_revenue_amount": { "amount": 0, "currency": "BRL" }, "amount": { "amount": 13208, "currency": "BRL" }, "assessment_date": "2022-11-04", "authentication_date": "2022-11-04", "due_date": "2022-11-04", "federal_revenue_id": "473", "fine_amount": { "amount": 1001, "currency": "BRL" }, "id": "019cdabf-5a3e-7c21-9f10-2b6d8e4c1a77", "inserted_at": "2026-03-11T02:34:58.120000Z", "interest_amount": { "amount": 1001, "currency": "BRL" }, "percentage": 0, "reference_number": null, "taxpayer": { "name": "John Doe", "tax_number": "***982247**" }, "type": "darf", "updated_at": "2026-03-11T02:34:58.120000Z" } }, "properties": { "data": { "properties": { "accumulated_revenue_amount": { "description": "Accumulated revenue amount", "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 }, "amount": { "description": "DARF principal amount", "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 }, "assessment_date": { "description": "Assessment period (período de apuração)", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "authentication_date": { "description": "Authentication date", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "federal_revenue_id": { "description": "Revenue code (código da receita)", "type": "string", "x-struct": null, "x-validate": null }, "fine_amount": { "description": "Fine amount", "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 }, "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 }, "interest_amount": { "description": "Interest amount", "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 }, "percentage": { "description": "Percentage", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "reference_number": { "description": "Reference number", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "taxpayer": { "description": "Taxpayer the DARF belongs 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 }, "type": { "description": "Payment type", "enum": [ "darf" ], "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_Darf_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Darf.DarfSchema.CheckResponse", "x-validate": null }, "DATETIME": { "description": "Datetime schema", "format": "date-time", "title": "DATETIME", "type": "string", "x-struct": null, "x-validate": null }, "V2_RecurrenceAmount": { "description": "An amount in cents", "example": { "amount": 10000, "currency": "BRL" }, "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 } }, "title": "V2 RecurrenceAmount", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount", "x-validate": null }, "V2_card_purchase_with_stages": { "description": "A purchase made with a card, with the callbacks recorded for it", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-e630-609a-18a0447ee30b", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchased_at": "2025-06-11T14:06:10.430838Z", "purpose": "purchase", "receipt_url": "https://receipt.example.com/purchase/0192f790-170e-e630-609a-18a0447ee30b", "stages": [ { "amount": { "amount": 10000, "currency": "BRL" }, "callback_amount": { "amount": 10000, "currency": "BRL" }, "callback_type": "confirmed", "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-1639-9f94-b0296ef109c2", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchase_document_id": "0192f790-170e-e630-609a-18a0447ee30b", "purpose": "purchase", "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null } ], "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_money" }, "card_id": { "description": "Card ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "category_code": { "description": "Category code", "type": "string", "x-struct": null, "x-validate": null }, "category_type": { "description": "Category type", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "end_to_end_id": { "$ref": "#/components/schemas/V2_card_purchase_end_to_end_id" }, "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "error_code": { "description": "Why the purchase was declined, as a code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Why the purchase was declined", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Purchase ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the purchase was recorded", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "is_partially_allowed": { "description": "Is partially allowed", "type": "boolean", "x-struct": null, "x-validate": null }, "issuer_amount": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "merchant": { "$ref": "#/components/schemas/V2_card_purchase_merchant" }, "method_code": { "$ref": "#/components/schemas/V2_card_purchase_method_code" }, "purchased_at": { "description": "When the card network authorized the purchase. `GET /v2/cards/purchases/e2e/{id}` takes it as `timestamp`.", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "purpose": { "description": "Purpose", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "receipt_url": { "description": "Receipt URL", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "stages": { "description": "Callbacks recorded for the purchase, newest first", "items": { "$ref": "#/components/schemas/V2_card_purchase_stage" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/V2_card_purchase_status" }, "tax": { "$ref": "#/components/schemas/V2_card_nullable_money" }, "updated_at": { "description": "When the purchase was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "zip_code": { "description": "Zip code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 card purchase with stages", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.DataWithStages", "x-validate": null }, "V2_institution": { "description": "A financial institution", "example": { "authorized": true, "display_name": "001 - 000000001 - Nome do Banco Ltda", "full_name": "Nome do Banco Ltda", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "00000001", "name": "Nome do Banco", "number": "001", "updated_at": "2024-10-17T13:32:59.374149Z" }, "properties": { "authorized": { "description": "Authorized institution?", "type": "boolean", "x-struct": null, "x-validate": null }, "display_name": { "description": "Institution display name", "type": "string", "x-struct": null, "x-validate": null }, "full_name": { "description": "Institution full name", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Institution ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "Creation date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "Institution ISPB", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Institution name", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Institution bank number", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Last update date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 institution", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Institution.InstitutionData", "x-validate": null }, "V2_transfer_document_response": { "description": "Transfer document response", "example": { "data": { "amount": { "amount": 1, "currency": "BRL" }, "description": "Transferência interna", "external_id": "01M4H104PKKZ0CGC013Y8FE4G2", "from_bank_account_id": "019ddfe9-e64b-b642-36fd-efdaef77d05e", "id": "01a12210-33a8-ae95-5333-213dfa0bda47", "inserted_at": "2026-10-09T19:07:29.576442Z", "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "reconciliation_id": "01a12210-33a8-2e7e-1d38-9e7eb34e6946", "stages": [ { "error_code": null, "error_message": null, "id": "01a12210-33a8-5cca-32f5-c8662a1e8c40", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a12210-33a8-b520-e507-7f570c825c11", "inserted_at": "2026-10-09T19:07:29.576442Z", "status": "settled" } ], "status": "settled", "to_bank_account_id": "01a1220f-79cc-5e5d-4342-b78b9dacd592", "transaction_date": "2026-10-09T19:07:29.778267Z", "updated_at": "2026-10-09T19:07:29.778267Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_transfer_document" } }, "title": "V2 transfer document response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Transfer.Response", "x-validate": null }, "V2_list_institutions_response": { "description": "List of financial institutions", "example": { "data": [ { "authorized": true, "display_name": "001 - 000000001 - Nome do Banco Ltda", "full_name": "Nome do Banco Ltda", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "00000001", "name": "Nome do Banco", "number": "001", "updated_at": "2024-10-17T13:32:59.374149Z" } ] }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_institution" }, "type": "array", "x-struct": null, "x-validate": null } }, "title": "V2 list institutions response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Institution.ListResponse", "x-validate": null }, "V2_bank_account_balances": { "description": "Bank account balances at the time of the request. Null in the response of the creation, which loads none.", "example": { "available": { "amount": 150000, "currency": "BRL" }, "blocked": { "amount": 10000, "currency": "BRL" }, "updated_at": "2026-10-07T12:00:00.000000Z" }, "nullable": true, "properties": { "available": { "$ref": "#/components/schemas/V2_bank_account_amount" }, "blocked": { "$ref": "#/components/schemas/V2_bank_account_amount" }, "updated_at": { "description": "Date and time the balances were fetched", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 bank account balances", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Balances", "x-validate": null }, "V2_Boleto_Response_Params": { "description": "A boleto", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "bank_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "barcode": "12341111222233334444555566667777888899990000", "boleto_url": "https://example.com/boleto_1", "counterparty": { "id": "000a89cb-f0c9-07ce-79c2-fc049bc253e0" }, "description": "description", "digitable_line": "12341111222233334444555566667777888899990000", "due_detail": { "discount": { "fixed_until_due": { "amounts": [ { "amount": { "amount": 300, "currency": "BRL" }, "date": "2026-12-13" }, { "amount": { "amount": 100, "currency": "BRL" }, "date": "2026-12-15" } ], "calculation_type": "amount" } }, "due_date": "2026-12-16", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "amount": { "amount": 10, "currency": "BRL" }, "calculation_type": "daily_rate" } }, "expiration_date": "2026-12-30", "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d", "fee": { "amount": 0, "currency": "BRL" }, "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "inserted_at": "2026-12-01T10:00:00.000000Z", "invoice_type": "invoice", "issue_date": "2026-12-01", "notes": [ "note 1", "note 2", "note 3" ], "status": "confirmed", "updated_at": "2026-12-01T10:00:00.000000Z", "wallet_type": "book_entry_electronic_bloquete" }, "properties": { "amount": { "description": "Amount of the boleto", "properties": { "amount": { "description": "Amount in cents", "minimum": 1, "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 }, "bank_account_id": { "description": "Bank account that receives the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "barcode": { "description": "Barcode of the boleto", "type": "string", "x-struct": null, "x-validate": null }, "boleto_url": { "description": "URL of the boleto", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Payer the boleto is issued to", "properties": { "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boleto", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "digitable_line": { "description": "Digitable line of the boleto", "type": "string", "x-struct": null, "x-validate": null }, "due_detail": { "$ref": "#/components/schemas/V2_BoletoDueDetail" }, "expiration_date": { "description": "Last day on which the boleto can be paid", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the boleto", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee charged on the payment", "nullable": true, "properties": { "amount": { "description": "Fee 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 }, "id": { "description": "ID of the boleto", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the boleto was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "invoice_type": { "$ref": "#/components/schemas/Boleto_invoice_type" }, "issue_date": { "description": "Day the boleto was issued", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/Boleto_Status" }, "updated_at": { "description": "When the boleto was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "wallet_type": { "$ref": "#/components/schemas/Boleto_wallet_type" } }, "title": "V2 Boleto_Response_Params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.ResponseParams", "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_Check_Darf_Request": { "description": "The DARF to check, as the check response publishes it. A DARF is always paid to Receita Federal, so it has a taxpayer and no beneficiary.", "example": { "accumulated_revenue_amount": { "amount": 0, "currency": "BRL" }, "amount": { "amount": 13208, "currency": "BRL" }, "assessment_date": "2026-01-01", "authentication_date": "2026-01-30", "due_date": "2026-01-30", "federal_revenue_id": "473", "fine_amount": { "amount": 1001, "currency": "BRL" }, "interest_amount": { "amount": 1001, "currency": "BRL" }, "percentage": 0, "phone": "+5541999381724", "reference_number": null, "taxpayer": { "name": "John Doe", "tax_number": "52998224725" } }, "properties": { "accumulated_revenue_amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "assessment_date": { "description": "Assessment period (período de apuração)", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "authentication_date": { "description": "Authentication date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "federal_revenue_id": { "description": "Revenue code (código da receita)", "type": "string", "x-struct": null, "x-validate": null }, "fine_amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "interest_amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "percentage": { "description": "Percentage", "type": "integer", "x-struct": null, "x-validate": null }, "phone": { "description": "Taxpayer phone number", "type": "string", "x-struct": null, "x-validate": null }, "reference_number": { "description": "Reference number", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "taxpayer": { "description": "Taxpayer the DARF belongs to", "properties": { "name": { "description": "Name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF or CNPJ", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "taxpayer", "federal_revenue_id", "amount", "fine_amount", "interest_amount", "accumulated_revenue_amount", "percentage", "assessment_date", "due_date", "authentication_date", "phone" ], "title": "V2 Check_Darf_Request", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Darf.DarfSchema.CheckRequest", "x-validate": null }, "V2_RecurrenceCollectionData": { "description": "A recurrence collection", "example": { "additional_info": null, "amount": { "amount": 100, "currency": "BRL" }, "bank_account_id": "019a0d9e-d21f-32d2-7b68-d4e55e72e528", "final_date": null, "id": "019a0d9e-d21f-0bf6-36be-abb0e6be5792", "inserted_at": "2025-10-22T20:31:43.647903Z", "next_working_day": false, "recurrence": { "id": "019a0d9e-d161-cd70-e9bd-f90cf4b50e33" }, "status": "active", "transaction_date": null, "updated_at": "2025-10-22T20:31:46.843629Z" }, "properties": { "additional_info": { "description": "Additional information sent to the payer", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "amount": { "description": "Collection amount", "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 }, "bank_account_id": { "description": "Bank account that receives the collection", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "final_date": { "description": "Last day of the collection", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Collection ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the collection was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "next_working_day": { "description": "Whether a collection on a non-working day moves to the next one", "type": "boolean", "x-struct": null, "x-validate": null }, "recurrence": { "description": "Recurrence the collection belongs to", "properties": { "id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "status": { "description": "Collection status", "enum": [ "created", "active", "settled", "expired", "rejected", "cancelled" ], "type": "string", "x-struct": null, "x-validate": null }, "transaction_date": { "description": "Transaction date", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the collection was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceCollectionData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Data", "x-validate": null }, "V2_GenerateRecurrenceResponse": { "description": "The created recurrence, plus the QRCode the payer authorizes it through (null when the journey has none)", "example": { "data": { "amounts": { "fixed": { "amount": 10000, "currency": "BRL" }, "maximum": null, "minimum": null }, "authorized_at": null, "bank_account_id": "019f4198-8913-1ec9-52c6-706c618a1c5d", "contract_number": "0001", "counterparty": { "bank_account": { "id": "49521ece-9203-07f7-7767-e32734e5b636" }, "id": "49521ece-9203-186b-cfc7-281c207f7f52" }, "description": "Test Recurrence", "end_date": null, "external_id": null, "first_payment": { "amount": null, "date": "2026-07-10" }, "id": "019f4198-9f53-8f20-a167-5242b634311d", "inserted_at": "2026-07-08T11:59:09.140530Z", "number_of_collections": null, "options": { "automatic_schedule": true, "next_working_day": true, "retry_policy": "none" }, "origin": { "id": "019f4198-9de7-4ba7-d718-5e9fce7cbccb", "type": "api_client" }, "periodicity": "week", "qrcode": { "hash": "00020101021226630014br.gov.bcb.pix...6304B527", "id": "019f4198-9f53-0000-0000-000000000001", "type": "dynamic" }, "reference": { "id": null, "type": "qrdn" }, "start_date": "2026-07-08", "status": "created", "type": "in", "updated_at": "2026-07-08T11:59:09.140530Z" } }, "properties": { "data": { "properties": { "amounts": { "description": "Amounts of the recurrence: `fixed` for fixed amount recurrences, `minimum` (set by the receiver) and `maximum` (set by the payer) for variable ones", "properties": { "fixed": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "maximum": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "minimum": { "$ref": "#/components/schemas/V2_RecurrenceAmount" } }, "type": "object", "x-struct": null, "x-validate": null }, "authorized_at": { "description": "When the payer authorized the recurrence", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that receives the collections", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "contract_number": { "description": "Contract number", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Payer of the recurrence", "properties": { "bank_account": { "description": "Payer bank account", "properties": { "id": { "description": "Counterparty bank account ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "end_date": { "description": "Last day of the recurrence", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "first_payment": { "description": "First payment of the recurrence", "properties": { "amount": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "date": { "description": "Day of the first payment", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the recurrence was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "number_of_collections": { "description": "Number of collections", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "options": { "description": "Recurrence options", "properties": { "automatic_schedule": { "description": "Whether collections are scheduled automatically", "type": "boolean", "x-struct": null, "x-validate": null }, "next_working_day": { "description": "Whether collections falling on a non-working day move to the next one", "type": "boolean", "x-struct": null, "x-validate": null }, "retry_policy": { "$ref": "#/components/schemas/RecurrenceRetryPolicy" } }, "type": "object", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what created the recurrence", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "periodicity": { "$ref": "#/components/schemas/RecurrencePeriodicity" }, "qrcode": { "description": "QRCode the payer authorizes the recurrence through", "nullable": true, "properties": { "hash": { "description": "QRCode hash (Pix copy and paste)", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "QRCode ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "QRCode type", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "reference": { "description": "What the recurrence was created from", "properties": { "id": { "description": "Reference ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Reference type", "enum": [ "requ", "qrdn", "qres" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "start_date": { "description": "First day of the recurrence", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/RecurrenceStatus" }, "type": { "$ref": "#/components/schemas/RecurrenceType" }, "updated_at": { "description": "When the recurrence was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "V2 GenerateRecurrenceResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.GenerateResponse", "x-validate": null }, "V2_Pix_Key_confirm_payload": { "description": "Body params to confirm a key", "example": { "token": "123456" }, "properties": { "token": { "description": "Token", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "token" ], "title": "V2 Pix Key confirm payload", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.ConfirmParams", "x-validate": null }, "V2_DynamicQRCodeUpdateParams": { "description": "Body params to update a dynamic QRCode", "example": { "amount": 100, "expiration_datetime": "2026-10-20T12:00:00Z", "fee": 0 }, "properties": { "amount": { "description": "Amount value of the dynamic QRCode", "minimum": 1, "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "expiration_datetime": { "description": "Expiration datetime in ISO8601", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee in cents", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "title": "V2 DynamicQRCodeUpdateParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcode.UpdateParams", "x-validate": null }, "V2_bank_account_metrics_response": { "description": "Bank account metrics response", "example": { "data": { "in_documents": { "failed": 2, "settled": 12 }, "out_documents": { "failed": 1, "settled": 8 }, "transfer_documents": { "failed": 0, "settled": 3 } } }, "properties": { "data": { "$ref": "#/components/schemas/V2_bank_account_metrics" } }, "title": "V2 bank account metrics response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Metric.Response", "x-validate": null }, "V2_refund_within_an_in_document": { "description": "Refund of the in document, as `GET /v2/documents/in/refunds/{id}` renders it without `in_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": "Devolução manual", "end_to_end_id": "D49931906202610081927B4HdgiWHdjH", "external_id": null, "id": "01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "inserted_at": "2026-10-08T19:27:19.400000Z", "med": false, "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in_refund/01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "reconciliation_id": "01a11cfb-fc1a-e185-85ce-75c67ff0ad87", "stages": [ { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-9ee4-7389-d989b8d525ff", "inserted_at": "2026-10-08T19:27:19.400000Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-91ab-04df-8d348772400b", "inserted_at": "2026-10-08T19:27:19.600000Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-08T19:27:19.524000Z", "updated_at": "2026-10-08T19:27:19.600000Z" }, "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 in 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", "nullable": true, "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 }, "med": { "description": "Refund is linked to a MED; null when unknown", "nullable": true, "type": "boolean", "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_in_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_in_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 in document", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Refund.EmbeddedRefundData", "x-validate": null }, "V2_RecurrenceListResponse": { "description": "Recurrence lists response", "example": { "data": [ { "amounts": { "fixed": { "amount": 10000, "currency": "BRL" }, "maximum": null, "minimum": null }, "authorized_at": null, "bank_account_id": "019f4198-8913-1ec9-52c6-706c618a1c5d", "contract_number": "0001", "counterparty": { "bank_account": { "id": "49521ece-9203-07f7-7767-e32734e5b636" }, "id": "49521ece-9203-186b-cfc7-281c207f7f52" }, "description": "Test Recurrence", "end_date": null, "external_id": null, "first_payment": { "amount": null, "date": "2026-07-10" }, "id": "019f4198-9f53-8f20-a167-5242b634311d", "inserted_at": "2026-07-08T11:59:09.140530Z", "number_of_collections": null, "options": { "automatic_schedule": true, "next_working_day": true, "retry_policy": "none" }, "origin": { "id": "019f4198-9de7-4ba7-d718-5e9fce7cbccb", "type": "api_client" }, "periodicity": "week", "reference": { "id": null, "type": "qrdn" }, "start_date": "2026-07-08", "status": "created", "type": "in", "updated_at": "2026-07-08T11:59:09.140530Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "$ref": "#/components/schemas/V2_RecurrenceListData" }, "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 RecurrenceListResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.ListResponse", "x-validate": null }, "V2_card_top_up_balance_via_qrcode_params": { "description": "Generates a Pix QR code that tops up the card in the path once it is paid", "example": { "amount": { "amount": 1000, "currency": "BRL" }, "counterparty": { "name": "John Doe", "tax_number": "12345678909" }, "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b" }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_amount_params" }, "counterparty": { "description": "Who pays the QR code", "properties": { "name": { "description": "Name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF or CNPJ", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "entity_id": { "description": "ID of the entity that holds the card", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "entity_id", "amount", "counterparty" ], "title": "V2 card top up balance via qrcode params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.TopUpBalanceQrcodeParams", "x-validate": null }, "V2_RecurrenceCollectionListResponse": { "description": "Recurrence collection list response", "example": { "data": [ { "additional_info": null, "amount": { "amount": 100, "currency": "BRL" }, "bank_account_id": "019a0d9e-d21f-32d2-7b68-d4e55e72e528", "final_date": null, "id": "019a0d9e-d21f-0bf6-36be-abb0e6be5792", "inserted_at": "2025-10-22T20:31:43.647903Z", "next_working_day": false, "recurrence": { "id": "019a0d9e-d161-cd70-e9bd-f90cf4b50e33" }, "status": "active", "transaction_date": null, "updated_at": "2025-10-22T20:31:46.843629Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "$ref": "#/components/schemas/V2_RecurrenceCollectionListData" }, "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 RecurrenceCollectionListResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.ListResponse", "x-validate": null }, "Boleto_wallet_type": { "description": "Boleto wallet type", "enum": [ "direct_electronic_partial_emission_booklet", "book_entry_electronic_booklet", "direct_electronic_with_emission_booklet", "direct_electronic_no_emission_block_client", "direct_electronic_no_emission_block_us", "book_entry_electronic_bloquete", "direct_electronic_no_emission_block_client2", "direct_electronic_partial_emission_bloquete", "direct_electronic_with_emission_bloquete", "direct_electronic_no_emission_us_emission", "direct_electronic_our_number_emission_banks_bloquete", "direct_electronic_our_number_emission_banks_booklet" ], "title": "Boleto_wallet_type", "type": "string", "x-struct": null, "x-validate": null }, "V2_card_invoice_line": { "description": "One movement of a card invoice", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "card_id": "0182b3d1-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "card_number": "•••• •••• •••• 1234", "id": "0182b3d0-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "invoice_id": "0182b3d2-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "line_category": "streaming", "line_status": "confirmed", "line_title": "Streaming service", "occurred_at": "2025-06-20T03:05:00.000000Z", "ref_id": "0182b3d3-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "ref_type": "purchase" }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_money" }, "card_id": { "description": "Card ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "card_number": { "description": "Masked card number", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Line ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "invoice_id": { "description": "Invoice ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "line_category": { "description": "Line category", "type": "string", "x-struct": null, "x-validate": null }, "line_status": { "description": "Line status", "enum": [ "reversed", "confirmed", "voided" ], "type": "string", "x-struct": null, "x-validate": null }, "line_title": { "description": "Line title", "type": "string", "x-struct": null, "x-validate": null }, "occurred_at": { "description": "When the movement happened", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "ref_id": { "description": "ID of the purchase, top up or transfer the line comes from", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "ref_type": { "description": "What the line comes from", "enum": [ "purchase", "topup", "transfer_in", "transfer_out" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 card invoice line", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Invoice.LineData", "x-validate": null }, "V2_pledged_advance_request_response": { "description": "A pledged advance request", "example": { "data": { "amount": { "amount": 100000, "currency": "BRL" }, "approved_at": null, "assignor": { "bank_account_digit": "2", "bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7c", "bank_account_number": "0023123", "tax_number": "63558804023" }, "bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7b", "canceled_at": null, "charges": [], "contract_file_reference": "pledged/contracts/1_contract.pdf", "description": "Antecipação de recebíveis", "entity_id": "019084f3-ea10-3691-38dc-bda6ac03cb7a", "id": "019084f3-ea10-3691-38dc-bda6ac03cb70", "inserted_at": "2026-09-10T12:00:00.000000Z", "payer": { "tax_number": "80617053000195" }, "pledged_amount": { "amount": 100000, "currency": "BRL" }, "pledged_balance": { "amount": 100000, "currency": "BRL" }, "pledged_by": "payer_tax_number", "rejected_at": null, "status": "created", "updated_at": "2026-09-10T12:00:00.000000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_pledged_advance_request" } }, "title": "V2 pledged advance request response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Pledged.AdvanceRequest.Response", "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_CollectionScheduleParams": { "description": "Body params to schedule a collection", "example": { "amount": 10000, "due_date": "2026-10-25", "external_id": "019a0be5-d593-7b33-161a-7611b3820a76" }, "properties": { "amount": { "description": "Collection Amount in cents. Use it for updating the collection amount before scheduling. Does not work on recurrences with fixed amount.", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "due_date": { "description": "Day the attempt is due", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the attempt", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 CollectionScheduleParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.ScheduleParams", "x-validate": null }, "Create_counterparty_params": { "description": "Body params create counterparty", "example": { "name": "Random", "tax_number": "12345678910" }, "properties": { "name": { "description": "Name of the counterparty", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the counterparty", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "name" ], "title": "Create counterparty params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.Counterparty.CreateCounterparty", "x-validate": null }, "V2_RecurrenceRequestData": { "description": "A recurrence request. `stages` is present only when asked for with `load_stages`.", "example": { "counterparty": { "bank_account": { "id": "019809db-4baf-07f7-7767-e32734e5b636" }, "id": "019809db-4baf-039f-be7a-ed7d1f147ab5" }, "expires_at": "2025-08-13T13:53:43.287296Z", "id": "019809db-4af7-47fc-1add-28b582f08576", "inserted_at": "2025-07-14T16:53:43.471712Z", "recurrence": { "id": "019809db-4af7-c377-de68-c1f56b542305" }, "status": "created", "updated_at": "2025-07-14T16:53:43.471712Z" }, "properties": { "counterparty": { "description": "Payer the request was sent to", "properties": { "bank_account": { "description": "Payer bank account", "properties": { "id": { "description": "Counterparty bank account ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "expires_at": { "description": "When the payer can no longer answer the request", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Request ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the request was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "recurrence": { "description": "Recurrence the request belongs to", "properties": { "id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "stages": { "description": "Request stages", "items": { "$ref": "#/components/schemas/V2_RecurrenceRequestStage" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Request status", "enum": [ "created", "sent", "received", "rejected", "accepted", "expired", "cancelled" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the request was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceRequestData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.Data", "x-validate": null }, "V2_DARF_money": { "description": "An amount of a DARF", "example": { "amount": 1001, "currency": "BRL" }, "properties": { "amount": { "description": "Amount in cents", "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency", "enum": [ "BRL" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "currency" ], "title": "V2 DARF money", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Darf.DarfSchema.Money", "x-validate": null }, "V2_Static_QRCode_payload": { "description": "Body params to create a static QRCode", "example": { "amount": 2000, "bank_account_id": "01919020-51ee-527b-5147-3feacb8ea333", "description": "description", "external_id": "external_id", "options": { "fee": 0, "show_qrcode_image": false } }, "properties": { "amount": { "description": "Amount in cents. Send 0 for an open-amount code: the payer chooses the amount.", "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account ID", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the static QRCode", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the static QRCode", "type": "string", "x-struct": null, "x-validate": null }, "merchant": { "description": "Merchant to register as the split org merchant. When sent, it is saved.", "nullable": true, "properties": { "name": { "description": "Merchant name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Merchant tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "options": { "description": "Create options", "properties": { "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "show_qrcode_image": { "description": "Show static QRCode image", "type": "boolean", "x-struct": null, "x-validate": null } }, "required": [ "show_qrcode_image" ], "type": "object", "x-struct": null, "x-validate": null }, "platform_id": { "description": "Platform ID of the static QRCode", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "splits": { "description": "Cashin split configurations", "items": { "properties": { "counterparty_recipient_id": { "description": "Counterparty recipient UUID", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Split type", "enum": [ "percentage", "fixed" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage (0-100) or fixed amount in cents", "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "type", "value", "counterparty_recipient_id" ], "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "amount", "bank_account_id", "options" ], "title": "V2 Static QRCode payload", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.StaticBrcode.CreateParams", "x-validate": null }, "V2_in_document_status": { "description": "In document status", "enum": [ "created", "confirmed", "kyc", "settled", "refunded", "reversed", "failed" ], "title": "V2 in document status", "type": "string", "x-struct": null, "x-validate": null }, "Money": { "description": "Money", "nullable": true, "properties": { "amount": { "description": "Amount of the money", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "amount", "currency" ], "title": "Money", "type": "object", "x-struct": null, "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_counterparty_bank_account": { "description": "A counterparty bank account", "example": { "branch": "0001", "digit": "1", "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "12345678", "number": "87654321", "type": "checking", "updated_at": "2024-10-17T13:32:59.374149Z" }, "properties": { "branch": { "description": "Branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty bank account ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "Creation date and time. Null on show for a while after the bank account was found or created, which caches it without its dates", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "ISPB of the institution", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Account number", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Account type", "enum": [ "checking", "payment", "salary", "savings" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Last update date and time. Null on show for a while after the bank account was found or created, which caches it without its dates", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 counterparty bank account", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.BankAccount.BankAccountData", "x-validate": null }, "V2_Pix_key_check_response": { "description": "A Pix key checked in DICT before it is paid", "example": { "data": { "counterparty": { "bank_account": { "branch": null, "digit": null, "id": "0008d49c-e6d5-a58e-a742-449e9b38f795", "ispb": "12345678", "number": null, "type": null }, "id": "0008d49c-e6d5-4d86-232a-a6f4b9138f10", "name": "John Doe", "tax_number": "***982247**" }, "id": "019500b0-71d2-ac32-3712-e8ba5e06e0f7", "inserted_at": "2026-02-13T19:01:58.354481Z", "key": "john.doe@example.com", "type": "email", "updated_at": "2026-02-13T19:01:58.354481Z" } }, "properties": { "data": { "properties": { "counterparty": { "$ref": "#/components/schemas/V2_Pix_check_counterparty" }, "id": { "description": "Check ID, to pay as the check_id of POST /v2/out/pix", "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 }, "key": { "description": "Pix key", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Key type", "enum": [ "tax_number", "phone", "email", "random_key" ], "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 } }, "required": [ "id", "key", "type", "counterparty", "inserted_at", "updated_at" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Pix key check response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.PixCheck.KeyCheckResponse", "x-validate": null }, "V2_Generate_Boleto": { "description": "Body params to generate a boleto payment", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "check_id": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Magna dolor velit duis velit ad elit anim laborum aliqua.", "external_id": "10760495-cb95-4023-96e9-0cff5776b011" }, "properties": { "amount": { "description": "Amount of the boleto in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "check_id": { "$ref": "#/components/schemas/UUID" }, "description": { "description": "Description for the boleto", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID for reference", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "amount", "check_id", "bank_account_id" ], "title": "V2 Generate_Boleto", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Boleto.BoletoSchema.GenerateRequest", "x-validate": null }, "V2_DynamicQRCodeData": { "description": "A dynamic QRCode, as returned by show and create. `image` is present only when create was asked for it with `options.show_qrcode_image`.", "example": { "amount": { "amount": 10, "currency": "BRL" }, "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "counterparty": { "bank_accounts": [ { "branch": "0001", "digit": "1", "ispb": "00000001", "number": "12345" } ], "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" }, "description": "QRCode 1", "expiration_datetime": "2026-10-14T13:00:00Z", "external_id": "external_id", "fee": { "amount": 0, "currency": "BRL" }, "hash": "123", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2026-10-14T12:00:00Z", "options": { "allow_change_the_amount_on_payment": true }, "origin": { "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "type": "none" }, "status": "created", "updated_at": "2026-10-14T12:00:00Z" }, "properties": { "amount": { "description": "Amount value of the dynamic QRCode", "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 that receives the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Expected payer of the QRCode", "properties": { "bank_accounts": { "description": "Bank accounts the payment must come from; empty when any is accepted", "items": { "properties": { "branch": { "description": "Branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "ISPB", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Account number", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the dynamic QRCode", "type": "string", "x-struct": null, "x-validate": null }, "expiration_datetime": { "description": "Expiration Datetime", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the dynamic QRCode", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee charged on the payment", "nullable": true, "properties": { "amount": { "description": "Fee 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 }, "hash": { "description": "Hash (Pix copy and paste) of the QRCode", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Unique identifier", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "image": { "description": "Base64 QRCode image, only when requested on create", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the QRCode was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "options": { "description": "Payment options of the QRCode", "properties": { "allow_change_the_amount_on_payment": { "description": "Whether the payer may change the amount", "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what created the QRCode", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "status": { "description": "Dynamic QRCode status", "enum": [ "created", "settled", "deleted" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the QRCode was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 DynamicQRCodeData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcode.QrCodeData", "x-validate": null }, "V2_Generate_Darf": { "description": "Body params to generate a DARF payment", "example": { "amount": 13208, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "check_id": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Magna dolor velit duis velit ad elit anim laborum aliqua.", "external_id": "10760495-cb95-4023-96e9-0cff5776b011" }, "properties": { "amount": { "description": "Amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "check_id": { "$ref": "#/components/schemas/UUID" }, "description": { "description": "Description of the DARF payment", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID for reference", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "amount", "check_id", "bank_account_id" ], "title": "V2 Generate_Darf", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Darf.DarfSchema.GenerateRequest", "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_bank_account_shift_limit": { "description": "Amount used and maximum amount of a shift.", "properties": { "max": { "allOf": [ { "$ref": "#/components/schemas/V2_bank_account_amount" } ], "description": "Maximum amount of the shift", "x-struct": null, "x-validate": null }, "used": { "allOf": [ { "$ref": "#/components/schemas/V2_bank_account_amount" } ], "description": "Amount used in the current shift", "x-struct": null, "x-validate": null } }, "title": "V2 bank account shift limit", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.ShiftLimit", "x-validate": null }, "V2_card_top_up_balance_params": { "description": "Tops up the card in the path from `from_bank_account_id`", "example": { "amount": { "amount": 1000, "currency": "BRL" }, "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "from_bank_account_id": "019514eb-5d5c-2b4c-6d8e-1f3a5b7c9d0e" }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_amount_params" }, "entity_id": { "description": "ID of the entity that holds the card", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "from_bank_account_id": { "description": "ID of the bank account the money leaves", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "entity_id", "from_bank_account_id", "amount" ], "title": "V2 card top up balance params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.TopUpBalanceParams", "x-validate": null }, "V2_FirstPaymentWithDueDetail": { "description": "Schema for the first payment with due detail", "nullable": true, "properties": { "amount": { "description": "First Payment amount in cents", "minimum": 1, "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "dict_key": { "description": "Bank Account Pix Key", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "due_detail": { "$ref": "#/components/schemas/V2_PixDueDetailParams" }, "recurrence_required": { "default": true, "description": "If set to false, the counterparty is able to make the first payment and refuse the recurrence. If set to true, the recurrence and first payment are approved in a single authorization.", "nullable": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "title": "V2 FirstPaymentWithDueDetail", "type": "object", "x-struct": null, "x-validate": null }, "V2_onboarding_document_upload_params": { "description": "Multipart form params to upload an onboarding document", "example": { "document_type": "financial_statement", "file": "", "reference_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f", "reference_type": "entity" }, "properties": { "document_type": { "description": "Document type, among the required_documents the onboarding asked for", "enum": [ "power_of_attorney", "financial_statement", "identification", "company_contract" ], "type": "string", "x-struct": null, "x-validate": null }, "file": { "description": "The PDF file", "format": "binary", "type": "string", "x-struct": null, "x-validate": null }, "reference_id": { "description": "The entity_id, or the representative id, the POST /v2/onboarding response published", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "reference_type": { "description": "Whether the document is the entity's or a representative's", "enum": [ "entity", "entity_representative" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "reference_type", "reference_id", "document_type", "file" ], "title": "V2 onboarding document upload params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.V2.Document.UploadDocumentParams", "x-validate": null }, "DynamicBrcodeDueDetailRebateCalculationType": { "description": "Rebate calculation type of dynamic brcode with due detail", "enum": [ "amount", "percentage" ], "nullable": true, "title": "DynamicBrcodeDueDetailRebateCalculationType", "type": "string", "x-struct": null, "x-validate": null }, "V2_bank_account_amount": { "description": "An amount in cents.", "example": { "amount": 10000, "currency": "BRL" }, "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "$ref": "#/components/schemas/Currency" } }, "title": "V2 bank account amount", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Amount", "x-validate": null }, "DynamicBrcodeDueDetailFineCalculationType": { "description": "Fine calculation type of dynamic brcode with due detail", "enum": [ "amount", "percentage" ], "nullable": true, "title": "DynamicBrcodeDueDetailFineCalculationType", "type": "string", "x-struct": null, "x-validate": null }, "V2_bank_account_parameters": { "description": "What the bank account blocks or refunds automatically", "example": { "automatic_refund_for_person_dead": false, "automatic_refund_for_person_invalid_tax_number": false, "automatic_refund_for_person_underage": false, "in_block_for_legal_entity": false, "in_block_for_pix_qrcode_different_amount_payment": false, "in_block_for_pix_qrcode_different_counterparty_bank_account": false, "in_block_for_pix_qrcode_different_tax_number": false, "in_block_for_pix_qrcode_duplicated_payment": false, "in_block_for_unauthorized_participant": false, "in_block_for_unidentified_deposit": false, "out_block_for_legal_entity": false, "out_blocked": false }, "properties": { "automatic_refund_for_person_dead": { "description": "Automatic refund for deceased individuals", "type": "boolean", "x-struct": null, "x-validate": null }, "automatic_refund_for_person_invalid_tax_number": { "description": "Automatic refund for invalid tax number", "type": "boolean", "x-struct": null, "x-validate": null }, "automatic_refund_for_person_underage": { "description": "Automatic refund for underage", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_legal_entity": { "description": "In block for legal entity origin?", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_different_amount_payment": { "description": "In block for qrcode different amount payment?", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_different_counterparty_bank_account": { "description": "In block for qrcode different counterparty bank account", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_different_tax_number": { "description": "In block for qrcode different tax number?", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_pix_qrcode_duplicated_payment": { "description": "In block for qrcode duplicated payment?", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_unauthorized_participant": { "description": "In block for unauthorized participant", "type": "boolean", "x-struct": null, "x-validate": null }, "in_block_for_unidentified_deposit": { "description": "In block for unidentified deposit?", "type": "boolean", "x-struct": null, "x-validate": null }, "out_block_for_legal_entity": { "description": "Out block for legal entity destination?", "type": "boolean", "x-struct": null, "x-validate": null }, "out_blocked": { "description": "Out blocked?", "type": "boolean", "x-struct": null, "x-validate": null } }, "title": "V2 bank account parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Parameters", "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_entity_contact": { "description": "Entity contact information", "example": { "email": "entity@gmail.com", "phone_number": "41999999999" }, "properties": { "email": { "description": "Entity email", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "Entity phone number", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 entity contact", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityContactData", "x-validate": null }, "V2_onboarding_entity_business_information_parameters": { "description": "Onboard business information parameters for creating entity", "example": { "annual_revenue": { "amount": 500000, "currency": "BRL" }, "average_ticket": { "amount": 10000000, "currency": "BRL" } }, "properties": { "annual_revenue": { "$ref": "#/components/schemas/Money" }, "average_ticket": { "$ref": "#/components/schemas/Money" } }, "required": [ "average_ticket", "annual_revenue" ], "title": "V2 onboarding entity business information parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.V2.Entity.EntityBusinessInfosParams", "x-validate": null }, "V2_card_money": { "description": "An amount of money in cents. It can be zero or negative.", "example": { "amount": 10000, "currency": "BRL" }, "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency", "enum": [ "BRL" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "currency" ], "title": "V2 card money", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Money", "x-validate": null }, "V2_Pix_Key_list_response": { "description": "Pix Key list response", "example": { "data": [ { "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2020-01-10T10:00:00Z", "key": "12345678900", "status": "created", "tax_number": "12345678900", "type": "tax_number", "updated_at": "2020-01-10T10:00:00Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_Pix_Key_response" }, "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 Pix Key list response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.ListResponse", "x-validate": null }, "V2_RecurrenceCollectionStageData": { "description": "A stage of a recurrence collection. `error_code` and `error_message` carry the rejection reason when there is one.", "example": { "error_code": null, "error_message": null, "id": "019a0d9e-d21f-5a1e-0c1d-9e5f2b8a7c31", "inserted_at": "2025-10-22T20:31:46.843629Z", "status": "active" }, "properties": { "error_code": { "description": "Rejection code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Rejection description", "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": "Collection status the stage recorded", "enum": [ "created", "active", "settled", "expired", "rejected", "cancelled", "attempt_link" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceCollectionStageData", "type": "object", "x-struct": null, "x-validate": null }, "V2_in_document_refund": { "description": "In document refund, as returned by the listing, show and search. `bank_account_id` is the account that paid the refund back; the counterparty is the one of the refunded in 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": "Devolução manual", "end_to_end_id": "D49931906202610081927B4HdgiWHdjH", "external_id": null, "id": "01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "in_document_id": "01a117fc-bb66-88e2-942b-0ce8cd702c5c", "inserted_at": "2026-10-08T19:27:19.400000Z", "med": false, "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in_refund/01a11cfb-fc1a-71d3-28ed-8ff75c88e872", "reconciliation_id": "01a11cfb-fc1a-e185-85ce-75c67ff0ad87", "stages": [ { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-9ee4-7389-d989b8d525ff", "inserted_at": "2026-10-08T19:27:19.400000Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11cfb-fc1a-91ab-04df-8d348772400b", "inserted_at": "2026-10-08T19:27:19.600000Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-08T19:27:19.524000Z", "updated_at": "2026-10-08T19:27:19.600000Z" }, "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 in 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", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Refund document ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "in_document_id": { "description": "ID of the refunded in document", "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 }, "med": { "description": "Refund is linked to a MED; null when unknown", "nullable": true, "type": "boolean", "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_in_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_in_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 in document refund", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Refund.RefundInDocumentData", "x-validate": null }, "V2_list_bank_account_transactions_response": { "description": "A list of transactions of a bank account", "example": { "data": [ { "amount": { "amount": 10, "currency": "BRL" }, "bank_account_id": "0190df9a-d08e-9574-c79c-9aa0f40ee330", "counterparty": { "bank_account_id": "0190df9a-d1b1-efb3-7521-55db2415f319", "id": "0191148f-b189-8e42-27a5-1368cc00dea8", "name": "John Doe", "tax_number": "11122233344" }, "document_type": "pix", "end_to_end_id": "E44444444202405211946Dwg1pjxgehP", "external_id": "external_id", "inserted_at": "2024-07-21T12:00:01.000000Z", "posting_type": "credit", "reconciliation_id": "018f3406-9e00-1766-05c4-4907e14ee511", "ref_id": "0190df9a-d1b1-6bfe-ad26-037579ad8588", "ref_type": "in_document", "transaction_date": "2024-07-21T12:00:01.000000Z", "transaction_type": "regular", "updated_at": "2024-07-21T12:00:01.000000Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_bank_account_transaction" }, "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 bank account transactions response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Transaction.ListTransactionResponse", "x-validate": null }, "V2_bank_account_limits_by_transaction_type": { "description": "Limits of the bank account by transaction type. Null in the response of the creation, which loads none.", "example": { "payments": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "pix": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "ted": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } }, "tef": { "daily": { "max": { "amount": 50000000, "currency": "BRL" }, "used": { "amount": 120000, "currency": "BRL" } }, "overnight": { "max": { "amount": 20000000, "currency": "BRL" }, "used": { "amount": 0, "currency": "BRL" } }, "transaction": { "max": { "amount": 4500000, "currency": "BRL" } } } }, "nullable": true, "properties": { "payments": { "$ref": "#/components/schemas/V2_bank_account_limits" }, "pix": { "$ref": "#/components/schemas/V2_bank_account_limits" }, "ted": { "$ref": "#/components/schemas/V2_bank_account_limits" }, "tef": { "$ref": "#/components/schemas/V2_bank_account_limits" } }, "title": "V2 bank account limits by transaction type", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.BankAccountLimits", "x-validate": null }, "V2_card_sensitive_data_response": { "description": "Card sensitive data", "example": { "data": { "expiration_date": "2033-01-31T23:59:59.999999Z", "holder_name": "John Doe", "number": "5555444433331111", "security_code": "123" } }, "properties": { "data": { "properties": { "expiration_date": { "description": "When the card expires", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "holder_name": { "description": "Holder name", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Card number", "type": "string", "x-struct": null, "x-validate": null }, "security_code": { "description": "Security code", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "holder_name", "number", "expiration_date", "security_code" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 card sensitive data response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.SensitiveInfoResponse", "x-validate": null }, "V2_dynamic_QRCode_image_response": { "description": "Image of a dynamic QRCode, rendered from its hash. `image` is null when the image could not be rendered.", "example": { "data": { "image": "iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4CAYAAAA5ZDbSAAAAAXNSR0IArs4c6QAA" } }, "properties": { "data": { "properties": { "image": { "description": "QRCode image in base64, 120x120; null when it could not be rendered", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "image" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 dynamic QRCode image response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcode.ImageResponse", "x-validate": null }, "V2_card_purchase_end_to_end_id": { "description": "End to end ID of the card purchase", "example": "EE202506111406IVIN5pXVoyp", "title": "V2 card purchase end to end id", "type": "string", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.EndToEndId", "x-validate": null }, "V2_list_card_purchases_response": { "description": "A page of card purchases, without their stages", "example": { "data": [ { "amount": { "amount": 10000, "currency": "BRL" }, "card_id": "01978eea-1d48-9176-e7f6-2ff0992c1b58", "category_code": "foodAndBeverage", "category_type": "restaurants", "description": "Lunch", "end_to_end_id": "EE202506111406IVIN5pXVoyp", "entity_id": "01978eea-14d9-0d41-ce30-a9e2cbf743c5", "error_code": null, "error_message": null, "id": "0192f790-170e-e630-609a-18a0447ee30b", "inserted_at": "2025-06-11T14:06:12.196500Z", "is_partially_allowed": false, "issuer_amount": { "amount": 10000, "currency": "BRL" }, "merchant": { "amount": { "amount": 10000, "currency": "BRL" }, "country_code": "BR", "currency_symbol": "R$", "name": "John Doe Store" }, "method_code": "contactless", "purchased_at": "2025-06-11T14:06:10.430838Z", "purpose": "purchase", "receipt_url": "https://receipt.example.com/purchase/0192f790-170e-e630-609a-18a0447ee30b", "status": "confirmed", "tax": { "amount": 0, "currency": "BRL" }, "updated_at": "2025-06-11T14:06:12.196500Z", "zip_code": null } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_card_purchase" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "$ref": "#/components/schemas/V2_card_list_metadata" } }, "required": [ "data", "metadata" ], "title": "V2 list card purchases response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.ListResponse", "x-validate": null }, "V2_bank_account_parameters_response": { "description": "The bank account parameters after the update, as the bank account shows them", "example": { "data": { "automatic_refund_for_person_dead": false, "automatic_refund_for_person_invalid_tax_number": false, "automatic_refund_for_person_underage": false, "in_block_for_legal_entity": false, "in_block_for_pix_qrcode_different_amount_payment": false, "in_block_for_pix_qrcode_different_counterparty_bank_account": false, "in_block_for_pix_qrcode_different_tax_number": false, "in_block_for_pix_qrcode_duplicated_payment": false, "in_block_for_unauthorized_participant": false, "in_block_for_unidentified_deposit": false, "out_block_for_legal_entity": false, "out_blocked": false } }, "properties": { "data": { "$ref": "#/components/schemas/V2_bank_account_parameters" } }, "title": "V2 bank account parameters response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.BankAccountParametersResponse", "x-validate": null }, "V2_in_document_response": { "description": "In document response", "example": { "data": { "amount": { "amount": 100, "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": "E60746948202610072016A0049Tfmiks", "external_id": "01M4C040NGQ5VKGKZRR3SXRZ7E", "id": "01a11802-3da7-052e-3f8f-19cfe127e4b8", "inserted_at": "2026-10-07T20:16:02.471297Z", "origin": { "id": "d4abaabe-5ebf-4628-ba34-5a1b17da4c6b", "type": "console_user" }, "receipt_url": "https://receipts.trio.com.br/019489e6-f64f-5cfe-770b-79b671ec66f0/in/01a11802-3da7-052e-3f8f-19cfe127e4b8", "reconciliation_id": "01a11802-3da7-09df-060e-0ca0747a1876", "reference": { "id": "01a11802-b618-fcd7-94f4-88f533fe41cc", "type": "pix_qrcode" }, "refunds": [], "stages": [ { "error_code": null, "error_message": null, "id": "01a11802-3da7-2381-58a7-54b90a2ffa9a", "inserted_at": "2026-10-07T20:17:02.479108Z", "status": "created" }, { "error_code": null, "error_message": null, "id": "01a11802-3da7-af9b-756c-9522bbd3b87f", "inserted_at": "2026-10-07T20:17:03.475249Z", "status": "settled" } ], "status": "settled", "transaction_date": "2026-10-07T20:17:02.795000Z", "type": "pix", "updated_at": "2026-10-07T20:17:03.475249Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_in_document" } }, "title": "V2 in document response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Document.Response", "x-validate": null }, "V2_transfer_creation_response": { "description": "Transfer requested between two bank accounts. trio-spi creates the transfer document asynchronously; read it back through `GET /v2/documents/transfer/{id}` for its details and final state.", "example": { "data": { "transfer_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" } }, "properties": { "data": { "properties": { "transfer_document_id": { "description": "ID of the transfer document", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "transfer_document_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 transfer creation response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Transfer.CreationResponse", "x-validate": null }, "Onboarding_entity_consent_parameters": { "description": "Onboard consent parameters for creating entity", "example": { "consent_at": "2026-08-25T07:00:00.000Z", "ip_address": "8.8.8.8", "tax_number": "04969361908" }, "properties": { "consent_at": { "description": "Date of the entity consent", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "ip_address": { "description": "Consent IP Address (IPv4 or IPv6)", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Consent tax number of a legal representative", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "ip_address", "consent_at" ], "title": "Onboarding entity consent parameters", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.Entity.EntityConsentParams", "x-validate": null }, "Boleto_Status": { "description": "Status of the boleto", "enum": [ "created", "confirmed", "settled", "onhold", "refunded", "failed", "cancelled" ], "example": "created", "nullable": true, "title": "Boleto Status", "type": "string", "x-struct": null, "x-validate": null }, "V2_Generate_Darf_async_create_params": { "description": "Body params to pay a DARF without checking it first: the DARF as the check request takes it, and the account that pays it.", "example": { "accumulated_revenue_amount": { "amount": 0, "currency": "BRL" }, "amount": { "amount": 13208, "currency": "BRL" }, "assessment_date": "2026-01-01", "authentication_date": "2026-01-30", "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "description": "Consectetur esse sed irure incididunt est culpa nostrud.", "due_date": "2026-01-30", "external_id": "5b760495-cb55-4043-95e8-0cff5776b014", "federal_revenue_id": "473", "fine_amount": { "amount": 1001, "currency": "BRL" }, "interest_amount": { "amount": 1001, "currency": "BRL" }, "percentage": 0, "phone": "+5541999381724", "reference_number": null, "taxpayer": { "name": "John Doe", "tax_number": "52998224725" } }, "properties": { "accumulated_revenue_amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "assessment_date": { "description": "Assessment period (período de apuração)", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "authentication_date": { "description": "Authentication date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "description": { "description": "Description of the DARF payment", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the DARF payment for reference", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "federal_revenue_id": { "description": "Revenue code (código da receita)", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "fine_amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "interest_amount": { "$ref": "#/components/schemas/V2_DARF_money" }, "percentage": { "description": "Percentage", "type": "integer", "x-struct": null, "x-validate": null }, "phone": { "description": "Taxpayer phone number", "type": "string", "x-struct": null, "x-validate": null }, "reference_number": { "description": "Reference number", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "taxpayer": { "description": "Taxpayer the DARF belongs to", "properties": { "name": { "description": "Name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF or CNPJ", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "bank_account_id", "taxpayer", "federal_revenue_id", "amount", "fine_amount", "interest_amount", "accumulated_revenue_amount", "percentage", "assessment_date", "due_date", "authentication_date", "phone" ], "title": "V2 Generate_Darf_async_create_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Darf.DarfSchema.GenerateAsyncRequest", "x-validate": null }, "Create_counterparty_recipient_params": { "description": "Body params to create a counterparty recipient", "example": { "name": "Random", "pix_key": "some-pix-key", "ref_type": "pix_key", "tax_number": "12345678910" }, "properties": { "branch": { "description": "Bank account branch. Required when ref_type is bank_account_detailed", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Bank account digit. Required when ref_type is bank_account_detailed", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "Bank account ispb. Required when ref_type is bank_account_detailed", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name of the counterparty", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Bank account number. Required when ref_type is bank_account_detailed", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pix_key": { "description": "Pix key. Required when ref_type is pix_key", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "ref_type": { "description": "How the recipient is referenced", "enum": [ "pix_key", "bank_account_detailed" ], "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the counterparty", "type": "string", "x-struct": null, "x-validate": null }, "type": { "$ref": "#/components/schemas/Counterparty_bank_account_type" } }, "required": [ "tax_number", "name", "ref_type" ], "title": "Create counterparty recipient params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.CreateParams", "x-validate": null }, "V2_entity_business_information": { "description": "Entity business information", "example": { "annual_revenue": { "amount": 500000, "currency": "BRL" }, "average_ticket": { "amount": 10000000, "currency": "BRL" }, "company_activity": "6201501", "company_secondary_activity": [ "6202300" ] }, "properties": { "annual_revenue": { "$ref": "#/components/schemas/Money" }, "average_ticket": { "$ref": "#/components/schemas/Money" }, "company_activity": { "description": "Entity main activity (CNAE)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "company_secondary_activity": { "description": "Entity secondary activities (CNAE)", "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null } }, "title": "V2 entity business information", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityBusinessInfosData", "x-validate": null }, "V2_RecurrenceCollectionAttemptStage": { "description": "A stage of a collection attempt. `error_code` carries the rejection code when there is one.", "example": { "error_code": null, "error_message": null, "id": "019809e6-c836-5a1e-0c1d-9e5f2b8a7c31", "inserted_at": "2025-07-14T17:06:16.606122Z", "status": "requested" }, "properties": { "error_code": { "description": "Rejection code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "error_message": { "description": "Error message", "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": "Attempt status the stage recorded", "enum": [ "requested", "scheduled", "settled", "cancelled", "rejected", "expired", "failed" ], "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceCollectionAttemptStage", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Attempt.Stage", "x-validate": null }, "V2_list_card_invoices_response": { "description": "A page of card invoices", "example": { "data": [ { "balance": { "amount": 9000, "currency": "BRL" }, "entity_id": "0182b3d3-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "from_datetime": "2025-06-01T03:00:00.000000Z", "id": "0182b3d0-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "pending_confirmation_amount": { "amount": 0, "currency": "BRL" }, "purchase_balance": { "amount": 10000, "currency": "BRL" }, "status": "open", "to_datetime": "2025-07-01T02:59:59.999999Z" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_card_invoice" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "$ref": "#/components/schemas/V2_card_list_metadata" } }, "required": [ "data", "metadata" ], "title": "V2 list card invoices response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Invoice.ListResponse", "x-validate": null }, "V2_Generate_Utility_Response": { "description": "The utility bill payment requested", "example": { "data": { "out_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" } }, "properties": { "data": { "properties": { "out_document_id": { "description": "ID of the out document created for the payment", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "out_document_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Generate_Utility_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Utility.UtilitySchema.GenerateResponse", "x-validate": null }, "V2_counterparty": { "description": "A counterparty and its bank accounts", "example": { "bank_accounts": [ { "branch": "0001", "digit": "1", "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "12345678", "number": "87654321", "type": "checking", "updated_at": "2024-10-17T13:32:59.374149Z" } ], "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "name": "participant_1", "tax_number": "***456789**", "updated_at": "2024-10-17T13:32:59.374149Z" }, "properties": { "bank_accounts": { "items": { "$ref": "#/components/schemas/V2_counterparty_bank_account" }, "type": "array", "x-struct": null, "x-validate": null }, "id": { "description": "ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "Creation date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name of the counterparty", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Tax number of the counterparty. A CPF is masked (e.g. ***456789**); a CNPJ is published as is", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Last update date and time", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 counterparty", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.CounterpartyData", "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_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_Generate_pix_response": { "description": "The Pix payment requested. When the organization requires approval for Pix payments, `out_document_id` is null until the approval request is approved, and `approval_request_id` identifies that request; otherwise `approval_request_id` is null.", "example": { "data": { "approval_request_id": null, "out_document_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" } }, "properties": { "data": { "properties": { "approval_request_id": { "description": "ID of the approval request, when the payment needs approval", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "out_document_id": { "description": "ID of the out document created for the payment", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "out_document_id", "approval_request_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "data" ], "title": "V2 Generate pix response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.GeneratePix.Response", "x-validate": null }, "V2_entity_onboard_data": { "description": "The entity as Trio registered it to onboard, with the fields of the onboarding request under the same names", "example": { "business_infos": { "annual_revenue": { "amount": 5000000, "currency": "BRL" }, "average_ticket": { "amount": 500000, "currency": "BRL" } }, "consent": { "consent_at": "2026-08-25T07:00:00.000000Z", "ip_address": "8.8.8.8", "tax_number": "52998224725" }, "entity_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f", "external_id": "404ANVIL", "inserted_at": "2026-09-29T19:23:42.485921Z", "name": "ACME INC", "org_id": "92b0f620-7105-4c10-84a1-f5a034a14efa", "representatives": [ { "email": "w.coyote@acme.com", "id": "8c61c7fd-3509-4306-9fec-9090e82fe121", "name": "Willy Coyote", "phone": "+5541999990000", "required_documents": [ "identification" ], "status": "in_validation", "tax_number": "52998224725" } ], "required_documents": [ "company_contract" ], "status": "in_validation", "tax_number": "61775921000110", "updated_at": "2026-09-29T19:23:42.485921Z" }, "properties": { "business_infos": { "description": "Business information sent in the request", "properties": { "annual_revenue": { "description": "Annual revenue", "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 }, "average_ticket": { "description": "Average ticket", "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 } }, "type": "object", "x-struct": null, "x-validate": null }, "consent": { "description": "Consent sent in the request", "properties": { "consent_at": { "description": "When the representative consented", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "ip_address": { "description": "IP address of the consent", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF of the representative who consented", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "entity_id": { "description": "Entity ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the entity was registered", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name of the entity as registered at Receita Federal", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "org_id": { "description": "Org created for the onboarded entity, to act on it with the Trio-Target-Org-Id header", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "representatives": { "description": "Legal representatives sent in the request", "items": { "properties": { "email": { "description": "Email of the representative", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Representative ID, the reference_id of its documents in POST /v2/onboarding/documents", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Name of the representative", "type": "string", "x-struct": null, "x-validate": null }, "phone": { "description": "Phone number of the representative, in E.164 format", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "required_documents": { "description": "Documents to upload for the representative", "items": { "enum": [ "identification" ], "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Representative validation status", "enum": [ "in_validation", "in_review", "rejected", "approved" ], "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF of the representative", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "required_documents": { "description": "Documents to upload for the entity", "items": { "enum": [ "power_of_attorney", "company_contract", "financial_statement" ], "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Onboarding status", "enum": [ "in_validation", "in_review", "rejected", "approved" ], "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CNPJ of the entity", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the entity was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 entity onboard data", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Onboarding.V2.Entity.EntityData", "x-validate": null }, "V2_DataWithStageAndRequest": { "description": "A recurrence. `stages` and `requests` are present only when asked for with `load_stages` / `load_requests`.", "properties": { "amounts": { "description": "Amounts of the recurrence: `fixed` for fixed amount recurrences, `minimum` (set by the receiver) and `maximum` (set by the payer) for variable ones", "properties": { "fixed": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "maximum": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "minimum": { "$ref": "#/components/schemas/V2_RecurrenceAmount" } }, "type": "object", "x-struct": null, "x-validate": null }, "authorized_at": { "description": "When the payer authorized the recurrence", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that receives the collections", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "contract_number": { "description": "Contract number", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Payer of the recurrence", "properties": { "bank_account": { "description": "Payer bank account", "properties": { "id": { "description": "Counterparty bank account ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "end_date": { "description": "Last day of the recurrence", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "first_payment": { "description": "First payment of the recurrence", "properties": { "amount": { "$ref": "#/components/schemas/V2_RecurrenceAmount" }, "date": { "description": "Day of the first payment", "format": "date", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Recurrence ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the recurrence was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "number_of_collections": { "description": "Number of collections", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "options": { "description": "Recurrence options", "properties": { "automatic_schedule": { "description": "Whether collections are scheduled automatically", "type": "boolean", "x-struct": null, "x-validate": null }, "next_working_day": { "description": "Whether collections falling on a non-working day move to the next one", "type": "boolean", "x-struct": null, "x-validate": null }, "retry_policy": { "$ref": "#/components/schemas/RecurrenceRetryPolicy" } }, "type": "object", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what created the recurrence", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "periodicity": { "$ref": "#/components/schemas/RecurrencePeriodicity" }, "reference": { "description": "What the recurrence was created from", "properties": { "id": { "description": "Reference ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Reference type", "enum": [ "requ", "qrdn", "qres" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "requests": { "items": { "$ref": "#/components/schemas/V2_RecurrenceRequestEmbeddedData" }, "type": "array", "x-struct": null, "x-validate": null }, "stages": { "items": { "$ref": "#/components/schemas/V2_RecurrenceStageData" }, "type": "array", "x-struct": null, "x-validate": null }, "start_date": { "description": "First day of the recurrence", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/RecurrenceStatus" }, "type": { "$ref": "#/components/schemas/RecurrenceType" }, "updated_at": { "description": "When the recurrence was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 DataWithStageAndRequest", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.DataWithStageAndRequest", "x-validate": null }, "V2_Static_QRCode_response": { "description": "A static QRCode, as returned by show and create. `image` is present only when create was asked for it with `options.show_qrcode_image`.", "example": { "amount": { "amount": 10, "currency": "BRL" }, "bank_account_id": "019252ca-4859-55f0-0f20-6f02250b5acd", "description": "description", "external_id": "external_id", "fee": { "amount": 0, "currency": "BRL" }, "hash": "00020126580014br.gov.bcb.pix0136019252ca-48b2-e95e-c398-3133a04a5b3e52040000530398654040.105802BR5911brcode_name6011brcode_city622605222HwV3MJojKRR2FxvgYTgYF6304C4D0", "id": "019252ca-4a5b-b711-2371-0a0142807c75", "inserted_at": "2024-10-03T14:30:42.011732Z", "origin": { "id": null, "type": null }, "status": "created", "updated_at": "2024-10-03T14:30:42.011732Z" }, "properties": { "amount": { "description": "Amount value of the static QRCode", "properties": { "amount": { "description": "Amount integer", "minimum": 0, "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 that receives the payments", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee charged on each payment", "nullable": true, "properties": { "amount": { "description": "Fee 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 }, "hash": { "description": "QRCode hash (Pix copy and paste)", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Static QRCode ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "image": { "description": "Base64 QRCode image, only when requested on create", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the QRCode was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "origin": { "description": "Who or what created the QRCode", "properties": { "id": { "description": "Origin ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Origin type: `none`, `api_client` or `console_user`", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "status": { "description": "Static QRCode status", "enum": [ "created", "deleted" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the QRCode was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 Static QRCode response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.StaticBrcode.QrCodeData", "x-validate": null }, "Refund_creation_body_params": { "description": "Refund creation body params", "example": { "amount": 10, "description": "Refund description" }, "properties": { "amount": { "description": "Amount in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Description of refund", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "description" ], "title": "Refund creation body params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.Cashin.Document.RefundCreationParams", "x-validate": null }, "V2_card_invoice_response": { "description": "Card invoice response", "example": { "data": { "balance": { "amount": 9000, "currency": "BRL" }, "entity_id": "0182b3d3-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "from_datetime": "2025-06-01T03:00:00.000000Z", "id": "0182b3d0-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "pending_confirmation_amount": { "amount": 0, "currency": "BRL" }, "purchase_balance": { "amount": 10000, "currency": "BRL" }, "status": "open", "to_datetime": "2025-07-01T02:59:59.999999Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_card_invoice" } }, "required": [ "data" ], "title": "V2 card invoice response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Invoice.Response", "x-validate": null }, "V2_counterparty_bank_account_response": { "description": "A counterparty bank account", "example": { "data": { "branch": "0001", "digit": "1", "id": "018df099-093e-cfd1-4500-4c9392eb5d8a", "inserted_at": "2024-10-17T13:32:59.374149Z", "ispb": "12345678", "number": "87654321", "type": "checking", "updated_at": "2024-10-17T13:32:59.374149Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_counterparty_bank_account" } }, "title": "V2 counterparty bank account response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.BankAccount.Response", "x-validate": null }, "V2_Generate_pix_async_create_params": { "description": "Body params to pay a Pix key or brcode without checking it first: Trio checks it while it processes the payment.", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "counterparty": { "bank_accounts": [ { "branch": "0001", "digit": "1", "ispb": "12345678", "number": "123456", "type": "checking" } ], "tax_number": "52998224725" }, "description": "description", "external_id": "external_id 1", "reference": "john.doe@example.com", "type": "key" }, "properties": { "amount": { "description": "Amount in cents", "maximum": 100000000000, "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "description": "Bank account that pays the Pix", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "counterparty": { "description": "Receiver the payer expects. When given, the payment is refused if the key or brcode belongs to another tax number, or to none of the bank accounts listed", "properties": { "bank_accounts": { "description": "Bank accounts the key or brcode may point to (up to 10)", "items": { "properties": { "branch": { "description": "Branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Account digit", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "ISPB of the bank", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Account number", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Account type", "enum": [ "checking", "payment", "salary", "savings" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "ispb", "number" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "tax_number": { "description": "CPF or CNPJ", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Pix description", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "reference": { "description": "The Pix key, or the copy and paste code of the brcode", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "What the Pix pays: a key or a brcode", "enum": [ "key", "brcode" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "type", "reference", "bank_account_id" ], "title": "V2 Generate pix async create params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.GeneratePix.CreateAsyncParams", "x-validate": null }, "V2_card_with_balance_response": { "description": "A card with its current balance", "example": { "data": { "balance": { "amount": 0, "currency": "BRL" }, "display_name": "marketing card", "entity_id": "019514eb-5d5c-4a1e-9f0b-1c2d3e4f5a6b", "id": "019514eb-5d5c-b395-5a77-449d12701ce7", "masked_number": "•••• •••• •••• 1234", "status": "active", "type": "virtual" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_card_with_balance" } }, "required": [ "data" ], "title": "V2 card with balance response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.ShowResponse", "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 }, "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_bank_account_metrics": { "description": "Settled and failed totals by document type", "example": { "in_documents": { "failed": 2, "settled": 12 }, "out_documents": { "failed": 1, "settled": 8 }, "transfer_documents": { "failed": 0, "settled": 3 } }, "properties": { "in_documents": { "$ref": "#/components/schemas/V2_bank_account_document_metrics" }, "out_documents": { "$ref": "#/components/schemas/V2_bank_account_document_metrics" }, "transfer_documents": { "$ref": "#/components/schemas/V2_bank_account_document_metrics" } }, "title": "V2 bank account metrics", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Metric.MetricData", "x-validate": null }, "V2_DynamicQRCodeResponse": { "description": "Response schema for a single dynamic QRCode", "example": { "data": { "amount": { "amount": 10, "currency": "BRL" }, "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "counterparty": { "bank_accounts": [ { "branch": "0001", "digit": "1", "ispb": "00000001", "number": "12345" } ], "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2" }, "description": "QRCode 1", "expiration_datetime": "2026-10-14T13:00:00Z", "external_id": "external_id", "fee": { "amount": 0, "currency": "BRL" }, "hash": "123", "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "inserted_at": "2026-10-14T12:00:00Z", "options": { "allow_change_the_amount_on_payment": true }, "origin": { "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2", "type": "none" }, "status": "created", "updated_at": "2026-10-14T12:00:00Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_DynamicQRCodeData" } }, "title": "V2 DynamicQRCodeResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.DynamicBrcode.Response", "x-validate": null }, "V2_Generate_Tax_async_create_params": { "description": "Body params to generate an async tax", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "code": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Consectetur esse sed irure incididunt est culpa nostrud.", "external_id": "5b760495-cb55-4043-95e8-0cff5776b014" }, "properties": { "amount": { "description": "Amount of the tax in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "code": { "description": "Barcode or digitable_line of the tax", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the tax", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the tax for reference", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "amount", "bank_account_id", "code" ], "title": "V2 Generate_Tax_async_create_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Tax.TaxSchema.GenerateAsyncRequest", "x-validate": null }, "V2_BoletoDueDetailParams": { "description": "Due detail of a boleto. Each rule takes `amount` (cents) for an amount calculation type and `value` (basis points, 100 = 1%) for a percentage one.", "example": { "discount": { "fixed_until_due": { "amounts": [ { "amount": 300, "date": "2026-12-13" }, { "amount": 100, "date": "2026-12-15" } ], "calculation_type": "amount" } }, "due_date": "2026-12-16", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "amount": 10, "calculation_type": "daily_rate" } }, "properties": { "discount": { "description": "Discount for payments before the due date; set only one option", "properties": { "fixed_until_due": { "description": "Discount granted until each date", "properties": { "amounts": { "items": { "properties": { "amount": { "description": "Amount in cents, for an amount calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "date": { "description": "Last date on which the discount applies", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "date" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "calculation_type": { "description": "`amount` takes `amount`, `percentage` takes `value`", "enum": [ "amount", "percentage" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type", "amounts" ], "type": "object", "x-struct": null, "x-validate": null }, "per_day_antecipated": { "description": "Discount per day paid in advance", "properties": { "amount": { "description": "Amount in cents, for an amount calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_days": { "enum": [ "calendar", "working" ], "type": "string", "x-struct": null, "x-validate": null }, "calculation_type": { "description": "`amount` takes `amount`, `percentage` takes `value`", "enum": [ "amount", "percentage" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type", "calculation_days" ], "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date of the boleto", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "fine": { "description": "Fine charged after the due date", "properties": { "amount": { "description": "Amount in cents, for an amount calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_type": { "description": "`amount` takes `amount`, `percentage` takes `value`", "enum": [ "amount", "percentage" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type" ], "type": "object", "x-struct": null, "x-validate": null }, "interest": { "description": "Interest charged after the due date", "properties": { "amount": { "description": "Amount in cents, for an amount calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "calculation_type": { "description": "`daily_rate` takes `amount` per day, `monthly_fee` takes `value` per month, `exempt` and `bank_control` take neither", "enum": [ "daily_rate", "monthly_fee", "exempt", "bank_control" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for a percentage calculation type", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "calculation_type" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "due_date" ], "title": "V2 BoletoDueDetailParams", "type": "object", "x-struct": null, "x-validate": null }, "V2_Boleto_create_params": { "description": "Body params to create a boleto", "example": { "amount": 402, "bank_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "counterparty": { "address": "Rua Exemplo, 100", "city": "Curitiba", "district": "Centro", "name": "Payer Name", "postal_code": "80000000", "state": "PR", "tax_number": "12345678900" }, "description": "Pago a trio.com.br", "due_detail": { "discount": { "fixed_until_due": { "amounts": [ { "amount": 300, "date": "2026-12-13" }, { "amount": 100, "date": "2026-12-15" } ], "calculation_type": "amount" } }, "due_date": "2026-12-16", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "amount": 10, "calculation_type": "daily_rate" } }, "expiration_date": "2026-12-30", "external_id": "external id 123", "invoice_type": "invoice", "merchant": { "name": "Merchant Name", "tax_number": "12345678000199" }, "options": { "fee": 0 }, "splits": [ { "counterparty_recipient_id": "0198aaaa-1111-2222-3333-444444444444", "type": "percentage", "value": 70 }, { "counterparty_recipient_id": "0198bbbb-5555-6666-7777-888888888888", "type": "percentage", "value": 30 } ], "wallet_type": "book_entry_electronic_bloquete" }, "properties": { "amount": { "description": "Amount of the boleto in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "counterparty": { "properties": { "address": { "maxLength": 255, "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "city": { "maxLength": 255, "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "district": { "maxLength": 255, "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "name": { "maxLength": 255, "minLength": 3, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "maxLength": 8, "minLength": 8, "pattern": "^[0-9]{8}$", "type": "string", "x-struct": null, "x-validate": null }, "state": { "description": "Allowed values: ACALAPAMBACEDFESGOMAMTMSMGPAPBPRPEPIRJRNRSRORRSCSPSETO", "enum": [ "AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO" ], "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Document must contain only digits with length between 11 and 14", "maxLength": 14, "minLength": 11, "pattern": "^[0-9]{11,14}$", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "tax_number", "name", "address", "district", "city", "state", "postal_code" ], "type": "object", "x-struct": null, "x-validate": null }, "description": { "maxLength": 25, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "due_detail": { "$ref": "#/components/schemas/V2_BoletoDueDetailParams" }, "expiration_date": { "description": "Last day on which the boleto can be paid", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "maxLength": 40, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "invoice_type": { "$ref": "#/components/schemas/Boleto_invoice_type" }, "merchant": { "description": "Merchant to register as the split org merchant. When sent, it is saved.", "nullable": true, "properties": { "name": { "description": "Merchant name", "type": "string", "x-struct": null, "x-validate": null }, "tax_number": { "description": "Merchant tax number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "tax_number" ], "type": "object", "x-struct": null, "x-validate": null }, "notes": { "items": { "type": "string", "x-struct": null, "x-validate": null }, "maxItems": 3, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "options": { "description": "Optional boleto settings", "nullable": true, "properties": { "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "splits": { "description": "Cashin split configurations", "items": { "properties": { "counterparty_recipient_id": { "description": "Counterparty recipient UUID", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Split type", "enum": [ "percentage", "fixed" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage (0-100) or fixed amount in cents", "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "type", "value", "counterparty_recipient_id" ], "type": "object", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "wallet_type": { "$ref": "#/components/schemas/Boleto_wallet_type" } }, "required": [ "bank_account_id", "invoice_type", "wallet_type", "amount", "expiration_date", "counterparty", "due_detail" ], "title": "V2 Boleto_create_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.CreateRequest", "x-validate": null }, "V2_card_top_up_QR_code": { "description": "Pix QR code that tops up a card", "example": { "amount": { "amount": 10000, "currency": "BRL" }, "description": "0197a339-481c-5bc5-7809-3bc11807df2f", "expiration_datetime": "2025-06-24T23:35:30.091799Z", "hash": "00020101021226630014br.gov.bcb.pix2541pix.example.com/cob/01K1BWRSMG89A3TE0SNZFNPMH05204000053039865802BR5910brcodename6010brcodecity62070503***6304E6A4", "id": "0197a339-49ab-27db-a98d-29c56a0c1b1c" }, "properties": { "amount": { "$ref": "#/components/schemas/V2_card_money" }, "description": { "description": "QR code description", "type": "string", "x-struct": null, "x-validate": null }, "expiration_datetime": { "description": "When the QR code expires", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "hash": { "description": "Pix copy and paste code", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "QR code ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "description", "hash", "amount", "expiration_datetime" ], "title": "V2 card top up QR code", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.TopupQrCodeData", "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_Boleto_list": { "description": "Boleto list response", "example": { "data": [ { "amount": { "amount": 10000, "currency": "BRL" }, "bank_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "barcode": "12341111222233334444555566667777888899990000", "boleto_url": "https://example.com/boleto_1", "counterparty": { "id": "000a89cb-f0c9-07ce-79c2-fc049bc253e0" }, "description": "description", "digitable_line": "12341111222233334444555566667777888899990000", "due_detail": { "discount": { "fixed_until_due": { "amounts": [ { "amount": { "amount": 300, "currency": "BRL" }, "date": "2026-12-13" }, { "amount": { "amount": 100, "currency": "BRL" }, "date": "2026-12-15" } ], "calculation_type": "amount" } }, "due_date": "2026-12-16", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "amount": { "amount": 10, "currency": "BRL" }, "calculation_type": "daily_rate" } }, "expiration_date": "2026-12-30", "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d", "fee": { "amount": 0, "currency": "BRL" }, "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49", "inserted_at": "2026-12-01T10:00:00.000000Z", "invoice_type": "invoice", "issue_date": "2026-12-01", "notes": [ "note 1", "note 2", "note 3" ], "status": "confirmed", "updated_at": "2026-12-01T10:00:00.000000Z", "wallet_type": "book_entry_electronic_bloquete" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_Boleto_Response_Params" }, "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 Boleto_list", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.ListResponse", "x-validate": null }, "V2_in_document_type": { "description": "In document type", "enum": [ "pix", "boleto", "ted", "tef", "utility", "tax", "internal", "card", "pix_internal", "pix_automatic", "pix_initiation", "receivable", "pix_boleto" ], "title": "V2 in document type", "type": "string", "x-struct": null, "x-validate": null }, "V2_card_purchase_method_code": { "description": "How the card was read", "enum": [ "unknown", "manual", "magstripe", "barcode", "ocr", "chip", "contactless", "token", "server" ], "nullable": true, "title": "V2 card purchase method code", "type": "string", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Purchase.MethodCode", "x-validate": null }, "V2_RecurrenceRequestEmbeddedData": { "description": "A recurrence request. `stages` is present only when they were loaded.", "example": { "counterparty": { "bank_account": { "id": "019809db-4baf-07f7-7767-e32734e5b636" }, "id": "019809db-4baf-039f-be7a-ed7d1f147ab5" }, "expires_at": "2025-08-13T13:53:43.287296Z", "id": "019809db-4af7-47fc-1add-28b582f08576", "inserted_at": "2025-07-14T16:53:43.471712Z", "status": "created", "updated_at": "2025-07-14T16:53:43.471712Z" }, "properties": { "counterparty": { "description": "Payer the request was sent to", "properties": { "bank_account": { "description": "Payer bank account", "properties": { "id": { "description": "Counterparty bank account ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Counterparty ID", "format": "uuid", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "expires_at": { "description": "When the payer can no longer answer the request", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Request ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the request was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "stages": { "description": "Request stages", "items": { "$ref": "#/components/schemas/V2_RecurrenceRequestStage" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Request status", "enum": [ "created", "sent", "received", "rejected", "accepted", "expired", "cancelled" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the request was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceRequestEmbeddedData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.EmbeddedData", "x-validate": null }, "V2_list_card_invoice_lines_response": { "description": "A page of card invoice lines", "example": { "data": [ { "amount": { "amount": 10000, "currency": "BRL" }, "card_id": "0182b3d1-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "card_number": "•••• •••• •••• 1234", "id": "0182b3d0-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "invoice_id": "0182b3d2-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "line_category": "streaming", "line_status": "confirmed", "line_title": "Streaming service", "occurred_at": "2025-06-20T03:05:00.000000Z", "ref_id": "0182b3d3-0b3b-4b3b-8b3b-0b3b4b3b8b3b", "ref_type": "purchase" } ], "metadata": { "after": null, "before": null, "has_more": false } }, "properties": { "data": { "items": { "$ref": "#/components/schemas/V2_card_invoice_line" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "$ref": "#/components/schemas/V2_card_list_metadata" } }, "required": [ "data", "metadata" ], "title": "V2 list card invoice lines response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.Invoice.ListLineResponse", "x-validate": null }, "V2_transfer_document_status": { "description": "Status of the transfer document", "enum": [ "created", "confirmed", "settled", "refunded", "reversed", "failed" ], "title": "V2 transfer document status", "type": "string", "x-struct": null, "x-validate": null }, "V2_Generate_Utility_async_create_params": { "description": "Body params to generate an async utility", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "code": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Consectetur esse sed irure incididunt est culpa nostrud.", "external_id": "5b760495-cb55-4043-95e8-0cff5776b014" }, "properties": { "amount": { "description": "Amount of the utility in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "code": { "description": "Barcode or digitable_line of the utility", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the utility", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID of the utility for reference", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "bank_account_id", "code" ], "title": "V2 Generate_Utility_async_create_params", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Utility.UtilitySchema.GenerateAsyncRequest", "x-validate": null }, "V2_RecurrenceCollectionResponse": { "description": "Recurrence collection response with stages and attempts", "example": { "data": { "additional_info": "", "amount": { "amount": 0, "currency": "" }, "attempts": [ { "due_date": "2025-07-14", "end_to_end_id": "E33333333202507141500duiiTl1rnpc", "external_id": null, "id": "019809e6-c836-fe49-0b1a-ccd48befb6b8", "inserted_at": "2025-07-14T17:06:16.606122Z", "status": "requested", "transaction_date": null, "updated_at": "2025-07-14T17:06:16.606122Z" } ], "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6", "final_date": "2020-04-20", "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6", "inserted_at": "2020-04-20T16:20:00Z", "next_working_day": false, "recurrence": { "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6" }, "stages": [ { "error_code": null, "error_message": null, "id": "019a0d9e-d21f-5a1e-0c1d-9e5f2b8a7c31", "inserted_at": "2025-10-22T20:31:46.843629Z", "status": "active" } ], "status": "created", "transaction_date": "2020-04-20T16:20:00Z", "updated_at": "2020-04-20T16:20:00Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_RecurrenceCollectionDataWithStages" } }, "title": "V2 RecurrenceCollectionResponse", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Response", "x-validate": null }, "V2_RecurrenceCollectionAttemptData": { "description": "An attempt to charge a recurrence collection. `stages` is present only when asked for with `load_stages`.", "example": { "collection": { "id": "019809e6-c8ef-843e-28fb-9ade27a8043b" }, "due_date": "2025-07-14", "end_to_end_id": "E33333333202507141500duiiTl1rnpc", "external_id": null, "id": "019809e6-c836-fe49-0b1a-ccd48befb6b8", "inserted_at": "2025-07-14T17:06:16.606122Z", "status": "requested", "transaction_date": null, "updated_at": "2025-07-14T17:06:16.606122Z" }, "properties": { "collection": { "description": "Collection the attempt charges", "properties": { "id": { "description": "Collection ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "due_date": { "description": "Day the attempt is due", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "end_to_end_id": { "description": "Pix end to end ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Attempt ID", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "description": "When the attempt was created", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "stages": { "description": "Attempt stages", "items": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptStage" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "Attempt status", "enum": [ "requested", "scheduled", "settled", "cancelled", "rejected", "expired", "failed" ], "type": "string", "x-struct": null, "x-validate": null }, "transaction_date": { "description": "When the attempt was paid", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "When the attempt was last updated", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "V2 RecurrenceCollectionAttemptData", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Attempt.Data", "x-validate": null }, "V2_RecurrenceListData": { "description": "A list data of automatic recurrences", "example": [ { "amounts": { "fixed": { "amount": 10000, "currency": "BRL" }, "maximum": null, "minimum": null }, "authorized_at": null, "bank_account_id": "019f4198-8913-1ec9-52c6-706c618a1c5d", "contract_number": "0001", "counterparty": { "bank_account": { "id": "49521ece-9203-07f7-7767-e32734e5b636" }, "id": "49521ece-9203-186b-cfc7-281c207f7f52" }, "description": "Test Recurrence", "end_date": null, "external_id": null, "first_payment": { "amount": null, "date": "2026-07-10" }, "id": "019f4198-9f53-8f20-a167-5242b634311d", "inserted_at": "2026-07-08T11:59:09.140530Z", "number_of_collections": null, "options": { "automatic_schedule": true, "next_working_day": true, "retry_policy": "none" }, "origin": { "id": "019f4198-9de7-4ba7-d718-5e9fce7cbccb", "type": "api_client" }, "periodicity": "week", "reference": { "id": null, "type": "qrdn" }, "start_date": "2026-07-08", "status": "created", "type": "in", "updated_at": "2026-07-08T11:59:09.140530Z" } ], "items": { "$ref": "#/components/schemas/V2_RecurrenceData" }, "title": "V2 RecurrenceListData", "type": "array", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.ListData", "x-validate": null }, "Counterparty_bank_account_type": { "description": "Type of the counterparty bank account", "items": { "enum": [ "checking", "payment", "salary", "savings" ], "type": "string", "x-struct": null, "x-validate": null }, "title": "Counterparty bank account type", "type": "string", "x-struct": null, "x-validate": null }, "DynamicQRCodeCounterpartyBankAccountCreateParams": { "description": "Counterparty bank account related to a dynamic QRCode", "properties": { "branch": { "description": "Counterparty bank account branch", "type": "string", "x-struct": null, "x-validate": null }, "digit": { "description": "Counterparty bank account digit", "type": "string", "x-struct": null, "x-validate": null }, "ispb": { "description": "Counterparty bank account ISPB", "type": "string", "x-struct": null, "x-validate": null }, "number": { "description": "Counterparty bank account number", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Counterparty bank account type", "enum": [ "checking", "savings", "salary", "payment" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "ispb", "branch", "number", "digit" ], "title": "DynamicQRCodeCounterpartyBankAccountCreateParams", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.Cashin.DynamicBrcode.CounterpartyBankAccountCreateParams", "x-validate": null }, "V2_entity_response": { "description": "An entity for compliance", "example": { "data": { "addresses": [ { "address_additional_details": "Apto 42", "address_line": "Rua das Flores", "address_number": "123", "city_name": "Curitiba", "district": "Centro", "zip_code": "80000000" } ], "business_infos": { "annual_revenue": { "amount": 500000, "currency": "BRL" }, "average_ticket": { "amount": 10000000, "currency": "BRL" }, "company_activity": "6201501", "company_secondary_activity": [ "6202300" ] }, "contact": { "email": "entity@gmail.com", "phone_number": "41999999999" }, "id": "01a163ec-8dd5-8386-b33a-70a4713ecdb2", "inserted_at": "2026-10-22T14:03:29.651178Z", "legal_name": "Entity Test LLC", "status": "approved", "tax_number": "DN0O5N510HG833", "updated_at": "2026-10-22T14:03:29.651187Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_entity" } }, "title": "V2 entity response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.Response", "x-validate": null }, "V2_bank_account_document_metrics": { "description": "Settled and failed document counts", "example": { "failed": 2, "settled": 12 }, "properties": { "failed": { "description": "Failed count", "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "settled": { "description": "Settled count", "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null } }, "title": "V2 bank account document metrics", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Metric.DocumentCounts", "x-validate": null }, "V2_Check_Tax_Response": { "description": "A tax bill checked before it is paid", "example": { "data": { "amount": { "amount": 55415, "currency": "BRL" }, "barcode": "81630000005541525242026031611000003743561145", "counterparty": { "name": "PM MANAUS", "tax_number": "00000001000136" }, "digitable_line": "816300000055541525242023603161100004037435611456", "id": "019cd95f-4169-924a-eda6-438fe041bff8", "inserted_at": "2026-03-10T20:10:24.499784Z", "payer": { "name": "PM MANAUS", "tax_number": "00000001000136" }, "type": "tax", "updated_at": "2026-03-10T20:10:24.499784Z" } }, "properties": { "data": { "properties": { "amount": { "description": "Tax bill amount", "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 }, "payer": { "description": "Payer the tax bill 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 }, "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_Tax_Response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Tax.TaxSchema.CheckResponse", "x-validate": null }, "V2_card_nullable_money": { "description": "An amount of money in cents, or null when it was not recorded", "example": { "amount": 10000, "currency": "BRL" }, "nullable": true, "properties": { "amount": { "description": "Amount in cents", "type": "integer", "x-struct": null, "x-validate": null }, "currency": { "description": "Currency", "enum": [ "BRL" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "currency" ], "title": "V2 card nullable money", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.NullableMoney", "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_Org_webhook_response": { "description": "A webhook the org receives its events at", "example": { "data": { "api_version": "v100", "authentication_method": "url_secret", "entity_id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7c", "event_categories_allowed": [ { "category": "boleto", "types": [ "settled", "created" ] } ], "group_id": null, "id": "019a1c2e-5b7d-7f80-9a1b-2c3d4e5f6a7b", "inserted_at": "2026-10-01T12:00:00.000000Z", "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==", "notification_secret": "some_notification_secret", "notification_url": "https://mynotificationurl.com/endpoint", "updated_at": "2026-10-01T12:00:00.000000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_Org_webhook" } }, "title": "V2 Org webhook response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.IAM.V2.OrgWebhook.Response", "x-validate": null }, "Boleto_invoice_type": { "description": "Boleto invoice type", "enum": [ "commercial_duplicate", "indicated_commercial_duplicate", "service_duplicate", "indicated_service_duplicate", "rural_duplicate", "bill_of_exchange", "commercial_credit_note", "export_credit_note", "industrial_credit_note", "rural_credit_note", "promissory_note", "rural_promissory_note", "triplicate_commercial", "triplicate_service", "insurance_note", "receipt", "invoice", "debit_note", "insurance_policy", "school_fee", "consortium_installment", "invoice_note", "debt_document", "rural_product_certificate", "warrant", "state_active_debt", "municipal_active_debt", "federal_active_debt", "condominium_fee", "credit_card", "others" ], "nullable": true, "title": "Boleto_invoice_type", "type": "string", "x-struct": null, "x-validate": null }, "RecurrenceRetryPolicy": { "description": "Types of recurrence retry policy", "enum": [ "none", "3r_7d" ], "title": "RecurrenceRetryPolicy", "type": "string", "x-struct": null, "x-validate": null }, "DynamicQRCodeWithDueCounterpartyInfo": { "description": "Additional counterparty information printed on the QRCode with due date", "nullable": true, "properties": { "address": { "description": "Counterparty address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "Counterparty city", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "email": { "description": "Counterparty email", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Counterparty postal code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "state": { "description": "Counterparty state (UF)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "DynamicQRCodeWithDueCounterpartyInfo", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V1.Cashin.DynamicBrcodeWithDue.CounterpartyInfo", "x-validate": null }, "V2_in_document_origin_type": { "description": "Who or what originated the in document", "enum": [ "none", "api_client", "console_user", "billing", "reconciliation", "checkout", "bridge", "boleto", "cnab" ], "title": "V2 in document origin type", "type": "string", "x-struct": null, "x-validate": null }, "V2_PixDueDetail": { "description": "Due detail of a Pix charge with due date. `due_date` is always present; each rule only when set. A rule has `amount` (money) for the `amount` calculation type and `value` (basis points, 100 = 1%) for `percentage`.", "example": { "discount": { "per_day_antecipated": { "amount": { "amount": 50, "currency": "BRL" }, "calculation_days": "working", "calculation_type": "amount" } }, "due_date": "2026-09-30", "fine": { "calculation_type": "percentage", "value": 200 }, "interest": { "calculation_days": "calendar", "calculation_period": "month", "calculation_type": "percentage", "value": 100 } }, "properties": { "discount": { "description": "Discount for payments before the due date; only one option is set", "properties": { "fixed_until_due": { "description": "Discount granted until each date", "properties": { "amounts": { "items": { "properties": { "amount": { "description": "Amount, for the `amount` calculation type", "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 }, "date": { "description": "Last date on which the discount applies", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType" } }, "type": "object", "x-struct": null, "x-validate": null }, "per_day_antecipated": { "description": "Discount per day paid in advance", "properties": { "amount": { "description": "Amount, for the `amount` calculation type", "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 }, "calculation_days": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationDays" }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailDiscountCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "due_date": { "description": "Due date", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "fine": { "description": "Fine charged after the due date", "properties": { "amount": { "description": "Amount, for the `amount` calculation type", "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 }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailFineCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "interest": { "description": "Interest charged after the due date", "properties": { "amount": { "description": "Amount, for the `amount` calculation type", "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 }, "calculation_days": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailInterestCalculationDays" }, "calculation_period": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailInterestCalculationPeriod" }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailInterestCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "rebate": { "description": "Rebate applied to the amount", "properties": { "amount": { "description": "Amount, for the `amount` calculation type", "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 }, "calculation_type": { "$ref": "#/components/schemas/DynamicBrcodeDueDetailRebateCalculationType" }, "value": { "description": "Percentage in basis points (100 = 1%), for the `percentage` calculation type", "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "due_date" ], "title": "V2 PixDueDetail", "type": "object", "x-struct": null, "x-validate": null }, "V2_Generate_Tax": { "description": "Body params to generate a tax payment", "example": { "amount": 100, "bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010", "check_id": "4b760495-cb55-4043-95e8-0cff5776b013", "description": "Magna dolor velit duis velit ad elit anim laborum aliqua.", "external_id": "10760495-cb95-4023-96e9-0cff5776b011" }, "properties": { "amount": { "description": "Amount of the tax in cents", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "bank_account_id": { "$ref": "#/components/schemas/UUID" }, "check_id": { "$ref": "#/components/schemas/UUID" }, "description": { "description": "Description for the tax", "type": "string", "x-struct": null, "x-validate": null }, "external_id": { "description": "External ID for reference", "type": "string", "x-struct": null, "x-validate": null }, "fee": { "description": "Fee", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "amount", "check_id", "bank_account_id" ], "title": "V2 Generate_Tax", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashout.Tax.TaxSchema.GenerateRequest", "x-validate": null }, "V2_card_top_up_QR_code_response": { "description": "The QR code created", "example": { "data": { "amount": { "amount": 10000, "currency": "BRL" }, "description": "0197a339-481c-5bc5-7809-3bc11807df2f", "expiration_datetime": "2025-06-24T23:35:30.091799Z", "hash": "00020101021226630014br.gov.bcb.pix2541pix.example.com/cob/01K1BWRSMG89A3TE0SNZFNPMH05204000053039865802BR5910brcodename6010brcodecity62070503***6304E6A4", "id": "0197a339-49ab-27db-a98d-29c56a0c1b1c" } }, "properties": { "data": { "$ref": "#/components/schemas/V2_card_top_up_QR_code" } }, "required": [ "data" ], "title": "V2 card top up QR code response", "type": "object", "x-struct": "Elixir.TrioFoundationWeb.Schemas.Banking.V2.Card.TopUpBalanceQrcodeResponse", "x-validate": null } }, "securitySchemes": { "authorization": { "scheme": "basic", "type": "http" } } }, "info": { "title": "Trio API v2", "version": "2026-10-19.v2" }, "openapi": "3.0.0", "paths": { "/v2/documents/in/{id}/refund": { "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": { "callbacks": {}, "description": "Refund an in document", "operationId": "TrioFoundationWeb.V2.Documents.InController.refund", "parameters": [ { "description": "In document", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund_creation_body_params" } } }, "description": "Refund creation attributes", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_created_in_document_refund_response" } } }, "description": "Document" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Refund an in document", "tags": [ "Documents", "In", "Refunds" ] } }, "/v2/in/boletos": { "get": { "callbacks": {}, "description": "List all available boletos", "operationId": "TrioFoundationWeb.V2.In.BoletoController.index", "parameters": [ { "description": "Entity UUID", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Bank account UUID", "in": "query", "name": "bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Group UUID", "in": "query", "name": "group_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "External ID", "in": "query", "name": "external_id", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Counterparty ID", "in": "query", "name": "counterparty_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Status", "in": "query", "name": "status", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "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": "Search term", "in": "query", "name": "search_term", "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": "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 } }, { "description": "Query limit, default is 50 and max is 100", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_list" } } }, "description": "Boletos" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List boletos", "tags": [ "Receivables (in)", "Boletos" ] }, "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": { "callbacks": {}, "description": "Creates a new boleto", "operationId": "TrioFoundationWeb.V2.In.BoletoController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_create_params" } } }, "description": "Boleto payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_Response" } } }, "description": "Created" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create boleto", "tags": [ "Receivables (in)", "Boletos" ] } }, "/v2/counterparties/{counterparty_id}/bank_accounts/{counterparty_bank_account_id}": { "get": { "callbacks": {}, "description": "Show a counterparty bank account", "operationId": "TrioFoundationWeb.V2.Counterparty.BankAccountController.show", "parameters": [ { "description": "Counterparty ID", "in": "path", "name": "counterparty_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Counterparty bank account ID", "in": "path", "name": "counterparty_bank_account_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_counterparty_bank_account_response" } } }, "description": "CounterpartyBankAccount" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show counterparty bank account", "tags": [ "Counterparties" ] }, "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 } } ] }, "/v2/pix/keys/{id}": { "get": { "callbacks": {}, "description": "Get a specific key", "operationId": "TrioFoundationWeb.V2.Pix.KeyController.show", "parameters": [ { "description": "Pix Key ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_Key_single_response" } } }, "description": "Key" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a specific key", "tags": [ "Pix Keys" ] }, "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 } } ] }, "/v2/in/boletos/{id}/protest/add": { "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 } } ], "put": { "callbacks": {}, "description": "Add protest to a boleto", "operationId": "TrioFoundationWeb.V2.In.BoletoController.add_protest", "parameters": [ { "description": "Boleto Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Add protest", "tags": [ "Receivables (in)", "Boletos", "Protest" ] } }, "/v2/in/pix/qrcodes/static": { "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": { "callbacks": {}, "description": "Create a new static QRCode", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.StaticController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Static_QRCode_payload" } } }, "description": "The static QRCode payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Static_QRCode_single_response" } } }, "description": "StaticBrcode" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create a new static QRCode", "tags": [ "Receivables (in)", "Pix", "Static" ] } }, "/v2/out/pix/async": { "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": { "callbacks": {}, "description": "Generates an async pix payment", "operationId": "TrioFoundationWeb.V2.Out.PixController.generate_async", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_pix_async_create_params" } } }, "description": "The async pix generation attributes", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_pix_response" } } }, "description": "GeneratePix" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Generate an async pix payment", "tags": [ "Payments (out)", "Pix" ] } }, "/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": { "callbacks": {}, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Check boleto", "tags": [ "Payments (out)", "Boleto" ] } }, "/v2/documents/out": { "get": { "callbacks": {}, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List all out documents", "tags": [ "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 } } ] }, "/v2/webhooks": { "get": { "callbacks": {}, "description": "Lists every webhook of the org, in a single page: the list is not paginated", "operationId": "TrioFoundationWeb.V2.IAM.OrgWebhookController.index", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Authentication method", "in": "query", "name": "authentication_method", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Org_webhook_list" } } }, "description": "Webhook list" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List org webhooks", "tags": [ "Webhooks" ] }, "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": { "callbacks": {}, "description": "Create org webhook", "operationId": "TrioFoundationWeb.V2.IAM.OrgWebhookController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Org_webhook_creation_parameters" } } }, "description": "Org webhook parameters", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Org_webhook_response" } } }, "description": "Created webhook" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create org webhook", "tags": [ "Webhooks" ] } }, "/v2/in/pix/qrcodes/{id}": { "get": { "callbacks": {}, "description": "Gets a specific dynamic QRCode", "operationId": "TrioFoundationWeb.V2.In.Pix.QrcodeController.show", "parameters": [ { "description": "QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeResponse" } } }, "description": "Dynamic" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a specific dynamic QRCode", "tags": [ "Receivables (in)", "Pix" ] }, "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 } } ], "put": { "callbacks": {}, "description": "Updates a dynamic pix QRCode", "operationId": "TrioFoundationWeb.V2.In.Pix.QrcodeController.update", "parameters": [ { "description": "BrCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeUpdateParams" } } }, "description": "The dynamic brcode attributes", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Update a dynamic pix QRCode", "tags": [ "Receivables (in)", "Pix" ] } }, "/v2/cards/purchases/{id}": { "get": { "callbacks": {}, "description": "Show Card purchase document by id", "operationId": "TrioFoundationWeb.V2.Card.PurchaseController.show", "parameters": [ { "description": "Document ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_purchase_response" } } }, "description": "Document" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show Card purchase document by id", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/cards/purchases": { "get": { "callbacks": {}, "description": "List Card purchase documents", "operationId": "TrioFoundationWeb.V2.Card.PurchaseController.index", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Purchases made from this moment on", "in": "query", "name": "from_datetime", "required": true, "schema": { "$ref": "#/components/schemas/DATETIME" } }, { "description": "Purchases made up to this moment", "in": "query", "name": "to_datetime", "required": true, "schema": { "$ref": "#/components/schemas/DATETIME" } }, { "description": "Card ID", "in": "query", "name": "card_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Category Code", "in": "query", "name": "category_code", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Category Type", "in": "query", "name": "category_type", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "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 } }, { "description": "Parameter used for pagination.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Status", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/V2_card_purchase_status" } }, { "description": "Order by", "in": "query", "name": "order_by", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_card_purchases_response" } } }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List Card purchase documents", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/documents/out/{id}": { "get": { "callbacks": {}, "description": "Get an out document", "operationId": "TrioFoundationWeb.V2.Documents.OutController.show", "parameters": [ { "description": "Out document ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_out_document_response" } } }, "description": "Document" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get an out document", "tags": [ "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 } } ] }, "/v2/in/pix/recurrences/collections": { "get": { "callbacks": {}, "description": "List recurrence collections with parameters", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.index", "parameters": [ { "description": "Entity Id", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Recurrence Id", "in": "query", "name": "recurrence_id", "required": true, "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": "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 } }, { "description": "Number of registries to be returned", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceCollectionListResponse" } } }, "description": "Collections" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List recurrence collections", "tags": [ "Receivables (in)", "Recurrences", "Collections" ] }, "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 } } ] }, "/v2/cards/purchases/e2e/{id}": { "get": { "callbacks": {}, "description": "Show card purchase document by end to end id ", "operationId": "TrioFoundationWeb.V2.Card.PurchaseController.show_by_end_to_end_id", "parameters": [ { "description": "End to End ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/V2_card_purchase_end_to_end_id" } }, { "description": "When the purchase was made, its `purchased_at`", "in": "query", "name": "timestamp", "required": true, "schema": { "$ref": "#/components/schemas/DATETIME" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_purchase_response" } } }, "description": "Document" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show card purchase document by end to end id", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/documents/in": { "get": { "callbacks": {}, "description": "List all in documents", "operationId": "TrioFoundationWeb.V2.Documents.InController.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_in_document_ref_type" } }, { "description": "In document status", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/V2_in_document_status" } }, { "description": "In document type", "in": "query", "name": "type", "required": false, "schema": { "$ref": "#/components/schemas/V2_in_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_in_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)." } }, "security": [ { "authorization": [] } ], "summary": "List all in documents", "tags": [ "Documents", "In" ] }, "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 } } ] }, "/v2/bank_accounts/{id}": { "get": { "callbacks": {}, "description": "Shows a bank account", "operationId": "TrioFoundationWeb.V2.BankAccountController.show", "parameters": [ { "description": "Bank account ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_bank_account_response" } } }, "description": "Bank account" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show bank account", "tags": [ "Bank Accounts" ] }, "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 } } ], "put": { "callbacks": {}, "description": "Update bank account parameters", "operationId": "TrioFoundationWeb.V2.BankAccountController.update", "parameters": [ { "description": "Bank account ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParametersParams" } } }, "description": "The update bank account parameters payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_bank_account_parameters_response" } } }, "description": "Bank account parameters" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Update bank account parameters", "tags": [ "Bank Accounts" ] } }, "/v2/out/utility/async": { "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": { "callbacks": {}, "description": "Generate an async pay utility", "operationId": "TrioFoundationWeb.V2.Out.UtilityController.generate_async", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Utility_async_create_params" } } }, "description": "Utility payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Utility_Response" } } }, "description": "Requested" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay utility async", "tags": [ "Payments (out)", "Utility" ] } }, "/v2/out/utility": { "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": { "callbacks": {}, "description": "Generate a pay utility", "operationId": "TrioFoundationWeb.V2.Out.UtilityController.generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Utility" } } }, "description": "Utility payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Utility_Response" } } }, "description": "Created" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay utility", "tags": [ "Payments (out)", "Utility" ] } }, "/v2/cards/{id}/cancel": { "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": { "callbacks": {}, "description": "Cancel an existing card", "operationId": "TrioFoundationWeb.V2.CardController.cancel", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "Canceled" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Cancel a card", "tags": [ "Cards" ] } }, "/v2/in/pix/qrcodes/static/{id}/hash": { "get": { "callbacks": {}, "description": "Gets a static QRCode hash", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.StaticController.get_hash", "parameters": [ { "description": "Static QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_static_QRCode_hash_response" } } }, "description": "Hash" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a QRCode static hash", "tags": [ "Receivables (in)", "Pix", "Static" ] }, "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 } } ] }, "/v2/counterparty_recipients/{id}": { "get": { "callbacks": {}, "description": "Show a counterparty recipient", "operationId": "TrioFoundationWeb.V2.CounterpartyRecipientController.show", "parameters": [ { "description": "Counterparty recipient ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Counterparty_recipient_response" } } }, "description": "CounterpartyRecipient" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show counterparty recipient", "tags": [ "Counterparties", "Split Recipients" ] }, "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 } } ] }, "/v2/in/pix/qrcodes/with_due/{id}/image": { "get": { "callbacks": {}, "description": "Gets the image of a dynamic pix QRCode with due date", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.WithDueController.get_image", "parameters": [ { "description": "Dynamic Pix QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_dynamic_QRCode_image_response" } } }, "description": "Image" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get dynamic pix QRCode with due date image", "tags": [ "Receivables (in)", "Pix", "With Due" ] }, "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 } } ] }, "/v2/in/pix/qrcodes": { "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": { "callbacks": {}, "description": "Creates a new dynamic pix QRCode", "operationId": "TrioFoundationWeb.V2.In.Pix.QrcodeController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeCreateParams" } } }, "description": "Pix QRCode payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeResponse" } } }, "description": "Pix QRCode" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create a new dynamic pix QRCode", "tags": [ "Receivables (in)", "Pix" ] } }, "/v2/cards/{id}/topup/qrcode": { "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": { "callbacks": {}, "description": "Generate QR Code for Card Top Up card balance", "operationId": "TrioFoundationWeb.V2.CardController.topup_qrcode", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_top_up_balance_via_qrcode_params" } } }, "description": "Top Up Card Balance QR Code", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_top_up_QR_code_response" } } }, "description": "Topup QR Code" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Generate QR Code for Card Top Up card balance", "tags": [ "Cards" ] } }, "/v2/out/boleto/async": { "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": { "callbacks": {}, "description": "Generate an async pay boleto", "operationId": "TrioFoundationWeb.V2.Out.BoletoController.generate_async", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Boleto_async_create_params" } } }, "description": "Boleto payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Boleto_Response" } } }, "description": "Requested" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay boleto async", "tags": [ "Payments (out)", "Boleto" ] } }, "/v2/onboarding/documents": { "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": { "callbacks": {}, "description": "Uploads a PDF document the onboarding asked for, of the entity or of one of its representatives", "operationId": "TrioFoundationWeb.V2.Onboarding.OnboardController.create_document", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/V2_onboarding_document_upload_params" } } }, "description": "Document parameters and binary file", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_onboarding_document_upload_response" } } }, "description": "Document uploaded successfully" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Upload onboarding document", "tags": [ "Onboarding" ] } }, "/v2/bank_accounts/{id}/balances": { "get": { "callbacks": {}, "description": "Gets the available balance of a bank account at a date and time (now by default), with its current balances and limits", "operationId": "TrioFoundationWeb.V2.BankAccount.BalanceController.balance", "parameters": [ { "description": "Bank account ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Date and time of the available balance; now when absent", "in": "query", "name": "at_datetime", "required": false, "schema": { "$ref": "#/components/schemas/DATETIME" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_bank_account_balance_response" } } }, "description": "BalanceResponse" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get bank account balance", "tags": [ "Bank Accounts", "Balances" ] }, "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 } } ] }, "/v2/in/boletos/{id}": { "get": { "callbacks": {}, "description": "Gets a specific boleto", "operationId": "TrioFoundationWeb.V2.In.BoletoController.show", "parameters": [ { "description": "Boleto Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_Response" } } }, "description": "Show" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get boleto", "tags": [ "Receivables (in)", "Boletos" ] }, "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 } } ], "put": { "callbacks": {}, "description": "Changes the due date of a boleto. To change its amount, recreate it.", "operationId": "TrioFoundationWeb.V2.In.BoletoController.update", "parameters": [ { "description": "Boleto Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_update_params" } } }, "description": "The new due date", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Update boleto due date", "tags": [ "Receivables (in)", "Boletos" ] } }, "/v2/bank_accounts/{id}/metrics": { "get": { "callbacks": {}, "description": "Get settled and failed totals for in, out and transfer documents", "operationId": "TrioFoundationWeb.V2.BankAccount.MetricController.index", "parameters": [ { "description": "Bank account ID", "in": "path", "name": "id", "required": true, "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_bank_account_metrics_response" } } }, "description": "Metrics" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get bank account metrics", "tags": [ "Bank Accounts", "Metrics" ] }, "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 } } ] }, "/v2/documents/transfer/{id}": { "get": { "callbacks": {}, "description": "Gets a transfer document", "operationId": "TrioFoundationWeb.V2.Documents.TransferController.show", "parameters": [ { "description": "Document UUID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_transfer_document_response" } } }, "description": "Document" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a transfer document", "tags": [ "Documents", "Transfer" ] }, "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 } } ] }, "/v2/documents/in/refunds": { "get": { "callbacks": {}, "description": "List all in document refunds", "operationId": "TrioFoundationWeb.V2.Documents.In.RefundController.index", "parameters": [ { "description": "Bank account ID. When omitted, lists the refunds of every bank account of the organization.", "in": "query", "name": "bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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" } }, { "description": "Reconciliation ID", "in": "query", "name": "reconciliation_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Filter by MED refunds. true returns only MED refunds, false returns the others. When omitted, refunds are not filtered by MED", "in": "query", "name": "med", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } }, { "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_in_document_refunds_response" } } }, "description": "Refunds" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List all in document refunds", "tags": [ "Documents", "In", "Refunds" ] }, "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 } } ] }, "/v2/cards/invoices/{id}/export": { "get": { "callbacks": {}, "description": "Generate Card Invoice Statement CSV URL for an invoice", "operationId": "TrioFoundationWeb.V2.Card.InvoiceController.export", "parameters": [ { "description": "Invoice ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Card ID", "in": "query", "name": "card_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_invoice_statement_CSV_response" } } }, "description": "Statement" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Generate Card Invoice Statement CSV URL", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/in/pix/recurrences": { "get": { "callbacks": {}, "description": "List recurrences with parameters", "operationId": "TrioFoundationWeb.V2.In.Pix.RecurrenceController.index", "parameters": [ { "description": "Recurrence Entity Id", "in": "query", "name": "entity_id", "required": false, "schema": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Bank Account Id", "in": "query", "name": "bank_account_id", "required": false, "schema": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Recurrence datetime, lower bound for the list of recurrences", "in": "query", "name": "from_datetime", "required": true, "schema": { "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Recurrence datetime, upper bound for the list of recurrences", "in": "query", "name": "to_datetime", "required": true, "schema": { "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, { "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 } }, { "description": "Number of registries to be returned", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceListResponse" } } }, "description": "Recurrences" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List recurrences", "tags": [ "Receivables (in)", "Recurrences" ] }, "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": { "callbacks": {}, "description": "Generate a recurrence", "operationId": "TrioFoundationWeb.V2.In.Pix.RecurrenceController.generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_GenerateRecurrenceParameters" } } }, "description": "The recurrence generate attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_GenerateRecurrenceResponse" } } }, "description": "Generate Recurrence Response" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Generate a recurrence", "tags": [ "Receivables (in)", "Recurrences" ] } }, "/v2/pix/keys/{id}/confirm": { "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 } } ], "put": { "callbacks": {}, "description": "Confirms a key", "operationId": "TrioFoundationWeb.V2.Pix.KeyController.confirm", "parameters": [ { "description": "Pix Key ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_Key_confirm_payload" } } }, "description": "The key attributes", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Confirm pix key", "tags": [ "Pix Keys", "Confirm" ] } }, "/v2/in/boletos/{id}/cancel": { "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": { "callbacks": {}, "description": "Cancel a boleto", "operationId": "TrioFoundationWeb.V2.In.BoletoController.cancel", "parameters": [ { "description": "Boleto Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Cancel boleto", "tags": [ "Receivables (in)", "Boletos" ] } }, "/v2/counterparties/{counterparty_id}/bank_accounts": { "get": { "callbacks": {}, "description": "Lists counterparty bank accounts by counterparty ID", "operationId": "TrioFoundationWeb.V2.Counterparty.BankAccountController.index", "parameters": [ { "description": "Counterparty ID", "in": "path", "name": "counterparty_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_counterparty_bank_account_list_response" } } }, "description": "CounterpartyBankAccount" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List counterparty bank accounts", "tags": [ "Counterparties" ] }, "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": { "callbacks": {}, "description": "Creates a counterparty bank account", "operationId": "TrioFoundationWeb.V2.Counterparty.BankAccountController.create", "parameters": [ { "description": "Counterparty ID", "in": "path", "name": "counterparty_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_counterparty_bank_account_create_params" } } }, "description": "The create counterparty bank account attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_counterparty_bank_account_response" } } }, "description": "CounterpartyBankAccount" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create counterparty bank account", "tags": [ "Counterparties" ] } }, "/v2/documents/out/refunds": { "get": { "callbacks": {}, "description": "List out document refunds", "operationId": "TrioFoundationWeb.V2.Documents.Out.RefundController.index", "parameters": [ { "description": "Bank account ID. When omitted, lists the refunds of every bank account of the organization.", "in": "query", "name": "bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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" } }, { "description": "Reconciliation ID", "in": "query", "name": "reconciliation_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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_out_document_refunds_response" } } }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List out document refunds", "tags": [ "Documents", "Out", "Refunds" ] }, "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 } } ] }, "/v2/pledged/advance_requests/{id}/cancel": { "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": { "callbacks": {}, "description": "Cancel a pledged advance request", "operationId": "TrioFoundationWeb.V2.Pledged.AdvanceRequestController.cancel", "parameters": [ { "description": "Advance request ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Cancel a pledged advance request", "tags": [ "Pledged" ] } }, "/v2/pledged/advance_requests/{id}": { "get": { "callbacks": {}, "description": "Get a pledged advance request", "operationId": "TrioFoundationWeb.V2.Pledged.AdvanceRequestController.show", "parameters": [ { "description": "Advance request ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_pledged_advance_request_response" } } }, "description": "Advance request" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a pledged advance request", "tags": [ "Pledged" ] }, "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 } } ] }, "/v2/documents/in/{id}": { "get": { "callbacks": {}, "description": "Get an in document", "operationId": "TrioFoundationWeb.V2.Documents.InController.show", "parameters": [ { "description": "The document that wants to be retrieved", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_in_document_response" } } }, "description": "Document" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get an in document", "tags": [ "Documents", "In" ] }, "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 } } ] }, "/v2/pix/keys": { "get": { "callbacks": {}, "description": "List all available Pix keys", "operationId": "TrioFoundationWeb.V2.Pix.KeyController.index", "parameters": [ { "description": "Bank account ID", "in": "query", "name": "bank_account_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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_Pix_Key_list_response" } } }, "description": "Keys" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List Pix keys", "tags": [ "Pix Keys" ] }, "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": { "callbacks": {}, "description": "Creates a new pix key", "operationId": "TrioFoundationWeb.V2.Pix.KeyController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_Key_create_payload" } } }, "description": "Pix Key payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_Key_single_response" } } }, "description": "Key" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Creates a new pix key", "tags": [ "Pix Keys" ] } }, "/v2/out/pix": { "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": { "callbacks": {}, "description": "Generates a pix payment", "operationId": "TrioFoundationWeb.V2.Out.PixController.generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_pix_create_params" } } }, "description": "Pix payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_pix_response" } } }, "description": "GeneratePix" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Generate a pix payment", "tags": [ "Payments (out)", "Pix" ] } }, "/v2/entities": { "get": { "callbacks": {}, "description": "List entities by org ID", "operationId": "TrioFoundationWeb.V2.EntityController.index", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_entity_list_response" } } }, "description": "Entities" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List entities", "tags": [ "Entities" ] }, "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 } } ] }, "/v2/out/pix/brcodes/{id}": { "get": { "callbacks": {}, "description": "Gets a specific check brcode hash", "operationId": "TrioFoundationWeb.V2.Out.Pix.BrcodeController.show", "parameters": [ { "description": "Check brcode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_brcode_check_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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a specific check brcode hash", "tags": [ "Payments (out)", "Pix", "Brcodes" ] }, "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 } } ] }, "/v2/webhooks/{webhook_id}": { "delete": { "callbacks": {}, "description": "Delete org webhook", "operationId": "TrioFoundationWeb.V2.IAM.OrgWebhookController.delete", "parameters": [ { "description": "Webhook ID", "in": "path", "name": "webhook_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity ID", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "Response" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Delete org webhook", "tags": [ "Webhooks" ] }, "get": { "callbacks": {}, "description": "Get org webhook", "operationId": "TrioFoundationWeb.V2.IAM.OrgWebhookController.show", "parameters": [ { "description": "Webhook ID", "in": "path", "name": "webhook_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Org_webhook_response" } } }, "description": "Gotten webhook" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get org webhook by ID", "tags": [ "Webhooks" ] }, "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 } } ], "put": { "callbacks": {}, "description": "Replaces the webhook with the one sent: send every field, as an omitted field is cleared", "operationId": "TrioFoundationWeb.V2.IAM.OrgWebhookController.update", "parameters": [ { "description": "Webhook ID", "in": "path", "name": "webhook_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Org_webhook_update_parameters" } } }, "description": "Org webhook update parameters", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Org_webhook_response" } } }, "description": "Updated webhook" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Replace org webhook", "tags": [ "Webhooks" ] } }, "/v2/in/pix/recurrences/requests/{id}": { "get": { "callbacks": {}, "description": "Get recurrence request", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.RequestController.show", "parameters": [ { "description": "Request ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity Id", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Group Id", "in": "query", "name": "group_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Bank Account Id", "in": "query", "name": "bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Load stages?", "in": "query", "name": "load_stages", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceRequestResponse" } } }, "description": "Request" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get recurrence request", "tags": [ "Receivables (in)", "Recurrences" ] }, "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 } } ] }, "/v2/cards/{id}/block": { "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": { "callbacks": {}, "description": "Block an existing card", "operationId": "TrioFoundationWeb.V2.CardController.block", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "Blocked" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Block a card", "tags": [ "Cards" ] } }, "/v2/in/pix/recurrences/collections/attempts/{id}": { "get": { "callbacks": {}, "description": "Get recurrence collection attempt", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.Collection.AttemptController.show", "parameters": [ { "description": "Attempt ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity UUID", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Load stages?", "in": "query", "name": "load_stages", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptResponse" } } }, "description": "Collection" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get recurrence collection attempt", "tags": [ "Receivables (in)", "Recurrences", "Collections", "Attempts" ] }, "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 } } ] }, "/v2/cards": { "get": { "callbacks": {}, "description": "List cards, without their balance. Read a card for its balance.", "operationId": "TrioFoundationWeb.V2.CardController.index", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Card Last Four Digits", "in": "query", "name": "card_last_digits", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Card Display Name", "in": "query", "name": "display_name", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Card Holder Name", "in": "query", "name": "holder_name", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Card Holder Tax Number", "in": "query", "name": "holder_tax_number", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "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 } }, { "description": "Parameter used for pagination.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_cards_response" } } }, "description": "Cards" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List cards", "tags": [ "Cards" ] }, "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": { "callbacks": {}, "description": "Create a new card", "operationId": "TrioFoundationWeb.V2.CardController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_create_params" } } }, "description": "Create Card", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_response" } } }, "description": "Card" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create a card", "tags": [ "Cards" ] } }, "/v2/cards/invoices": { "get": { "callbacks": {}, "description": "List Card Invoices", "operationId": "TrioFoundationWeb.V2.Card.InvoiceController.index", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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 } }, { "description": "Parameter used for pagination.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_card_invoices_response" } } }, "description": "Invoices" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List Card Invoices", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/in/pix/qrcodes/{id}/image": { "get": { "callbacks": {}, "description": "Gets a dynamic pix QRCode image", "operationId": "TrioFoundationWeb.V2.In.Pix.QrcodeController.get_image", "parameters": [ { "description": "Dynamic Pix QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_dynamic_QRCode_image_response" } } }, "description": "Image" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get dynamic pix QRCode image", "tags": [ "Receivables (in)", "Pix" ] }, "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 } } ] }, "/v2/cards/{id}/transfer_balance": { "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": { "callbacks": {}, "description": "Transfer card balance to another card", "operationId": "TrioFoundationWeb.V2.CardController.transfer_balance", "parameters": [ { "description": "ID of the card the balance leaves", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_transfer_balance_params" } } }, "description": "Transfer Card Balance", "required": true }, "responses": { "204": { "description": "Transferred" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Transfer card balance to another card", "tags": [ "Cards" ] } }, "/v2/entities/{id}": { "get": { "callbacks": {}, "description": "Shows an entity", "operationId": "TrioFoundationWeb.V2.EntityController.show", "parameters": [ { "description": "Entity ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_entity_response" } } }, "description": "Entity" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show entity", "tags": [ "Entities" ] }, "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 } } ] }, "/v2/in/pix/qrcodes/with_due": { "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": { "callbacks": {}, "description": "Creates a new dynamic pix QRCode with due date, allowing fine, interest, rebate and discount rules", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.WithDueController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeWithDueCreateParams" } } }, "description": "Pix QRCode with due date payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeWithDueResponse" } } }, "description": "Pix QRCode with due date" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create a new dynamic pix QRCode with due date", "tags": [ "Receivables (in)", "Pix", "With Due" ] } }, "/v2/cards/invoices/current": { "get": { "callbacks": {}, "description": "Get Card current Invoice", "operationId": "TrioFoundationWeb.V2.Card.InvoiceController.get_current", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_invoice_response" } } }, "description": "Invoice" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get Card current Invoice", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/out/tax": { "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": { "callbacks": {}, "description": "Generate a pay tax", "operationId": "TrioFoundationWeb.V2.Out.TaxController.generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Tax" } } }, "description": "Tax payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Tax_Response" } } }, "description": "Created" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay tax", "tags": [ "Payments (out)", "Tax" ] } }, "/v2/cards/{id}/info": { "get": { "callbacks": {}, "description": "Card sensitive information: holder name, card number, expiration date and cvv", "operationId": "TrioFoundationWeb.V2.CardController.show_sensitive_info", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_sensitive_data_response" } } }, "description": "Card Details" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get card details", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/in/boletos/{id}/recreate": { "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": { "callbacks": {}, "description": "Cancels a boleto and creates a new one with the same fields, the new amount and the new due date (or the current one)", "operationId": "TrioFoundationWeb.V2.In.BoletoController.recreate", "parameters": [ { "description": "Boleto Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_recreate_params" } } }, "description": "The new amount and due date", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Boleto_Response" } } }, "description": "Recreated" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Recreate boleto", "tags": [ "Receivables (in)", "Boletos" ] } }, "/v2/in/boletos/{id}/protest/remove": { "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 } } ], "put": { "callbacks": {}, "description": "Remove protest from a boleto", "operationId": "TrioFoundationWeb.V2.In.BoletoController.remove_protest", "parameters": [ { "description": "Boleto Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Remove protest", "tags": [ "Receivables (in)", "Boletos", "Protest" ] } }, "/v2/documents/transfer": { "get": { "callbacks": {}, "description": "List transfer documents", "operationId": "TrioFoundationWeb.V2.Documents.TransferController.index", "parameters": [ { "description": "From bank account ID", "in": "query", "name": "from_bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "To bank account ID", "in": "query", "name": "to_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": "External ID", "in": "query", "name": "external_id", "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": "Status", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/V2_transfer_document_status" } }, { "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_transfer_documents_response" } } }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List transfer documents", "tags": [ "Documents", "Transfer" ] }, "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 } } ] }, "/v2/out/pix/brcodes/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": { "callbacks": {}, "description": "Checks a brcode hash", "operationId": "TrioFoundationWeb.V2.Out.Pix.BrcodeController.check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_brcode_check_params" } } }, "description": "Check brcode payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_brcode_check_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)." } }, "security": [ { "authorization": [] } ], "summary": "Check a brcode hash", "tags": [ "Payments (out)", "Pix", "Brcodes" ] } }, "/v2/documents/in/refunds/search": { "get": { "callbacks": {}, "description": "Search in document refund by IDs", "operationId": "TrioFoundationWeb.V2.Documents.In.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_in_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)." } }, "security": [ { "authorization": [] } ], "summary": "Search in document refund", "tags": [ "Documents", "In", "Refunds" ] }, "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 } } ] }, "/v2/counterparties/{counterparty_id}/recipients": { "get": { "callbacks": {}, "description": "Lists the recipients of a counterparty", "operationId": "TrioFoundationWeb.V2.CounterpartyRecipientController.index", "parameters": [ { "description": "Counterparty ID", "in": "path", "name": "counterparty_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Parameter used for pagination. It is a base64 encoded param used to access the previous page of results.", "in": "query", "name": "before", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Parameter used for pagination. It is a base64 encoded param used to access the next page of results.", "in": "query", "name": "after", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Limit", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Counterparty_recipient_list_response" } } }, "description": "CounterpartyRecipient" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List counterparty recipients", "tags": [ "Counterparties", "Split Recipients" ] }, "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 } } ] }, "/v2/in/pix/qrcodes/{id}/hash": { "get": { "callbacks": {}, "description": "Gets a dynamic hash", "operationId": "TrioFoundationWeb.V2.In.Pix.QrcodeController.get_hash", "parameters": [ { "description": "Dynamic QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_dynamic_QRCode_hash_response" } } }, "description": "Hash" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a QRCode dynamic hash", "tags": [ "Receivables (in)", "Pix" ] }, "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 } } ] }, "/v2/onboarding": { "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": { "callbacks": {}, "description": "Onboards an entity", "operationId": "TrioFoundationWeb.V2.Onboarding.OnboardController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_onboarding_parameters" } } }, "description": "The onboard entity attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_onboard_response" } } }, "description": "Compliance" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Onboard entity", "tags": [ "Onboarding" ] } }, "/v2/in/pix/qrcodes/static/{id}": { "get": { "callbacks": {}, "description": "Get a specific static QRCode", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.StaticController.show", "parameters": [ { "description": "Static QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Static_QRCode_single_response" } } }, "description": "Static QRCode" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a specific static QRCode", "tags": [ "Receivables (in)", "Pix", "Static" ] }, "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 } } ] }, "/v2/out/pix/keys/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": { "callbacks": {}, "description": "Checks a key", "operationId": "TrioFoundationWeb.V2.Out.Pix.KeyController.check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_key_check_params" } } }, "description": "Check key payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_key_check_response" } } }, "description": "CheckKey" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Check a key", "tags": [ "Payments (out)", "Pix", "Keys" ] } }, "/v2/out/boleto": { "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": { "callbacks": {}, "description": "Generate a pay boleto", "operationId": "TrioFoundationWeb.V2.Out.BoletoController.generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Boleto" } } }, "description": "Boleto payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Boleto_Response" } } }, "description": "Created" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay boleto", "tags": [ "Payments (out)", "Boleto" ] } }, "/v2/in/pix/recurrences/collections/attempts": { "get": { "callbacks": {}, "description": "List recurrence collection's attempt", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.Collection.AttemptController.index", "parameters": [ { "description": "Entity UUID", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Recurrence UUID", "in": "query", "name": "recurrence_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Collection UUID", "in": "query", "name": "collection_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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" } }, { "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 } }, { "description": "Number of registries to be returned", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceCollectionAttemptListResponse" } } }, "description": "Collection" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List recurrence collection's attempt", "tags": [ "Receivables (in)", "Recurrences", "Collections", "Attempts" ] }, "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 } } ] }, "/v2/counterparty_recipients": { "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": { "callbacks": {}, "description": "Creates a counterparty recipient", "operationId": "TrioFoundationWeb.V2.CounterpartyRecipientController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Create_counterparty_recipient_params" } } }, "description": "The create counterparty recipient attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Counterparty_recipient_response" } } }, "description": "CounterpartyRecipient" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create counterparty recipient", "tags": [ "Counterparties", "Split Recipients" ] } }, "/v2/in/pix/recurrences/collections/next": { "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": { "callbacks": {}, "description": "Create next collection", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.create_next_collection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_CreateNextCollectionParams" } } }, "description": "Create next_collection attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceCollectionResponse" } } }, "description": "Collection" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create next collection", "tags": [ "Receivables (in)", "Recurrences", "Collections" ] } }, "/v2/out/darf/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": { "callbacks": {}, "description": "Check a DARF", "operationId": "TrioFoundationWeb.V2.Out.DarfController.check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Check_Darf_Request" } } }, "description": "Check DARF payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Check_Darf_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)." } }, "security": [ { "authorization": [] } ], "summary": "Check DARF", "tags": [ "Payments (out)", "Darf" ] } }, "/v2/cards/{id}/unblock": { "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": { "callbacks": {}, "description": "Unblock an existing card", "operationId": "TrioFoundationWeb.V2.CardController.unblock", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "Unblocked" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Unblock a card", "tags": [ "Cards" ] } }, "/v2/institutions": { "get": { "callbacks": {}, "description": "List institutions - Banking", "operationId": "TrioFoundationWeb.V2.InstitutionController.index", "parameters": [ { "description": "Bank ISPB", "in": "query", "name": "ispb", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Bank Number", "in": "query", "name": "number", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_institutions_response" } } }, "description": "Institutions" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List institutions", "tags": [ "Institutions" ] }, "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 } } ] }, "/v2/in/pix/qrcodes/with_due/{id}/hash": { "get": { "callbacks": {}, "description": "Gets the hash of a dynamic QRCode with due date", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.WithDueController.get_hash", "parameters": [ { "description": "Dynamic QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_dynamic_QRCode_hash_response" } } }, "description": "Hash" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a QRCode with due date hash", "tags": [ "Receivables (in)", "Pix", "With Due" ] }, "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 } } ] }, "/v2/cards/{id}": { "get": { "callbacks": {}, "description": "Get an existing card", "operationId": "TrioFoundationWeb.V2.CardController.show", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_with_balance_response" } } }, "description": "Card" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a card", "tags": [ "Cards" ] }, "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 } } ], "put": { "callbacks": {}, "description": "Update card display name", "operationId": "TrioFoundationWeb.V2.CardController.update", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_update_params" } } }, "description": "Update Card", "required": true }, "responses": { "204": { "description": "Updated" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Update a card", "tags": [ "Cards" ] } }, "/v2/documents/in/refunds/{id}": { "get": { "callbacks": {}, "description": "Get an in document refund", "operationId": "TrioFoundationWeb.V2.Documents.In.RefundController.show", "parameters": [ { "description": "Refund UUID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_in_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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get an in document refund", "tags": [ "Documents", "In", "Refunds" ] }, "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 } } ] }, "/v2/in/pix/recurrences/collections/{id}": { "get": { "callbacks": {}, "description": "Get recurrence collection", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.show", "parameters": [ { "description": "Collection ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity Id", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Group Id", "in": "query", "name": "group_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Bank account Id", "in": "query", "name": "bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Load stages?", "in": "query", "name": "load_stages", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } }, { "description": "Load attempts?", "in": "query", "name": "load_attempts", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceCollectionResponse" } } }, "description": "Collection" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get recurrence collection", "tags": [ "Receivables (in)", "Recurrences", "Collections" ] }, "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 } } ], "put": { "callbacks": {}, "description": "Update collection Amount by ID", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.update_amount", "parameters": [ { "description": "Collection ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_CollectionUpdateParams" } } }, "description": "The update attributes", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Update collection Amount", "tags": [ "Receivables (in)", "Recurrences", "Collections" ] } }, "/v2/transfer": { "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": { "callbacks": {}, "description": "Requests a transfer between two bank accounts. trio-spi creates the transfer document asynchronously, so the request answers 200 with the ID it will have.", "operationId": "TrioFoundationWeb.V2.TransferController.transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_transfer_create_params" } } }, "description": "The transfer attributes", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_transfer_creation_response" } } }, "description": "Transfer" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Transfer amount between bank accounts", "tags": [ "Transfer" ] } }, "/v2/bank_accounts": { "get": { "callbacks": {}, "description": "List all available bank accounts", "operationId": "TrioFoundationWeb.V2.BankAccountController.index", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Group ID", "in": "query", "name": "group_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Bank account ID", "in": "query", "name": "bank_account_id", "required": false, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Status", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/V2_bank_account_status" } }, { "description": "Before", "in": "query", "name": "before", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "After", "in": "query", "name": "after", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Limit", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_bank_accounts_response" } } }, "description": "BankAccounts" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List bank accounts", "tags": [ "Bank Accounts" ] }, "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": { "callbacks": {}, "description": "Creates a bank account", "operationId": "TrioFoundationWeb.V2.BankAccountController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Create_bank_account_params" } } }, "description": "The create bank account attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_bank_account_response" } } }, "description": "BankAccount" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create bank account", "tags": [ "Bank Accounts" ] } }, "/v2/in/pix/recurrences/{id}/cancel": { "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": { "callbacks": {}, "description": "Cancel recurrence by ID", "operationId": "TrioFoundationWeb.V2.In.Pix.RecurrenceController.cancel", "parameters": [ { "description": "Recurrence ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_CancelRecurrenceParams" } } }, "description": "The recurrence cancel attributes", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Cancel recurrence", "tags": [ "Receivables (in)", "Recurrences" ] } }, "/v2/out/darf/async": { "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": { "callbacks": {}, "description": "Generate an async pay DARF", "operationId": "TrioFoundationWeb.V2.Out.DarfController.generate_async", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Darf_async_create_params" } } }, "description": "DARF payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Darf_Response" } } }, "description": "Requested" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay DARF async", "tags": [ "Payments (out)", "Darf" ] } }, "/v2/documents/out/refunds/{id}": { "get": { "callbacks": {}, "description": "Get an out document refund", "operationId": "TrioFoundationWeb.V2.Documents.Out.RefundController.show", "parameters": [ { "description": "Refund UUID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get an out document refund", "tags": [ "Documents", "Out", "Refunds" ] }, "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 } } ] }, "/v2/documents/out/search": { "get": { "callbacks": {}, "description": "Search out document by IDs", "operationId": "TrioFoundationWeb.V2.Documents.OutController.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_response" } } }, "description": "Document" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Search out document", "tags": [ "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 } } ] }, "/v2/out/tax/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": { "callbacks": {}, "description": "Check a tax barcode or line code", "operationId": "TrioFoundationWeb.V2.Out.TaxController.check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Check_tax_request_params" } } }, "description": "Check tax payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Check_Tax_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)." } }, "security": [ { "authorization": [] } ], "summary": "Check tax", "tags": [ "Payments (out)", "Tax" ] } }, "/v2/cards/invoices/{id}/lines": { "get": { "callbacks": {}, "description": "List lines for a specific Card Invoice", "operationId": "TrioFoundationWeb.V2.Card.InvoiceController.list_lines", "parameters": [ { "description": "Invoice ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "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 } }, { "description": "Parameter used for pagination.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_card_invoice_lines_response" } } }, "description": "Invoice Lines" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List Card Invoice Lines", "tags": [ "Cards" ] }, "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 } } ] }, "/v2/in/pix/recurrences/collections/{id}/schedule": { "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": { "callbacks": {}, "description": "Schedule collection", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.schedule", "parameters": [ { "description": "Collection ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_CollectionScheduleParams" } } }, "description": "The collection schedule attributes", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Schedule collection", "tags": [ "Receivables (in)", "Recurrences", "Collections" ] } }, "/v2/out/darf": { "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": { "callbacks": {}, "description": "Generate a pay DARF", "operationId": "TrioFoundationWeb.V2.Out.DarfController.generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Darf" } } }, "description": "DARF payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Darf_Response" } } }, "description": "Created" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay DARF", "tags": [ "Payments (out)", "Darf" ] } }, "/v2/pix/keys/{id}/cancel": { "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": { "callbacks": {}, "description": "Cancel pix key", "operationId": "TrioFoundationWeb.V2.Pix.KeyController.cancel", "parameters": [ { "description": "Pix Key ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Cancel pix key", "tags": [ "Pix Keys", "Cancel" ] } }, "/v2/cards/{id}/topup": { "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": { "callbacks": {}, "description": "Top Up card balance", "operationId": "TrioFoundationWeb.V2.CardController.topup", "parameters": [ { "description": "Card ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_card_top_up_balance_params" } } }, "description": "Top Up Card Balance", "required": true }, "responses": { "204": { "description": "Top Up Successful" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Top Up card balance", "tags": [ "Cards" ] } }, "/v2/documents/out/refunds/search": { "get": { "callbacks": {}, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Search out document refund", "tags": [ "Documents", "Out", "Refunds" ] }, "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 } } ] }, "/v2/documents/in/search": { "get": { "callbacks": {}, "description": "Search in document", "operationId": "TrioFoundationWeb.V2.Documents.InController.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_in_document_response" } } }, "description": "Document" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Search in document", "tags": [ "Documents", "In" ] }, "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 } } ] }, "/v2/out/pix/keys/{id}": { "get": { "callbacks": {}, "description": "Gets a specific check key", "operationId": "TrioFoundationWeb.V2.Out.Pix.KeyController.show", "parameters": [ { "description": "Check key ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Pix_key_check_response" } } }, "description": "CheckKey" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a specific check key", "tags": [ "Payments (out)", "Pix", "Keys" ] }, "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 } } ] }, "/v2/pix/keys/{id}/resend_token": { "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": { "callbacks": {}, "description": "Resend pix key confirmation token", "operationId": "TrioFoundationWeb.V2.Pix.KeyController.resend_token", "parameters": [ { "description": "Pix Key ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Resend pix key confirmation token", "tags": [ "Pix Keys", "Resend" ] } }, "/v2/counterparties": { "get": { "callbacks": {}, "description": "List counterparties", "operationId": "TrioFoundationWeb.V2.CounterpartyController.index", "parameters": [ { "description": "Name of counterparty", "in": "query", "name": "name", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Tax Number of counterparty", "in": "query", "name": "tax_number", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "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 } }, { "description": "Limit", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_list_counterparties_response" } } }, "description": "Counterparties" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List counterparties", "tags": [ "Counterparties" ] }, "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": { "callbacks": {}, "description": "Find or create a counterparty", "operationId": "TrioFoundationWeb.V2.CounterpartyController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Create_counterparty_params" } } }, "description": "The create counterparty attributes", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_counterparty_response" } } }, "description": "Counterparty" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Find or create Counterparty", "tags": [ "Counterparties" ] } }, "/v2/counterparties/{id}": { "get": { "callbacks": {}, "description": "Show a counterparty", "operationId": "TrioFoundationWeb.V2.CounterpartyController.show", "parameters": [ { "description": "Counterparty ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_counterparty_response" } } }, "description": "Counterparty" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Show counterparty", "tags": [ "Counterparties" ] }, "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 } } ] }, "/v2/out/tax/async": { "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": { "callbacks": {}, "description": "Generate an async pay tax", "operationId": "TrioFoundationWeb.V2.Out.TaxController.generate_async", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Tax_async_create_params" } } }, "description": "Tax payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Generate_Tax_Response" } } }, "description": "Requested" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Pay tax async", "tags": [ "Payments (out)", "Tax" ] } }, "/v2/bank_accounts/{id}/transactions": { "get": { "callbacks": {}, "description": "List transactions", "operationId": "TrioFoundationWeb.V2.BankAccount.TransactionController.index", "parameters": [ { "description": "Bank account ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "External ID", "in": "query", "name": "external_id", "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": "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": "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_bank_account_transactions_response" } } }, "description": "Transactions" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List transactions", "tags": [ "Bank Accounts", "Transactions" ] }, "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 } } ] }, "/v2/in/pix/qrcodes/with_due/{id}": { "get": { "callbacks": {}, "description": "Gets a specific dynamic QRCode with due date", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.WithDueController.show", "parameters": [ { "description": "QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_DynamicQRCodeWithDueResponse" } } }, "description": "Dynamic QRCode with due date" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a specific dynamic QRCode with due date", "tags": [ "Receivables (in)", "Pix", "With Due" ] }, "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 } } ] }, "/v2/in/pix/recurrences/collections/{id}/cancel": { "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": { "callbacks": {}, "description": "Cancel collection by ID", "operationId": "TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.cancel", "parameters": [ { "description": "Collection ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_CancelCollectionParams" } } }, "description": "The collection cancel attributes", "required": true }, "responses": { "204": { "description": "No Content" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Cancel collection", "tags": [ "Receivables (in)", "Recurrences", "Collections" ] } }, "/v2/in/pix/qrcodes/static/{id}/image": { "get": { "callbacks": {}, "description": "Gets a static QRCode image", "operationId": "TrioFoundationWeb.V2.In.Pix.Qrcode.StaticController.get_image", "parameters": [ { "description": "Static QRCode ID", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_static_QRCode_image_response" } } }, "description": "Static QRCode Image" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get a static QRCode image", "tags": [ "Receivables (in)", "Pix", "Static" ] }, "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 } } ] }, "/v2/out/utility/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": { "callbacks": {}, "description": "Check a utility barcode or line code", "operationId": "TrioFoundationWeb.V2.Out.UtilityController.check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Check_utility_request_params" } } }, "description": "Check utility payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Check_Utility_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)." } }, "security": [ { "authorization": [] } ], "summary": "Check utility", "tags": [ "Payments (out)", "Utility" ] } }, "/v2/in/pix/recurrences/{id}": { "get": { "callbacks": {}, "description": "Get recurrence with stages", "operationId": "TrioFoundationWeb.V2.In.Pix.RecurrenceController.show", "parameters": [ { "description": "Recurrence Id", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "description": "Entity Id", "in": "query", "name": "entity_id", "required": false, "schema": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Group Id", "in": "query", "name": "group_id", "required": false, "schema": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Bank account Id", "in": "query", "name": "bank_account_id", "required": false, "schema": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Load stages?", "in": "query", "name": "load_stages", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } }, { "description": "Load requests?", "in": "query", "name": "load_requests", "required": false, "schema": { "type": "boolean", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_RecurrenceResponse" } } }, "description": "Recurrence" }, "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." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_error" } } }, "description": "No resource with this ID (NOT_FOUND_RESOURCE)." }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Get recurrence", "tags": [ "Receivables (in)", "Recurrences" ] }, "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 } } ] }, "/v2/pledged/advance_requests": { "get": { "callbacks": {}, "description": "List pledged advance requests of an entity", "operationId": "TrioFoundationWeb.V2.Pledged.AdvanceRequestController.index", "parameters": [ { "description": "Entity ID", "in": "query", "name": "entity_id", "required": true, "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": "Status", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "created", "approved", "rejected", "canceled" ], "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Pagination cursor before", "in": "query", "name": "before", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Pagination cursor after", "in": "query", "name": "after", "required": false, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Limit", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_pledged_advance_requests_list_response" } } }, "description": "Advance requests" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "List pledged advance requests", "tags": [ "Pledged" ] }, "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": { "callbacks": {}, "description": "Create a pledged advance request, uploading its contract file", "operationId": "TrioFoundationWeb.V2.Pledged.AdvanceRequestController.create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_create_pledged_advance_request_params" } } }, "description": "Pledged advance request payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_pledged_advance_request_response" } } }, "description": "Advance request" }, "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)." } }, "security": [ { "authorization": [] } ], "summary": "Create a pledged advance request", "tags": [ "Pledged" ] } } }, "security": [], "servers": [ { "url": "https://api.sandbox.trio.com.br", "variables": {} }, { "url": "https://api.qa.trio.com.br", "variables": {} }, { "url": "https://api.trio.com.br", "variables": {} } ], "tags": [] }