Webhook Specifications

RQD* Clearing offers a robust webhook notification platform that can be used to track events important to your business. Webhook notifications are supported for several events, including:

Accounts

  • Creation of new accounts

  • Update of account properties and statuses

Margin & Risk

  • Creation and satisfaction of margin calls

  • Custom risk threshold alerts

Cashiering

  • Creation of new wire and ACH requests

  • Status updates of cash movement requests

ACATS

  • Creation of inbound or outbound ACATS requests

  • Status updates of ACATS transfers

Transactions

  • Creation of trade events in client accounts

  • Options exercise and assignment activity

Non-Trade

  • Non-trade related activity such as incoming wires, corporate actions, dividends, and other non-trade related activity

How-To and Sample Output

RQD's notifications are lightweight and designed to be used in conjunction with our REST API to avoid unnecessary polling and also reduce transaction processing time in your applications. In order to receive notifications, you will be required to set up an publically available HTTP endpoint that can be used to receive POSTs from our systems.

An example of a typical notification can be seen below:

[{
     "NotificationID":"CE59C208-CFAC-4A8E-8D89-F358A0FEF191",
     "RelatedID":"VLNT-001-1000012878-M",
     "EndpointType":"Margin",
     "TransactionType":"UPDATE",
     "Corr":"VLNT",
     "CreateDateTime":"2021-12-28T22:05:31",
     "AdditionalDetails":"This is a test notification",
     "Sign":"A914719DEB5C6B1796254651C1EF8C9C"
}]

Each notification has an associated GET endpoint and RelatedID field that can be used to query for the full details of the transaction using RQD's REST API. In order to retrieve the full details of the associated event, simply use the below mapping of EndpointType to Associated GET Endpoint:

EndpointType
Associated GET
RelatedID
ID Form

Accounts

/GetAccounts

Corr/Office/Acct_No

String

Margin

/GetMarginCalls

MarginCallID

GUID

Cashiering-Wire

/GetWireRequests

CashID

GUID

Cashiering-ACH

/GetACHRequests

CashID

GUID

ACATS

/GetACATS

Ctrl_No

String

Transactions

/GetTransactions

tr_no

Decimal(19,6)

Authentication

RQD recommends the following authentication strategies as part of consumption of notifications:

  1. Whitelist of RQD's production IP addresses, provided as part of the integration setup.

  2. Verification of the sign property passed in the body of the notification. Each sign is computed based on a MD5 hash of the properties of the notification plus a salt value determined at the initial configuration. When verifying that RQD is the bonafide transmitter of the message, use the following string format in your hash algorithm with a UTF-8 encoding. Note that any empty properties should have their value set to literal string "null".

    AdditionalDetails={AdditionalDetailsValue}&Corr={CorrValue}&CreateDateTime={CreateDateTimeValue}&EndpointType={EndpointTypeValue}&RelatedID={RelatedIDValue}&TransactionType={TransactionTypeValue}&NotificationID={NotificationIDValue}&{Salt}

If you would like to request different authentication methodologies, please contact api-support@rqdclearing.com.

Get Started

To get started receiving webhook notifications, please contact api-support@rqdclearing.com!