OpenApi SpecContact Us
Guides

Common Payload

Suggest Edits

The Common Payload (payloadTypeId=1) is the common response that one will find off the AMQP service. All other payloads follow this same layout, and will populate the data property with 1 or more items in the list.

Possible properties in data node:

Click to expand
  • accountId
  • bankId
  • cardId
  • clientId
  • contextId
  • customerTag
  • eventTimeUtc
  • externalAccountId
  • externalApplicationId
  • externalUrl
  • externalUserId
  • externalUserName
  • impactedCustomerId
  • impactedUserId
  • jobId
  • masterId
  • payloadTypeId
  • programId
  • transactionId
  • userEventId
  • userEventTypeId
  • userId
  • version

Example Payload

{
  "accountId": 32949324,
  "contextId": "fb79b2f9-7f67-4146-981e-77a62573a488",
  "data": [
    [
      {
        "userEventId": 2682003868,
        "userEventTypeId": 3059,
        "eventTimeUtc": "2023-02-10T14:51:52.450Z",
        "userId": 32949321,
        "bankId": 9187,
        "clientId": 9202,
        "programId": 9253,
        "impactedUserId": 32949321,
        "impactedCustomerId": 32949321,
        "contextId": "FB79B2F9-7F67-4146-981E-77A62573A488",
        "accountId": 32949324,
        "version": 1,
        "payloadTypeId": 1,
        "customerTag": "146940138"
      }
    ]
  ],
  "eventTimeUtc": "2023-02-10T14:51:52.000+00:00",
  "externalAccountId": 0,
  "impactedCustomerId": 32949321,
  "impactedUserId": 32949321,
  "payloadTypeId": 1,
  "userEventId": 2682003868,
  "userEventTypeId": 3059,
  "version": 1
}

{
   "accountId":0,
   "contextId":"93effe23-9933-467b-a401-604184a1bcde",
   "data":[
      [
         {
            "userEventId":2838653075,
            "userEventTypeId":40001001,
            "eventTimeUtc":"2023-05-18T17:57:42.923Z",
            "userId":33629234,
            "bankId":9552,
            "clientId":9553,
            "programId":9554,
            "impactedUserId":33629234,
            "impactedCustomerId":33629234,
            "contextId":"93EFFE23-9933-467B-A401-604184A1BCDE",
            "cardId":10204878,
            "version":1,
            "payloadTypeId":1,
            "CustomerTag":"132746571"
         }
      ]
   ],
   "eventTimeUtc":"2023-05-18T17:57:42.000+00:00",
   "externalAccountId":0,
   "impactedCustomerId":33629234,
   "impactedUserId":0,
   "payloadTypeId":1,
   "userEventId":2838653075,
   "userEventTypeId":40001001,
   "version":1
}

Updated 8 months ago