Webhook Documentation
Introduction
TransactAPI has webhooks which help you get notifications when TransactAPI methods respond with success. By using these webhooks, this alleviates the need to request a "get" method continuously to check on a status.
What is an webhook?
A webhook (also called a web callback or HTTP push API) is a way to exchange real-time information and updates automatically within two systems. Webhooks receive calls through HTTP POST requests only when the connected external system has a data update. APIs will place calls for data whether there's been a data update response, or not. This makes webhooks much more efficient for both provider and consumer.
While webhooks are an effective tool, they require an Internet connection between the data source and the web server to function. Additionally, a script must be present on the server at the destination URL and it must be able to recognize and parse the POST data. If the Internet connection or script is not available, the webhook will not work.
Creating webhooks and notifications
To create a webhook:
- Add the script URL in your admin panel under webhook menu in the dashboard for a particular API method. You can enable/disable notifications to be sent through email and SMS.
- Add notification and add email and/or SMS notification in your admin panel under the notification list menu in the dashboard.
*Sample Code
if ($conn->connect_error)
{
die("Connection failed: " . $conn->connect_error);
}
if (isset($_POST['partyId']))
{
$partyId = $_POST['partyId'];
$offeringId = $_POST['offeringId'];
$orderStatus = $_POST['orderStatus'];
$insert = mysqli_query($conn, "INSERT INTO checkworld (partyId,offeringId,orderStatus) VALUES ('$partyId','$offeringId','$orderStatus')")
or die(mysqli_error($conn));
print_r($insert);
}
Webhook Method List
Below is the complete list of webhook methods available in the TransactAPI.
Method | Description |
---|---|
ccFundMove | This webhook is triggered when an online credit card transaction is performed. |
cancelOffering | This webhook is triggered when an offering is cancelled via "cancelOffering" method. |
closeOffering | This webhook is triggered when an offering is closed via the "closeOffering" method. |
createAccount | This webhook is triggered when a new account is created. |
createLink | This webhook is triggered when a link is created. |
createMaaSUser | This webhook is triggered when a new user is created in the Marketplace-as-a-Service (MaaS) platform. |
createOrder | This webhook is triggered when a new order is created on the PPEX/ATS. |
createParty | This webhook is triggered when a new party is created. |
createTrade | This webhook is triggered when a new trade is created in an offering. |
deleteExternalAccount | This webhook is triggered when a linked bank account has been deleted from the associated account. |
deleteLink | This webhook is triggered when a link is deleted. |
deleteMaaSUser | This webhook is triggered when a MaaS user is deleted. |
deleteOffering | This webhook is triggered when an offering has been deleted via the deleteOffering method. |
deleteTrade | This webhook is triggered when a previously created trade is deleted (trade status is updated to “CANCELED”). |
editTrade | This webhook is triggered when trade information has been edited via the editTrade method. |
editTradeUnits | This webhook is triggered when the unit amount or unit price is updated. |
externalFundMove | This webhook is triggered when the fund movement has been initiated to move funds from the investors external account to the NCPS escrow account. |
getAccount | This webhook is triggered when the getAccount API is called. |
linkExternalAccount | This webhook is triggered when an investor links their external account using Plaid. |
matchedTradenotify | This webhook is triggered when a trade is matched. |
notifySettlement | This webhook is triggered when notifySettlement API is used to update a trades settlement status. |
performKycAml | This webhook is triggered when KYC/AML enhanced is performed. |
performKycAmlBasic | This webhook is triggered when KYC/AML basic is performed. |
requestAiVerification | This webhook is triggered when Accredited Investor Verification is requested for an Investor’s account in TransactAPI. |
requestCustodialAccount | This webhook is triggered when a Custodial Account is requested through the API. |
requestForVoidCCTransaction | This webhook is triggered when the requestForVoidCCTransaction is used to update a pending transaction to void. |
updateAccount | This webhook is triggered when an account is updated. |
updateAccountArchivestatus | This webhook is triggered when an account is archived. |
updateAiRequest | This webhook is triggered when new information has been uploaded by the investor and is ready for review, or if an updated letter is being requested. |
updateAiVerification | This webhook is triggered when the Accreditation Verification status has been updated. (Ex: From ‘ Pending’ to ‘Need More Info’) |
updateCCFundMoveStatus | This webhook is triggered when the Transaction Status for CreditCard is updated. (Ex: From ‘Pending’ to Submitted’) |
updateCustodialAccountRequest | This webhook is triggered when new information has been added to an existing custodial account request. |
updateDocuSignStatus | This webhook is triggered when the status of a DocuSign is updated. (Ex: From Out for Signature to Completed) |
updateEligibleToCloseStatus | This webhook is triggered when the Escrow status has been updated to 'Eligible to Close'. |
updateEntity | This webhook is triggered when an entity party is updated. |
updateExternalAccount | This webhook is triggered when an external bank account is updated. |
updateExternalFundMoveStatus | This webhook is triggered when the Transaction Status for ACH is updated. (Ex: From ‘Pending’ to Submitted’) |
updateKycAml | This webhook is triggered when the KYC/AML questions have been answered and the "updateKycAml" method has been invoked. |
updateLinkExternalAccount | This webhook is triggered when an external account is updated using Plaid. |
updateMaaSUser | This webhook is triggered when updates to the Marketplace-as-a-Service user have been updated. |
updateOffering | This webhook is triggered when an offering is updated in TransactAPI. |
updateOrder | |
updateParty | This webhook is triggered when a party is updated. |
updatePartyEntityArchivestatus | This webhook is triggered when a party is archived. |
updateTrade | This webhook is triggered when a trade is updated. |
updateTradeArchivestatus | This webhook is triggered when the archive status of a trade is updated. |
updateTradeDocArchivestatus | This webhook is triggered when a document for a trade is archived. |
updateTradeStatus | This webhook is triggered when the trade status has been updated. |
updateTradeTransactionType | This webhook is triggered when the transaction type (ex: Check, ACH, Wire, etc.) of a trade is changed. |
updateNdaDocuSignStatus | This webhook is triggered when the NDA Docusign signature status has been updated. |
uploadAccountDocument | This webhook is triggered when a document is uploaded and attached to an account. |
uploadPartyDocument | This webhook is triggered when a document is uploaded and attached to a party. |
uploadTradeDocument | This webhook is triggered when a document is uploaded and attached to a trade ID. |
uploadVerificationDocument | This webhook is triggered when a document is uploaded for accreditation verification. |
Updated 6 months ago