LogoLogo
HomeBlogLoginSignup
  • Get started
  • Guides
  • Reference
  • Banking API
    • Entities
    • Counterparties
    • Institutions
    • Bank accounts
    • Virtual accounts
    • Collecting
      • Dynamic QR codes
      • Static QR codes
      • Refund
    • Payment
      • Pix Key
      • Pix Brcode
    • Transfer
    • Documents
      • Collecting
      • Collecting - Refund
      • Payment
      • Payment - Refund
      • Transfer
    • Checkout
    • Developers
      • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. Banking API

Bank accounts

PreviousInstitutionsNextVirtual accounts

Last updated 4 months ago

Was this helpful?

List bank accounts

get

List bank accounts

Query parameters
entity_idstring · uuidRequired

Unique identifier

beforestringOptional

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==
afterstringOptional

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==
Responses
200
Bank accounts
application/json
401
Unauthorized
application/json
500
Internal server error
application/json
get
GET /banking/bank_accounts HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
  "data": [
    {
      "default_virtual_account_id": "0194cc3b-864a-a0c3-b248-1c268dabe82c",
      "description": "Bank account Test 1",
      "entity_id": "0194cc3b-864a-160c-a952-3c7b6a354e33",
      "id": "0194cc3b-864a-0867-d536-ece78fcd3a84",
      "inserted_at": "2025-02-03 14:34:00.650350Z",
      "updated_at": "2025-02-03 14:34:00.650364Z"
    }
  ]
}

List bank account transactions

get

List bank account transactions

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
from_datetimestring · date-timeRequired

Datatime schema

to_datetimestring · date-timeRequired

Datatime schema

external_idstringOptional

External ID

reconciliation_idstring · uuidOptional

Unique identifier

beforestringOptional

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==
afterstringOptional

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==
Responses
200
Transactions
application/json
401
Unprocessable Entity
application/json
500
Unprocessable Entity
application/json
get
GET /banking/bank_accounts/{id}/transactions HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
  "data": [
    {
      "amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "bank_account_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
      "counterparty_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
      "document_type": "pix",
      "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
      "external_id": "external_id",
      "ledger_account_id": "0190df9a-d08e-9574-c79c-9aa0f40ee330",
      "posting_type": "credit",
      "reconciliation_id": "018f3406-9e00-1766-05c4-4907e14ee511",
      "ref_id": "0190df9a-d1b1-6bfe-ad26-037579ad8588",
      "ref_type": "out",
      "transaction_date": "2024-07-21T12:00:01",
      "transaction_type": "regular",
      "virtual_account_id": "0190df9a-d08e-9574-c79c-9aa0f40ee330"
    }
  ]
}

Get bank account available balance

get

Get balance of a bank account

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
at_datetimestring · date-timeOptional

Datatime schema

Responses
200
BalanceResponse
application/json
401
Unprocessable Entity
application/json
404
Unprocessable Entity
application/json
500
Unprocessable Entity
application/json
get
GET /banking/bank_accounts/{id}/balances HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
  "data": {
    "available_balance": {
      "amount": 10,
      "currency": "BRL"
    }
  }
}

Get bank account

get

Get an existing bank account

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200
Bank account
application/json
401
Unauthorized
application/json
500
Internal server error
application/json
get
GET /banking/bank_accounts/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
  "data": {
    "default_virtual_account_id": "0194cc3b-864a-a0c3-b248-1c268dabe82c",
    "description": "Bank account Test 1",
    "entity_id": "0194cc3b-864a-160c-a952-3c7b6a354e33",
    "id": "0194cc3b-864a-0867-d536-ece78fcd3a84",
    "inserted_at": "2025-02-03 14:34:00.650350Z",
    "updated_at": "2025-02-03 14:34:00.650364Z"
  }
}
  • GETList bank accounts
  • GETList bank account transactions
  • GETGet bank account available balance
  • GETGet bank account
  • POSTCreate bank account

Create bank account

post

Create a new bank account

Body

Parameters used to create a bank account

descriptionstringRequired

Bank account description

entity_idstring · uuidRequired

Entity ID

Responses
201
Created bank account
application/json
401
Unauthorized
application/json
500
Internal server error
application/json
post
POST /banking/bank_accounts HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "description": "Bank account Test",
  "entity_id": "0194cc3b-88fa-8a2b-48f6-489d16713d47"
}
{
  "data": {
    "default_virtual_account_id": "0194cc3b-864a-a0c3-b248-1c268dabe82c",
    "description": "Bank account Test 1",
    "entity_id": "0194cc3b-864a-160c-a952-3c7b6a354e33",
    "id": "0194cc3b-864a-0867-d536-ece78fcd3a84",
    "inserted_at": "2025-02-03 14:34:00.650350Z",
    "updated_at": "2025-02-03 14:34:00.650364Z"
  }
}