Skip to content
/
Linked Account Update

Linked Account Update
Webhook

Request

Notification of the status update for a linked Account.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger, (int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signaturestringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

Bodyapplication/jsonrequired

Payment run event triggered when the status changes

typestringrequired
Value:"linkedAccountWatch"
payloadobject or StatusErrorDuplicatedAccount (object) or StatusRejected (object) or StatusRejectedMultipleLinkedAccounts (object)(Linked Account Status)required
One of:
Payload
{
  "type": "linkedAccountWatch",
  "payload": {
    "id": "652d25b73541d8084a88a38d",
    "accountIdentification": { … },
    "currency": "GBP",
    "institution": { … },
    "consent": { … },
    "status": "LINKED",
    "friendlyName": "string",
    "buyerId": "string",
    "userId": "string"
  }
}

Responses

Return a 200 status to indicate that the data was received successfully