getTradeStatus

POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getTradeStatus

This method is used to get the current trade details as an array with the current trade status

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
tradeId	yes	string	Trade ID generated by the API

Sample Request

cURL

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getTradeStatus
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=141103099

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
tradeDetails	string	Returns the current trade details as an array with the current trade status

Parameter	Type	Description
id	string	n/a
developerAPIKey	string	n/a (this comes through as xxxxxxxxxxx)
offeringId	string	Offering ID that is generated by the API when an offering is created (createOffering)
accountId	string	Account ID of the account that is investing (this account should have one primary party)
partyId	string	Party ID that is generated by the API once an individual party is created (createParty)
party_type	string	Type of party (Account, IndivACParty, EntityACParty)
escrowId	string	escrowId
orderId	string	trade ID
transactionType	string	Transaction Type as ACH / WIRE / CHECK / CREDITCARD / TBD / IRA / EXTERNAL CREDIT CARD / EXTERNAL ACH / NCPS CUSTODY ACCOUNT
totalAmount	string	Dollar amount of the trade
totalShares	string	Number of units/shares to be purchased
orderStatus	string	Trade Status: CREATED | FUNDED | UNWIND PENDING | UNWIND SETTLED | SETTLED
createdDate	string	Date trade was created (YYYY-MM-DD HH:MM:SS)
createdIpAddress	string	Requested IP Address
errors	string
documentKey	string	Subscription document Key
esignStatus	string	Indicates whether a subscription document through Docusign integration is signed
users	string
field1	string	Additional information relating to the trade. Custom Field 1
field2	string	Additional information relating to the trade. Custom Field 2
field3	string	Additional information relating to the trade. Custom Field 3
RRApprovalStatus	string	"Pending", "Approved", "Disapproved", or "Under Review"
RRName	string	Some text
RRApprovalDate	string	Approval Date eg: MM-DD-YYYY
PrincipalApprovalStatus	string	"Pending", "Approved", "Disapproved", or "Under Review"
PrincipalName	string	Some Text
PrincipalDate	string	Principal Date eg: MM-DD-YYYY
archived_status	string	0/1
closeId	string	closeId
eligibleToClose	string	yes/no
notes	string	some text

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "tradeDetails": [
        {
            "id": "2010692",
            "developerAPIKey": "XXXXXXXXXXXXXXX",
            "offeringId": "1682053",
            "accountId": "A2923641",
            "partyId": "P2488725",
            "party_type": "IndivACParty",
            "escrowId": null,
            "orderId": "1001630791",
            "transactionType": "CHECK",
            "totalAmount": "100.000000",
            "totalShares": "50.000000",
            "orderStatus": "CREATED",
            "createdDate": "2024-11-04 21:34:26",
            "createdIpAddress": null,
            "errors": "",
            "documentKey": "",
            "esignStatus": "NOTSIGNED",
            "users": "",
            "field1": "",
            "field2": "",
            "field3": "",
            "RRApprovalStatus": "Pending",
            "RRName": null,
            "RRApprovalDate": null,
            "PrincipalApprovalStatus": "Pending",
            "PrincipalName": null,
            "PrincipalDate": null,
            "archived_status": "0",
            "closeId": null,
            "eligibleToClose": "no",
            "notes": ""
        }
    ]
}

Test it Yourself!