Requests and Responses

Here we have the descriptions and details of the fields used in our API requests and responses.

Organizations API

The following fields can be used to manage the Organizations API.

Field	Type	Description
id	String (UUID)	The unique identifier of the Organization.
parentOrganizationId	String (UUID)	The unique identifier of the parent Organization.
legalName	String	The legal name of the Organization. Maxlength: 100
doingBusinessAs	String	The trade name of the Organization. Maxlength: 100
legalDocument	String	The document of the Organization. (CNPJ in Brazil, EIN in the US, and so on.) Use only numbers. Maxlength: 100
address	Object	An object containing information about the address.
metadata	Object	An object containing metadata information.
status	Object	An object containing information about the status.
createdAt	DateTime	The time when the Organization was created.
updatedAt	DateTime	The last time that the Organization was updated.
deletedAt	DateTime	The time when the Organization was deleted.

---

Ledgers API

The following fields can be used to manage the Ledgers API.

Field	Type	Description
id	String (UUID)	The unique identifier of the Ledger.
organizationId	String (UUID)	The unique identifier of the Organization.
instruments	Array (UUID)	Array for UUID's regarding the instruments available for the Ledger.
legalName	String	The legal name of the Organization. Maxlength: 100
doingBusinessAs	String	The trade name of the Organization. Maxlength: 100
legalDocument	String	The document of the Organization (CNPJ). Use only numbers. Maxlength: 100
address	Object	An object containing information about the address.
metadata	Object	An object containing metadata information.
status	Object	An object containing information about the status.
createdAt	DateTime	The time when the Ledger was created.
updatedAt	DateTime	The last time that the Ledger was updated.
deletedAt	DateTime	The time when the Ledger was deleted.

---

Instruments API

The following fields can be used to manage the Instruments API.

id	String (UUID)	The unique identifier of the Instrument.
name	String	Name of the Instrument.
ledgerId	String (UUID)	Ledger's identification code.
type	String	The type of instrument.
code	String	The code that identifies the instrument.
status	Object	An object containing information about the instrument status.
createdAt	DateTime	The time when the Instrument was created.
updatedAt	DateTime	The time when the Instrument was created.
deletedAt	DateTime	The time when the Instrument was deleted.
metadata	Object	An object containing metadata information.

---

Products API

The following fields can be used to manage the Products API.

Field	Type	Description
id	String (UUID)	The unique identifier of the Product.
name	String	Name of the Product.
status	Object	An object containing information about the product status.
ledgerId	String (UUID)	Ledger's identification code.
createdAt	DateTime	The time that the Product was created.
updatedAt	DateTime	The last time that the Product was updated.
deletedAt	DateTime	The time when the Product was deleted.

---

Portfolios API

The following fields can be used to manage the Portfolio API.

Field	Type	Description
id	String (UUID)	The unique identifier of the Portfolio.
name	String	Name of the Portfolio.
entityId	String (UUID)	The unique identifier of the Entity.
ledgerId	String (UUID)	The unique identifier of the Ledger.
status	Object	An object containing information about the portfolio status.
allowSending	Boolean	Allows you to send transactions.
allowReceiving	Boolean	Allows you to receive transactions.
accounts	Array	An array containing a list of the accounts in the portfolio.
alias	String	An alais that represents the person responsible.
instrumentCode	String	The code of the instrument.
type	String	The type of account.
balance	Object	An object containing information about the balance.
createdAt	DateTime	The time when the Portfolio was created.
updatedAt	DateTime	The last time that the Portfolio was updated.
deletedAt	DateTime	The time when the Portfolio was deleted.

---

Accounts API

The following fields can be used to manage the Accounts API.

Field	Type	Description
id	String (UUID)	The unique identifier of the Account.
name	String	Name of the Account.
portfolioId	String (UUID)	The unique identifier of the Portfolio.
instrumentCode	String	The code of the instrument.
status	Object	An object containing information about the account status.
allowSending	Boolean	Allows you to send transactions.
allowReceiving	Boolean	Allows you to receive transactions.
ledgerId	String (UUID)	Ledger's identification code.
alias	String	An alias used to identify the person responsible for the account.
entityId	String (UUID)	Entity's identification code.
parentAccountId	String (UUID)	The unique identifier of the parent account. If the account is the parent account, this field will be null.
productId	String (UUID)	The unique identifier of the product.
createdAt	DateTime	The time when the Account was created.
updatedAt	DateTime	The last time that the Account was updated.
deletedAt	DateTime	The time when the Account was deleted.

---

Instruments rates API

Field	Type	Description
baseInstrumentCode
counterInstrumentCode
amount
scale
source
status	Object	An object containing information about the account status.
metadata	Object	An object containing metadata information.
id	String (UUID)	The unique identifier of the instrument rate.
ledgerId	String (UUID)	Ledger's identification code.
organizationId	String (UUID)	The unique identifier of the Organization.
createdAt	DateTime	The time when the instrument rate was created.
updatedAt	DateTime	The last time that the instruemnt rate was updated.
deletedAt	DateTime	The time when the instrument rate was deleted.

---

Transactions API

Field	Type	Description
transactionTypeCode
variables
metadata
parentTransactionId
description
inheritMetadata
inheritDescription

---

Operations API

Field	Type	Description

---

Charts API

Field	Type	Description

---

Objects

address object

Name	Type	Description
line1	String	The first line of the address.
line2	String	The second line of the address with any complement.
neighborhood	String	The area located within a city.
zipCode	String	The postal code using only numbers.
city	String	The name of the city.
state	String	Two letters that represent the State.
country	String	Two letters code of the country in ISO 3166-1 alpha2 format.

status object

Field	Type	Description
code	String	The status. Maxlength: 100
description	String	The description of the status. Maxlength: 100

metadata object

Field	Type	Description
costCenter	String
officeAddress	String
generalManager	String
internalExchangeAddress	String
internalExchangeCustody	String

balance object

Field	Type	Description
available	Number
onHold	Number