POST /tch/notifications
This endpoint allows us to receive token notifications from The Clearing House (TCH). The schema is defined by TCH.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
tokenRequestorId |
String | No |
Token requestor identifier associated to the domain to which the token belongs. |
tokenReferenceId |
String | No |
Unique reference identifier for the token generated. |
conversationId |
String | Yes |
Message identifier assigned for the entire conversation (GUID v4 format). Typically, it is generated by the initiator of the flow. The response has the same value with its request. |
messageId |
String | Yes |
Unique message identifier (GUID v4 format) of this command, used for tracking purposes. Each request and its response have the same value. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.