Webhook Event Data

Customers Bank will send webhooks to notify applications when an event occurs. The payload will include an ID about the item that was impacted. We do not send a full payload detailing data that was changed/modified. You can use the ID of the event to make a request to get the updated information.

Header Field

The event being dispatched from the webhook is passed via the X-Event-Type header of the payload. A sample payload can be found below. This is the way to identify which event was sent so your system can process it accordingly.

POST /api/cubix/webhooks HTTP/1.1
X-Idempotency-Key: C91C0D5C-D3A6-4C93-8E69-4C10329E2EF9
X-Event-Type: transfers.book-completed
Authorization-Timestamp: Thu, 05 Sep 2024 19:11:03 GMT
Authorization: HMAC-SHA256 Signature=vPdOjc5jdb5Bke5SU1ncCppvBz3cH59TYOcao53ksec=
Host: mydomain.com

{"Id":"3c1d8cc1-1ef6-211f-8078-b1e10139e993"}

Body Payload

The payload of the body is a JSON object with the id of the impacted resource. Use the corresponding event identifier and the Id to act accordingly

{
  "Id":"3c1d8cc1-1ef6-211f-8078-b1e10139e993" //id of impacted events
}

Given the id above, with the event transfers.book-completed this will tell you that the book transfer for record 3c1d8cc1-1ef6-211f-8078-b1e10139e993 has finished processing in our system. Any action your system needs to take can then be executed.

Transfers Events

Below is a list of event type id's for Transfers and what each event indicates.

Event Id	Description
transfers.book-completed	The associated book transfer has completed
transfers.book-declined	The associated book transfer has been declined
transfers.book-received	A new book transfer has been received
transfers.book-rejected	The associated book transfer has been declined
transfers.book-initiated	A new book transfer has been initiated
transfers.book-requires-approval	The associated book transfer requires approval.

Event Id	Description
transfers.account-link-removed	The associated account link has been removed
transfers.account-link-approved	The associated account link has been approved
transfers.account-link-declined	The associated account link has been declined

Event Id	Description
transfers.addressbook-entry-incoming-request	A new address book entry has been requested

Wire Events

Below is a list of event type id's for for Wires and what each event indicates.

Event Id	Description
wires.outgoing-initiated	The outgoing wire was initiated
wires.outgoing-pending	The outgoing wire is pending
wires.outgoing-accepted	The outgoing wire has been accepted
wires.outgoing-completed	The outgoing wire has been completed
wires.outgoing-rejected	The outgoing wire has been rejected
wires.outgoing-returned	The outgoing wire has been returned

{
    "TransactionId": "00000000-0000-0000-0000-000000000000",
    "AccountNumber": "xxxxxxx",
    "Amount": 16.00,
    "Beneficiary": "Beneficiary",
    "ProcessDate": "2024-09-26T00:00:00",
    "Notes": "Test Swift",
    "Imad": "20240926CUSTXXXX096417"
}

Event Id	Description
wires.outgoing-cancelled	The outgoing wire has been cancelled

{
    "TransactionId": "00000000-0000-0000-0000-000000000000",
    "AccountNumber": "xxxxxxx",
    "Amount": 16.00,
    "Beneficiary": "Beneficiary",
    "ProcessDate": "2024-09-26T00:00:00",
    "Notes": "Test Swift",
    "Imad": "20240926CUSTXXXX096417",
     “Reason”: “Reason”
}

Event Id	Description
wires.incoming-received	The incoming wire has been received

{
    "Id": "00000000-0000-0000-0000-000000000000",
    "AccountNumber": "xxxxxxx",
    "Amount": 0.01,
    "IsReturn": false,
    "Notes": "TEST INCOMING WIRE",
    "OriginatorName": "John Doe"
}

FedNow Events

Below is a list of event type id's for RTP and what each event indicates.

Event Id	Description
fednow.incoming-received	An incoming FedNow has been received. Details can be retrieved via GET /incoming/{id}

RTP Events

Below is a list of event type id's for RTP and what each event indicates.

Event Id	Description
rtp.incoming-received	An incoming RTP has been received. Details can be retrieved at GET /incoming/{id}