Sign in
plaid

Receive token notifications from The Clearing House (TCH).

This endpoint allows us to receive token notifications from The Clearing House (TCH). The schema is defined by TCH.

post/tch/notifications

Request body

messageIdstring required

Unique message identifier (GUID v4 format) of this command, used for tracking purposes. Each request and its response have the same value.

conversationIdstring required

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.

tokenRequestorIdstring nullable

Token requestor identifier associated to the domain to which the token belongs.

tokenReferenceIdstring nullable

Unique reference identifier for the token generated.

tokenTimestampstring date-time nullable

The event timestamp of the last state change.

Example request

{
  "tokenTimestamp": "2021-07-15T14:46:41.375Z"
}

Response

OK

messageIdstring required

Unique message identifier (GUID v4 format) of this command. It is used for the tracking purpose. Each request and its response have same value.

conversationIdstring required

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.

statusCodestring

The five digit status code.

statusMessagestring

Human readable comments about the status.

Changes