Virtual accounts

PreviousBank accounts NextCollecting

Last updated 4 months ago

Was this helpful?

List virtual accounts

get

List all available virtual accounts

Query parameters

entity_idstring · uuidOptional

Unique identifier

bank_account_idstring · uuidRequired

Unique identifier

statusstringOptional

Status of the virtual account

beforestringOptional

Before

afterstringOptional

After

limitintegerOptional

Limit

Responses

200

VirtualAccounts

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /banking/virtual_accounts HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
      "branch": "0001",
      "description": "Conta",
      "digit": "1",
      "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
      "number": "12345678",
      "opening_date": "2024-10-12T00:00:00",
      "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"
    }
  ]
}

Show virtual account

get

Shows a virtual account

Path parameters

idstring · uuidRequired

Unique identifier

Responses

200

Virtual account

application/json

401

Unauthorized

application/json

404

Unprocessable Entity

application/json

500

Internal server error

application/json

get

GET /banking/virtual_accounts/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
    "branch": "0001",
    "description": "Conta",
    "digit": "1",
    "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
    "number": "12345678",
    "opening_date": "2024-10-12T00:00:00",
    "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"
  }
}

Sum amount and count virtual account

get

Sum amount and count virtual account

Path parameters

idstring · uuidRequired

Unique identifier

Query parameters

at_datetimestringOptional

At datetime

Responses

200

BalanceResponse

application/json

401

Unauthorized

application/json

404

Unprocessable Entity

application/json

500

Internal server error

application/json

get

GET /banking/virtual_accounts/{id}/balances HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "available_balance": {
      "amount": 10,
      "currency": "BRL"
    }
  }
}

List transactions

get

List transactions

Path parameters

idstring · uuidRequired

Unique identifier

Query parameters

external_idstringOptional

External ID

reconciliation_idstring · uuidOptional

Unique identifier

from_datetimestring · date-timeRequired

Datatime schema

to_datetimestring · date-timeRequired

Datatime schema

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

Unauthorized

application/json

500

Internal server error

application/json

get

GET /banking/virtual_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"
    }
  ]
}

Create virtual account

post

Creates a virtual account

Body

Creates a virtual account params

bank_account_idstringRequired

Bank Account ID

descriptionstringRequired

Description

Responses

201

VirtualAccount

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /banking/virtual_accounts HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb888",
  "description": "description 1"
}

{
  "data": {
    "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
    "branch": "0001",
    "description": "Conta",
    "digit": "1",
    "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
    "number": "12345678",
    "opening_date": "2024-10-12T00:00:00",
    "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"
  }
}

Update virtual account parameters

put

Update virtual account parameters

Path parameters

idstring · uuidRequired

Unique identifier

Body

Updates an account parameters params

automatic_refund_for_person_deadbooleanOptional

Automatic refund for deceased individuals

automatic_refund_for_person_invalid_tax_numberbooleanOptional

Automatic refund for invalid tax number

automatic_refund_for_person_underagebooleanOptional

Automatic refund for underage

in_block_for_legal_entitybooleanOptional

In block for legal entity origin

in_block_for_pix_qrcode_different_amount_paymentbooleanOptional

In block for qrcode different amount payment

in_block_for_pix_qrcode_different_counterparty_bank_accountbooleanOptional

In block for qrcode different counterparty bank account

in_block_for_pix_qrcode_different_tax_numberbooleanOptional

In block for qrcode different tax number

in_block_for_pix_qrcode_duplicated_paymentbooleanOptional

In block for qrcode duplicated payment

in_block_for_unauthorized_participantbooleanOptional

In block for unauthorized participant

in_block_for_unidentified_depositbooleanOptional

In block for unidentified deposit

out_block_for_legal_entitybooleanOptional

Out block for legal entity destination

out_blockedbooleanOptional

Out blocked

Responses

201

Account

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

put

PUT /banking/virtual_accounts/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 541

{
  "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
}

{
  "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": 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,
    "virtual_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2"
  }
}