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)

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=59249

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
offeringDetails	string	Details of the matched offer trades amount as an array

offeringDetails Parameters	Type	Description
issuerId	string	Issuer ID that is generated by the API when an Issuer is created (createIssuer)
offeringId	string	API Status Description
issueName	string	Name of the Offering
issueType	string	Type of Offering: Equity, Debt, Hybrid, Fund
targetAmount	string	The Target Amount of the Raise (should be LESS than Maximum Amount)
minAmount	string	The Minimum amount that can be invested at one time
maxAmount	string	The Maximum amount of the offering (cap amount)
unitPrice	string	Price per Unit (unit/share price). The investment can only be made in increments of this number.
totalShares	string	Total number shares for this offering
remainingShares	string	Shares remaining for this offering
startDate	string	Offering Start Date
endDate	string	Offering End Date
offeringStatus	string	Offering Status: Approved, Pending, Denied
stampingText	string	The text that is watermarked on the offering documents(addDocumentsforOffering). ( Example: "Confidential" )
escrowAccountNumber	string	Escrow Account Number
field1	string	Additional information relating to the offering. Custom Field 1
field2	string	Additional information relating to the offering. Custom Field 2
field3	string	Additional information relating to the offering. Custom Field 3
offeringText	string	A brief description of the offering.

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "offeringDetails": [
        {
            "issuerId": "596423",
            "offeringId": "97618",
            "issueName": "Lauren Test Offering",
            "issueType": "Equity",
            "targetAmount": "37000.000000",
            "minAmount": "1.000000",
            "maxAmount": "37000.000000",
            "unitPrice": "1.000000",
            "totalShares": "37000.000000",
            "remainingShares": "14712.050946",
            "startDate": "02-11-2021",
            "endDate": "02-14-2022",
            "offeringStatus": "Pending",
            "offeringText": "Offering Text",
            "stampingText": "Watermark",
            "escrowAccountNumber": null,
            "field1": null,
            "field2": null,
            "field3": null
        }
    ]
}

Test it Yourself!