post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/createTrade
This method is used to create a trade/investment for an offering. This requires Account ID and the total number of units/shares to be purchased by the account. Creating a trade represents the intention to invest and does NOT initiate any sort of fund move. To initiate an ACH transfer for a trade, you will need to use the externalFundMove method.
Request Parameters
Parameter | Required | Type | Description |
---|---|---|---|
clientID | yes | string | TransactAPI Client ID |
developerAPIKey | yes | string | TransactAPI Developer Key |
offeringId | yes | string | Offering ID that is generated by the API when an offering is created (createOffering) |
accountId | yes | string | Account ID of the account that is investing (this account should have one primary party) |
transactionType | yes | string | Transaction Type as ACH / WIRE / CHECK / CREDITCARD / TBD / IRA |
transactionUnits | yes | string | Number of units/shares to be purchased |
createdIpAddress | yes | string | Requested IP Address |
field1 | no | string | Additional information relating to the trade. Custom Field 1 |
field2 | no | string | Additional information relating to the trade. Custom Field 2 |
field3 | no | string | Additional information relating to the trade. Custom Field 3 |
RRApprovalStatus | no | string | "Pending", "Approved", "Disapproved", or "Under Review" |
RRName | no | string | Some Text |
RRApprovalDate | no | string | Approval Date eg: MM-DD-YYYY |
PrincipalApprovalStatus | no | string | "Pending", "Approved", "Disapproved", or "Under Review" |
PrincipalName | no | string | Some Text |
PrincipalDate | no | string | Principal Date eg: MM-DD-YYYY |
closeId | no | string | closeId |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/createTrade
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=55591
-d accountId=A12345
-d transactionType=ACH
-d transactionUnits=20.35
-d field1= additional information1
-d field2= additional information2
-d field3= additional information3
-d RRApprovalStatus= Pending
-d RRName= Some text
-d RRApprovalDate= Approval Date
-d PrincipalApprovalStatus= Pending
-d PrincipalName= Some text
-d PrincipalDate= Principal Date
-d createdIpAddress=10.0.0.9
-d closeId=closeId
Response Parameters
Parameter | Type | Description |
---|---|---|
statusCode | string | API Status Code |
statusDesc | string | API Status Description |
purchaseDetails | string | Returns an array of purchase details with transactionId, transactionAmount, transactionDate, transactionStatus |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"purchaseDetails": [
true, [{
"tradeId": "1001342830",
"transactionId": "476693475244",
"transactionAmount": "2500.55",
"transactionDate": "2014-12-09 04:29:29",
"transactionStatus": "CREATED",
"RRApprovalStatus": "Pending",
"RRName": "Test",
"RRApprovalDate": "09-10-2019",
"PrincipalApprovalStatus": "Pending",
"PrincipalName": "Test",
"PrincipalDate": "09-10-2019",
"closeId": null,
"eligibleToClose": "no"
}]
]
}