This method is used to cancel/terminate an offering (usually if the offering fails).

Request Parameters

clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
offeringIdyesintegerOffering ID that is generated by the API when an Offering is created(createOffering) of the offering that is to be cancelled

Sample Request

curl -k -X POST
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=41994

Response Parameters

statusCodestringAPI Status Code
statusDescstringAPI Status Description
offeringDetailsstringReturns the cancelled offering details as an array

Sample Response

  "statusCode": "101",
  "statusDesc": "Ok",
  "Financial offering details": "41994"

Test it Yourself!

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