Webhooks

This page describes the webhook payloads associated with the lifecycle events.

Internal account

Lifecycle

flowchart TD
    A[<a href="#internal_account_A">Created</a>]

Payload

Internal account created

{
  "event": {
    "orgId": 22959,
    "entity": "InternalAccounts",
    "eventType": "CREATE",
    "numRetries": 0,
    "createdAt": "2025-11-11T11:06:49.323Z",
    "updatedAt": "2025-11-11T11:06:49.323Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "owner": "FIRST_PARTY",
    "accountId": "030b99f9-4171-4e17-847e-ca80e6830694",
    "status": "ACTIVE",
    "createdAt": "2025-11-11T11:06:48.461Z",
    "updatedAt": "2025-11-11T11:06:49.211Z",
    "accountDetails": {
      "currency": "AED",
      "accountNumber": "AE100961000836020002562",
      "beneficiaryName": "TEST OL ONE",
      "bankName": "Zand",
      "bankCountry": "UAE",
      "iban": "AE100961000836020002562",
      "type": "iban",
      "branchId": "05",
      "clientId": "1000836",
      "accountId": "1000836020002562",
      "accountType": "FI",
      "accountSubType": "VirtualAccount"
    }
  }
}

External account

Lifecycle

flowchart TD
    A[<a href="#external_account_A">Created</a>]
    B[<a href="#external_account_B">Active</a>]
    
    A --> B

Payload

External account created

{
  "event": {
    "orgId": 22959,
    "entity": "ExternalAccounts",
    "eventType": "CREATE",
    "numRetries": 0,
    "createdAt": "2025-11-11T11:15:08.041Z",
    "updatedAt": "2025-11-11T11:15:08.041Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "owner": "THIRD_PARTY",
    "counterPartyId": "dr.watson.1762854189",
    "accountId": "c98c2c44-bf49-451b-a7a5-97d8c6faf2ae",
    "status": "INACTIVE",
    "createdAt": "2025-11-11T11:15:07.923Z",
    "updatedAt": "2025-11-11T11:15:07.923Z",
    "accountDetails": {
      "currency": "AED",
      "accountNumber": "AE070331234567890123455",
      "beneficiaryName": "Dr Watson",
      "bankName": "ENBD",
      "bankCountry": "Dubai",
      "type": "swift",
      "swift": "SWIFT012"
    }
  }
}

External account active

{
  "event": {
    "orgId": 22959,
    "entity": "ExternalAccounts",
    "eventType": "UPDATE",
    "numRetries": 0,
    "createdAt": "2025-11-11T12:08:56.056Z",
    "updatedAt": "2025-11-11T12:08:56.056Z"
  },
  "data": {
    "orgUserId": "lestrade.1762852159",
    "owner": "THIRD_PARTY",
    "counterPartyId": "dr.watson.1762854189",
    "accountId": "485d5235-4745-4222-9346-41f7c2d38feb",
    "status": "ACTIVE",
    "createdAt": "2025-11-11T12:08:39.169Z",
    "updatedAt": "2025-11-11T12:08:55.777Z",
    "accountDetails": {
      "currency": "AED",
      "accountNumber": "AE860355632755911352697",
      "beneficiaryName": "Dr Watson",
      "bankName": "ENBD",
      "bankCountry": "Dubai",
      "type": "swift",
      "swift": "SWIFT012"
    }
  }
}