HomeBlogLoginSignup

Counterparties

List counterparties

get

List counterparties

Query parameters
namestringOptional

Name of counterparty

tax_numberstringOptional

Tax Number of counterparty

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

Limit

Responses
200
Counterparty
application/json
get
GET /banking/counterparties HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
      "inserted_at": "2025-02-03 14:34:00.130003Z",
      "name": "participant_1",
      "tax_number": "12345678910",
      "updated_at": "2025-02-03 14:34:00.130015Z"
    }
  ]
}

Show counterparty

get

Show a counterparty

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200
Counterparty
application/json
get
GET /banking/counterparties/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
    "inserted_at": "2025-02-03 14:34:00.130003Z",
    "name": "participant_1",
    "tax_number": "12345678910",
    "updated_at": "2025-02-03 14:34:00.130015Z"
  }
}

Find or create Counterparty

post

Find or create a counterparty

Body

Body params create counterparty

namestringRequired

Name of the counterparty

tax_numberstringRequired

Tax number of the counterparty

Responses
201
Counterparty
application/json
post
POST /banking/counterparties HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "name": "Random",
  "tax_number": "12345678910"
}
{
  "data": {
    "id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
    "inserted_at": "2025-02-03 14:34:00.130003Z",
    "name": "participant_1",
    "tax_number": "12345678910",
    "updated_at": "2025-02-03 14:34:00.130015Z"
  }
}

Update counterparty limit

put

Update a counterparty limit

Path parameters
idstring · uuidRequired

Unique identifier

Body

Body params to update counterparty limits

bank_account_idstring · uuidRequired

Unique identifier

document_typestringRequired

Document type of the counterparty

maximum_amountintegerRequired

Counterparty maximum amount

Responses
200
CounterpartyLimits
application/json
put
PUT /banking/counterparties/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb888",
  "document_type": "pix",
  "maximum_amount": 10
}
{
  "data": {
    "bank_account_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb888",
    "company_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb777",
    "counterparty_id": "41234d60-f6a9-4c9c-8cc3-5769ce9bb999",
    "document_type": "pix",
    "id": "41234d60-f6a9-4c9c-8cc3-5769ce9bbea2",
    "inserted_at": "2024-02-23 16:44:50.840632Z",
    "maximum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "updated_at": "2024-02-23 16:44:50.840632Z"
  }
}

List counterparty bank accounts

get

Lists counterparty bank accounts by counterparty ID

Path parameters
counterparty_idstring · uuidRequired

Unique identifier

Responses
200
CounterpartyBankAccount
application/json
get
GET /banking/counterparties/{counterparty_id}/bank_accounts HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "branch": "0001",
      "counterparty_id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
      "digit": "1",
      "id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
      "ispb": "12345678",
      "number": "87654321",
      "type": "checking"
    }
  ]
}

Show counterparty bank account

get

Show a counterparty bank account

Path parameters
counterparty_idstring · uuidRequired

Unique identifier

counterparty_bank_account_idstring · uuidRequired

Unique identifier

Responses
200
CounterpartyBankAccount
application/json
get
GET /banking/counterparties/{counterparty_id}/bank_accounts/{counterparty_bank_account_id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "branch": "0001",
  "counterparty_id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
  "digit": "1",
  "id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
  "ispb": "12345678",
  "number": "87654321",
  "type": "checking"
}

Create counterparty bank account

post

Creates a counterparty bank account

Path parameters
counterparty_idstring · uuidRequired

Unique identifier

Body

Body params counterparty bank account data

branchstringOptional

Counterparty bank account branch

digitstringOptional

Counterparty bank account digit

ispbstringOptional

Counterparty bank account ispb

numberstringOptional

Counterparty bank account number

typestringOptional

Type of the counterparty bank account

Responses
200
CounterpartyBankAccount
application/json
post
POST /banking/counterparties/{counterparty_id}/bank_accounts HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "branch": "0001",
  "digit": "1",
  "ispb": "12345678",
  "number": "87654321",
  "type": "checking"
}
{
  "branch": "0001",
  "counterparty_id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
  "digit": "1",
  "id": "018df099-093e-cfd1-4500-4c9392eb5d8a",
  "ispb": "12345678",
  "number": "87654321",
  "type": "checking"
}
PreviousEntitiesNextInstitutions

Last updated

Was this helpful?