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

clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
issuerIdyesintegerIssuer ID that is generated by the API when an Issuer is created (createIssuer)
issueNameyesstringName of the Offering
issueTypeyesconditionalType of Offering: Equity, Debt, Hybrid, Fund
targetAmountyesdecimalThe Target Amount of the Raise (should be LESS than Maximum Amount)
minAmountyesdecimalThe Minimum amount that can be invested at one time
maxAmountyesdecimalThe Maximum amount of the offering (cap amount)
unitPriceyesdecimalPrice per Unit (unit/share price). The investment can only be made in increments of this number.
startDateyesstringOffering Start Date
endDateyesstringOffering End Date
offeringTextyesstringA brief description of the offering.
stampingTextyesstringThe text that is watermarked on the offering documents(addDocumentsforOffering). ( Example: "Confidential" )
createIPAddressnostringRequested IP Address
escrowAccountNumbernostringEscrow Account Number
field1nostringAdditional information relating to the offering. Custom Field 1
field2nostringAdditional information relating to the offering. Custom Field 2
field3nostringAdditional information relating to the offering. Custom Field 3

Sample Request

curl -k -X PUT
-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=

Response Parameters

statusCodestringAPI Status Code
statusDescstringAPI Status Description
offeringIdintegerGenerated Offering ID
offeringStatusstringStatus of offering like Pending | Approved | Denied

Sample Response

  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
        "offeringId": "48587",
        "offeringStatus": "Pending"

Test it Yourself!

Click Try It! to start a request and see the response here!