Order Schema

Order schema defines a withdrawal or deposit order, identified by its id (UUID) provided at its creation. Through subschemas, it also gives information about the related currencies and user.

Note that types market with "?" may be omitted or nulled.

Key	Description	Type	Example
id	Order ID (UUID)	string	`ffdb3cfb-0fdb-49c9-aa77-f35f0b35179e`
user	User schema	User	See User
currency	Currency schema	Currency	See Currency
orderType	Order direction	string	`deposit`, `withdrawal`, `buy`
value	Order value in currency	string	`50.00`
fee	Order discounted fee, in currency	string	`0.50`
total	Order value minus order fee, in currency	string	`49.5`
cryptoCurrency	Related crypto-currency, in Currency schema	string?	See Currency and remark 1
status	Order status	string	See Order Statuses
method	Order settlement method	string?	`BankTransfer`, `PixKey` , `Cryptowallet`
note	Personal partner note	string?	`This order is a test`
requisite	Order settlement method's params	BankAccount?, PixKey?	`{"key":"12345678910","keyType":"cpf"}`
createdAt	Order creation timestamp	string	`2020-05-04T12:03:54.000000Z`
updatedAt	Order last change timestamp	string	`2020-05-04T12:03:54.000000Z`

Remarks

Crypto-currency

References to the crypto-currency of an order will only exist if your setup requires a fiat-to-crypto exchange before moving the funds into the customer's wallet. Should not this be the case and you are going to list the fiat currency itself in the user balance, this field will be null.