Counterparty ID Changed (counterpartyIdChanged)

Sent when the counterparty id on transactions has changed.

Id: counterpartyIdChanged

Event that notifies when the counterparty id on one or more transactions has changed. Fetch the transactions from the API to read the current counterpartyId.

Payload

These fields are sent in the payload object of the webhook envelope.

NameTypeDescription
transactionsarrayThe transactions whose counterparty id changed
transactions[].idstringTransaction id
transactions[].accountIdstringAccount id
counterpartyIdV1stringCounterparty id from the first counterparty id version
counterpartyIdV2stringCounterparty id from the second counterparty id version

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "counterpartyIdChanged",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "transactions": [
      {
        "id": "d520402a-d982-43ee-b1d1-bdfd282249ea",
        "accountId": "6d0baf11-248e-4c11-9c04-97b7758b4e04"
      }
    ],
    "counterpartyIdV1": "89c1e2a0-4b6d-4f1a-9c3e-1a2b3c4d5e6f",
    "counterpartyIdV2": "a7920ee2-62f4-5465-84eb-af6ef1f7074a"
  }
}

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.

Related