Webhook events
The purpose of this document is to explain the Webhook Events Export File Drop By Partner report.
You can use webhooks within the Cross River Operating System (COS) to notify you when different events occur.
Learn more about webhooks.
Term | Description |
|---|---|
CRB | Cross River Bank |
Partner | CRB’s immediate customer, i.e. you |
The table below shows the different columns included in the report together with descriptions and explanations of the information they represent.
Column | Description |
|---|---|
EventId | The unique ID for the event. |
EventName | The name of the event. |
Status | This column shows the event status, which could be:
|
Resource | Refers to the resource relating to the event. For example, an account that was opened. |
CreatedAt | The date and time the event was created. |
LastAttemptedAt | The date and time the event was last sent. |
PartnerId | The unique identification number for the partner resource. |
This section describes the different webhook events you can register for. Where relevant, additional information is provided for some of the events.
Event Name | Notes |
|---|---|
Core.Customer.Onboarded | A new customer was onboarded. |
Core.Customer.Profile.Changed | Information within a customer’s profile was changed. This does not include changes to CIF Number, Name, Address, Phone, Identification, or Email. |
Core.Customer.Name.Changed | The customer name changed. |
Core.Customer.CifNumber.Changed | The customer CIF number changed. |
Core.Customer.Address.Added | A customer address was added. |
Core.Customer.Address.Changed | A customer address was changed. |
Core.Customer.Address.Removed | A customer address was removed. |
Core.Customer.Phone.Added | A customer phone number was added. |
Core.Customer.Phone.Changed | A customer phone number changed. |
Core.Customer.Phone.Removed | A customer phone number was removed. |
Core.Customer.Identification.Added | A customer identification was added. |
Core.Customer.Identification.Changed | A customer identification changed. |
Core.Customer.Identification.Removed | A customer identification was removed. |
Core.Customer.Email.Added | A customer email address was added. |
Core.Customer.Email.Changed | A customer email address was changed. |
Core.Customer.Email.Removed | A customer email address was removed. |
Core.Customer.Ofac.Changed | A customer OFAC scan status was changed. |
Core.Customer.PepScan.Changed | A customer PEP scan status was changed. |
Event Name | Notes |
|---|---|
Core.Account.Opened | An account was opened. |
Core.Account.Status.Changed | An account status changed. |
Core.Account.Closed | An account was closed. |
Core.Account.Title.Changed | An account title changed. |
Core.Account.Settled | An account was settled. |
Core.SubAccount.Opened | A sub account was opened. |
Core.SubAccount.Status.Changed | A sub account status changed. |
Core.SubAccount.Closed | A sub account was closed. |
Core.SubAccount.Title.Changed | A sub account title was changed. |
Core.Relationship.Added | A relationship was added to an account, such as a joint owner. |
Core.Relationship.Removed | A relationship was removed from an account. |
Core.Restriction.Placed | A restriction was placed on an account. |
Core.Restriction.Removed | A restriction was removed from an account. |
Core.Fee.Assessed | A fee was assessed on an account. |
Core.Fee.Waived | A fee was waived on an account. |
Core.Interest.Accrued | Interest accrued on an account. |
Core.Interest.Paid | Interest was paid on an account. |
Core.Statement.Generated | An account statement was generated. |
Core.StatementDocument.Attached | A document (PDF) was attached to a statement record. |
Core.StopPayment.Placed | A stop payment was placed on an account. |
Core.StopPayment.Removed | A stop payment was removed from an account. |
Core.RegDPolicy.Violated | A Regulation D policy was violated on a savings account. |
Event Name | Notes |
|---|---|
Core.Transaction.Completed | The transaction was completed successfully. |
Core.Transaction.Rejected | COS was unable to complete the transaction. |
Core.Activity.Posted | Activity has posted to an account. |
Core.MemoPost.Created | A memo post was created for an account. |
Core.MemoPost.Changed | A memo post for an account was changed. |
Core.MemoPost.Removed | A memo post for an account was removed. |
Core.Hold.Placed | A hold was placed on an account. |
Core.Hold.Changed | A hold on an account was changed. |
Core.Hold.Removed | A hold on an account was removed. |
Event Name | Notes |
|---|---|
Ach.Payment.Canceled | An outbound payment was canceled at the partner's request. |
Ach.Payment.Rejected | An outbound payment could not be processed due to compliance reasons or failed-to-fund. |
Ach.Payment.Sent | An outbound payment has been transmitted to the Federal Reserve. |
Ach.Payment.Received | An inbound payment was received from another bank. |
Ach.Return.Received | A previously originated payment has been returned by the receiving bank. |
Ach.Noc.Received | A notification of change was sent from the receiving bank regarding a previous origination. |
Ach.Hold.Escalated | A hold relating to either an inbound or outbound payment was marked for escalation by a member of the CRB Operations team. This is used to indicate that the partner either needs to provide additional documentation or take further action. |
Event Name | Description |
|---|---|
RTP.Payment.Sent | An outbound payment was successfully sent to the receiving institution and the funds are available in the receiver's bank account. |
RTP.Payment.Received | An inbound payment has been received from another institution and has successfully posted to an account in COS. |
RTP.Payment.Rejected | Payment was rejected by the receiving institution or RTP Network. |
RTP.Payment.Canceled | Payment was canceled at the request of the partner or a payment with a status of ResearchRequired has been canceled. |
RTP.Payment.ResearchRequired | No response was received for an outbound payment. Manual research is required to determine if the payment should be completed or canceled. |
RTP.Payment.Failed | Payment failed due to technical reasons. |
RTP.Hold.Escalated | A hold relating to an outbound payment was marked for escalation by a member of the CRB Operations team. This is used to indicate that the partner either needs to provide additional documentation or take further action. |
RTP.Refund.Requested | A request has been received to refund a previously accepted credit transfer |
Event Name | Description |
|---|---|
Wire.Payment.Canceled | An outbound wire was cancelled at the partner's request |
Wire.Payment.Rejected | An outbound wire could not be processed due to compliance reasons or was rejected by the Federal Reserve. |
Wire.Payment.Processed | An outbound wire was transmitted to the Federal Reserve. |
Wire.Payment.Sent | An outbound wire was transmitted to the Federal Reserve and has been successfully acknowledged. An IMAD number is now available. |
Wire.Payment.Received | An inbound wire has been received from another bank. |
Wire.Hold.Escalated | A hold relating to either an inbound or outbound wire was marked for escalation by a member of the CRB Operations team. This is used to indicate additional documentation or action is needed by the partner. |
Event Name | Description |
|---|---|
XPay.Payment.Received | An inbound payment request has been received and is awaiting approval. |
XPay.Payment.Canceled | A payment was cancelled at the sender's request or it has expired. |
XPay.Payment.Approved | Payment was approved by the receiver. |
XPay.Payment.Rejected | Payment was rejected by the receiver. |
XPay.Payment.Failed | Payment failed to post to either the sender or receiver's account. This is normally due to insufficient funds. |
XPay.Payment.Completed | Payment has been posted to both the sender’s and receiver's accounts. |
Event Name | Description |
|---|---|
DebitCard.Card.Activated | A card was activated successfully. |
DebitCard.Card.UnderReview | A card was changed to “review” status. |
DebitCard.Card.Closed | A card has been permanently closed. |
DebitCard.Card.Created | A card has been created and is pending activation. |
DebitCard.Card.CreateFailed | Card creation failed. |
DebitCard.Card.Ordered | A card has been ordered and will be mailed to the customer. |
DebitCard.Card.PinCreated | A card PIN was set for the first time. |
DebitCard.Card.PinReset | A card PIN was reset. |
DebitCard.Card.ProfileChanged | Profile data for the card (such as address) has been changed. |
DebitCard.Card.Reactivated | A previously suspended card has been reactivated. |
DebitCard.Card.Replaced | A lost or damaged card has been replaced. |
DebitCard.Card.Suspended | A card has been suspended temporarily. |
DebitCard.Authorization.Created | Purchase authorization has been memo-posted to the account. |
DebitCard.Authorization.Cleared | Purchase authorization has cleared and no further incremental changes are expected. |
DebitCard.Authorization.Changed | The purchase authorization amount has changed. |
DebitCard.Authorization.Settled | Purchase authorization has been posted in the form of an account transaction. The original memo post has been removed. |
Event Name | Description |
|---|---|
Check.Payment.Sent | A check deposit has been sent to the Federal Reserve for clearing. |
Check.Payment.Received | A check drawn on an account in COS has been deposited at another bank and has been received from the Federal Reserve for posting. |
Check.Payment.Canceled | An outbound payment has been canceled at the request of the partner. |
Check.Payment.Rejected | An outbound check could not be processed either for compliance reasons or it was rejected by the Federal Reserve. |
Check.Payment.Returned | A previously deposited check has been returned by the receiving bank. |
