post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/closeOffering
This method closes the offering and cannot be invoked until all trade statuses are one of the following: Funded, Settled, Canceled or Unwind Settled. The offering can only be closed once all funding activity has been completed. Please note that this does NOT update trade statuses to "Settled."
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) of the offering that is to be closed. |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/closeOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=55593
Response Parameters
Parameter | Type | Description |
---|---|---|
statusCode | string | API Status Code |
statusDesc | string | API Status Description |
offeringId | string | Returns the Closed Offering ID |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"OfferID": "59663"
}