This is one of two ways to integrate the Investments API. If you do not hold your own regulatory permissions, use the Managed model instead.
Who this is for
You are a regulated entity — a broker, an asset manager, a licensed fintech — and you already hold the permissions to hold client assets and maintain a ledger of your end users. In the Direct model you are GetEquity’s counterparty. Your organisation has a single account and a single wallet, and every order is placed as your organisation. GetEquity does not provision accounts for your end users and does not hold a per-user balance for them.How your end users are represented
Each trade carries acustomer object naming the end user the activity belongs to:
POST api/token/{id}/buy
The flow
1
Fund your organisation wallet
Call Fund Wallet to get a virtual account or payment link. All trades settle against this single wallet.
2
Find something to trade
Use Get All Tokens, Get Raising Tokens or Search Token to locate the asset.
3
Place the order
Call Buy Token or Sell Token with the
customer object attached. For a raise rather than a secondary trade, use Fund Buy.4
Track it
Orders return immediately as pending. Watch the
order.created and transaction.created webhook events, or poll Get Order.5
Reconcile
Use Get Customer Transactions to pull activity for one end user by email, and Get Wallet Balance for your organisation’s position.
Endpoints in this model
Trade
Buy, sell and fund-buy tokens, plus token discovery and market data.
Customers
List and search the end users you have traded on behalf of.
Orders
Retrieve and cancel orders your organisation has placed.
Transactions
Per-customer transaction history and total volume.
Wallet
Fund, withdraw from and check the balance of your organisation wallet.
Webhooks
Order, transaction and wallet events for your organisation.
