Developer Guide¶
This guide is for engineers integrating TransactAPI into an investment platform. It walks through a complete integration in the sandbox, explains the concepts every integration relies on, and covers custody accounts for platforms that offer them.
Before you start, get sandbox credentials and make your first request by following Getting Started.
Build Your Integration¶
The integration path follows a typical TransactAPI integration from an empty sandbox to a live offering. Each step creates the records the next step needs, so work through them in order the first time. Once your integration is built, steps 3 through 7 run for every investor.
Once per offering
For each investor
When your integration is ready
The Steps¶
| Step | What you do | Key calls | What you keep |
|---|---|---|---|
| 1. Set Up an Offering | Create the issuer and the offering, and confirm its escrow account. | createIssuer, createOffering | issuerId, offeringId |
| 2. Register Webhooks | Register the methods you want notifications for, before any investor records exist. | Transact Portal | |
| 3. Onboard Investors | Create a party for each person or entity, an account that owns the investment, and links between them. | createParty, createEntity, createAccount, createLink | partyId, accountId |
| 4. Qualify Investors | Run the checks your offering requires. | performKycAmlBasic, performKycAml, calculateSuitability, requestAiVerification | KYC/AML and accreditation statuses |
| 5. Create the Trade | Record the investment and send subscription documents for signature. | createTrade, sendSubscriptionDocument | tradeId |
| 6. Collect Payment | Fund the trade by ACH, wire, check, IRA, or card. | linkExternalAccount, externalFundMove, updateTradeTransactionType, ccFundMove | RefNum |
| 7. Settle and Manage | Settle funded trades, close the offering, and handle cancellations and refunds. | updateTradeStatus, closeOffering, cancelInvestment | |
| 8. Go Live | Complete Pre-Live Certification and move to production keys. | Production credentials |
How the Steps Connect¶
- IDs flow forward. The offering from step 1 and the account from step 3 are what a trade is created against in step 5. The trade from step 5 is what a payment funds in step 6.
- Webhooks report progress. Once registered in step 2, webhooks tell you when parties are created, checks complete, documents are signed, and trade and payment statuses change. You don't have to poll.
- Some steps are billed in production. KYC/AML and accreditation checks in step 4, and Plaid linking, ACH and card payments in step 6, carry fees. Sandbox calls are not billed. See the Fee Schedule.
- Statuses gate later steps. Your offering may require an approved KYC/AML result or accreditation before you create a trade, and a trade moves to
FUNDEDonly once its funds are received in escrow.
Custody Accounts¶
Opening custody accounts is a separate process from the integration path, needed only if your platform opens custody accounts for investors. See Custody Accounts.
Concepts¶
These pages cover rules that apply to every step:
- Authorization Headers: how to send your credentials.
- Working with List Endpoints: pagination, filtering, and sorting.
- Working with Resource Endpoints: reading and updating single records.
- Timeouts, Retries and Idempotency: recovering safely from interrupted calls.
- Webhooks: how webhooks behave, what each request contains, and the fields each method sends.
- Setting Up Encrypted Webhooks: receiving webhook payloads encrypted.
For endpoint-level detail, see the API Reference.
Next¶
Start with 1. Set Up an Offering.