createOffering

PUT https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/createOffering

This method is used to create an offering/deal in Transact API. This method will return the Offering ID as a successful response.

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
issuerId	yes	integer	Issuer ID that is generated by the API when an Issuer is created (createIssuer)
issueName	yes	string	Name of the Offering
issueType	yes	conditional	Type of Offering: Equity, Debt, Hybrid, Fund
targetAmount	yes	decimal	The Target Amount of the Raise (should be LESS than Maximum Amount)
minAmount	yes	decimal	The Minimum amount that can be invested at one time
maxAmount	yes	decimal	The Maximum amount of the offering (cap amount)
unitPrice	yes	decimal	Price per Unit (unit/share price). The investment can only be made in increments of this number.
startDate	yes	string	Offering Start Date
endDate	yes	string	Offering End Date
offeringText	yes	string	A brief description of the offering.
stampingText	yes	string	The text that is watermarked on the offering documents(addDocumentsforOffering). ( Example: "Confidential" )
createIPAddress	no	string	Requested IP Address
escrowAccountNumber	no	string	Escrow Account Number
field1	no	string	Additional information relating to the offering. Custom Field 1
field2	no	string	Additional information relating to the offering. Custom Field 2
field3	no	string	Additional information relating to the offering. Custom Field 3

Sample Request

cURL

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/createOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d issuerId=564631
-d issueName=My issue
-d issueType=debt
-d targetAmount=9000.00
-d minAmount=100.00
-d maxAmount=10000.00
-d unitPrice=25.50
-d startDate=08-23-2014
-d endDate=08-23-2015
-d offeringText=My Text
-d stampingText=Sample Text
-d escrowAccountNumber=Sample Text
-d field1=Sample Text
-d field2=Sample Text
-d field3=Sample Text
-d createdIPAddress=10.0.0.9

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
offeringDetails	string[]	The first value should be ignored. The second value is an array with one element, the new <object> created by this request. See details below

offeringDetails Parameters	Type	Description
offeringId	integer	Generated Offering ID
offeringStatus	string	Status of offering like Pending | Approved | Denied

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    true,
    [
      {
        "offeringId": "48587",
        "offeringStatus": "Pending"
      }
    ]
  ]
}

Test it Yourself!