updateTradeStatus

This method is used to update the status of a trade. CREATED - Investment has been created and funds have not yet been received; FUNDED - Funds have been received in escrow; UNWIND PENDING - The funds have been received in escrow and is pending to be returned to the investor; UNWIND SETTLED - The funds have been received in escrow then returned back to the investor; SETTLED - The investment has been accepted by the Issuer and funds have been released from escrow to the Issuer;

Request Parameters

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
tradeIdyesintegerTrade ID generated by the API
accountIdyesstringAccount ID generated by the API
orderStatusyesconditionalTrade Status: CREATED | FUNDED | UNWIND PENDING | UNWIND SETTLED | SETTLED
errDescnostringTransact API's Error Description
field1nostringfield1
field2nostringfield2
field3nostringfield3
closeIdnostringcloseId
RRNamenostringRRName
RRApprovalDatenostringRRApprovalDate
RRApprovalStatusnostringRRApprovalStatus
PrincipalNamenostringPrincipalName
PrincipalDatenostringPrincipalDate
PrincipalApprovalStatusnostringPrincipalApprovalStatus

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/updateTradeStatus
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=141103099
-d accountId=A11501
-d orderStatus=CREATED
-d RRApprovalStatus=Pending
-d RRName=test
-d RRApprovalDate=11-11-2020
-d PrincipalApprovalStatus=Approved
-d PrincipalName=test
-d PrincipalDate=11-18-2020
-d errDesc=error
-d field1= Additional information relating to the trade. Custom Field 1
-d field2= Additional information relating to the trade. Custom Field 2
-d field3=Additional information relating to the trade. Custom Field 3
-d closeId=closeId

Response Parameters

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
tradeDetailsstringArray of trade details (partyId, offeringId, orderStatus)

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "tradeDetails": [
        {
            "partyId": "P00197",
            "offeringId": "32957",
            "orderStatus": "FUNDED"
        }
    ]
}

Test it Yourself!

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