Deals

As far as the API is concerned, a deal can be thought of as an investment template that a business can configure and then share with clients.

For example, if you are a PPM trying to raise money for an investment, you can create a deal on our platform. You would then submit the deal for review to AET. After the deal is approved, it can be shared with potential investors. The investors can be new or existing AET clients. The client can review the deal on our platform. After the client invests, dividends can be paid to the investor.

Deal lifecycle

Creating your deal and getting it approved

  1. Create a deal
  2. Update your deal with the appropriate documents
  3. Submit the deal for review - AET staff will then review your deal to make sure that it is appropriate for our platform.
  4. Get the status of the deal to understand if the deal is approved (Active) or needs updating (On Hold)
  5. If the deal is On Hold, get the deal notes to understand AET's concerns
  6. Update the deal if need be
  7. Once the deal is updated appropriately, you can re-submit the deal for review

Sharing a deal

Once the deal status is Active, use the get deal to retrieve a deal's invite_token.

You can then pass the token via the API to perform either of the following:

  • Create an investment
  • Create a new user (if the client does not already have one)

If a new user is created using the invite_token with the create user api call, this will associate a deal invite to the user record. You can see all deal invites for a specific client using the API call that we will create called something like users/{user_id}/deal_invites.

Paying dividends

You can pay dividends to your investors using the following endpoint. This endpoint requires you to calculate how much you think each investor should be paid.

  1. Pay deal investors

Pro-rata

When paying investors pro-rata, you can use the validate payments details endpoint to pass in an array of accounts. The API will calculate how much to pay each investor based on their overall share count.

Once you have this information, you can use the pay deal investors endpoint to payout dividends to investors.

Statuses

The following are the possible statuses for deals

  • Closed - deal is no longer accepting funding but can still pay investors
  • Active - deal is currently accepting new investors (you can create new invites) and you can pay investors
  • On Hold - our team has found issues with your deal and you need to check the deal notes to understand what the issue is. The deal can be re-submitted for review in this state
  • Draft - The deal has not been submitted for review

Deal limits

You can specify either a date or funding limit for a deal.

Funding deadline

When setting a funding deadline

  • You offer the ability to purchase shares until a date
  • After this date you shut off the ability to submit new investments
  • New invites cannot be created after the funding date
  • You can still pay dividends to an investor after the funding deadline date

Funding cap

Funding caps are similar to funding deadlines, however, instead of the limit being a set time period, the limit is a set number of shares. After the limit on the number of shares is reached, similar to the funding date, new invites and investments cannot be made, however you can still pay dividends to investors.