Webhooks
Banking and payments

Webhook events

9min

Customer events

Event Name

Description

Core.Customer.Onboarded

New customer was onboarded

Core.Customer.Profile.Changed

Customer profile was changed

Core.Customer.Name.Changed

Customer name changed

Core.Customer.CifNumber.Changed

Customer CIF number was changed

Core.Customer.Address.Added

Customer address was added

Core.Customer.Address.Changed

Customer address was changed

Core.Customer.Address.Removed

Customer address was removed

Core.Customer.Phone.Added

Customer phone number was added

Core.Customer.Phone.Changed

Customer phone number was changed

Core.Customer.Phone.Removed

Customer phone number was removed

Core.Customer.Identification.Added

Customer identification was added

Core.Customer.Identification.Changed

Customer identification changed

Core.Customer.Identification.Removed

Customer identification was removed

Core.Customer.Email.Added

Customer email was added

Core.Customer.Email.Changed

Customer email was changed

Core.Customer.Email.Removed

Customer email was removed

Core.Customer.Ofac.Changed

Customer OFAC scan resulted in a status change

Core.Customer.PepScan.Changed

Customer PEP Scan resulted in a status change

Core.Statement.Generated

Account statement generated

Core.TaxDocument.Generated

Tax document generated

Account And Transaction events

Event Name

Notes

Core.Account.Opened

A new account was opened

Core.Account.Status.Changed

Status of an account changed

Core.Account.Closed

Account was closed

Core.Account.Title.Changed

Account title changed

Core.SubAccount.Opened

Subaccount was opened

Core.SubAccount.Status.Changed

Status of a subaccount changed

Core.SubAccount.Closed

Subaccount was closed

Core.SubAccount.Title.Changed

Title of subaccount changed

Core.Relationship.Added

Relationship was added to the account

Core.Relationship.Removed

Relationship was removed from the account

Core.Restriction.Placed

Restriction was placed on the account

Core.Restriction.Removed

Restriction was removed for the account

Core.StopPayment.Placed

Stop payment placed on the account

Core.StopPayment.Removed

Stop payment removed from the account

Core.RegDPolicy.Violated

Reg D was violated on a savings account

Core.Transaction.Completed

Transaction completed successfully

Core.Transaction.Rejected

Transaction was rejected on account

Core.Activity.Posted

Activity was posted to the account

Core.MemoPost.Created

Memo post was created on the account

Core.MemoPost.Changed

Memo post was changed

Core.MemoPost.Removed

Memo post was removed

Core.Hold.Placed

Hold placed on the account

Core.Hold.Changed

Hold status has changed

Core.Hold.Removed

Hold was removed from the account

ACH events

Event Name

Description

Ach.Batch.Canceled

Any pending or on-hold payments in an ACH client batch canceled

Ach.Batch.Imported

Entire ACH client batch import process into the CR system complete

Ach.Payment.Canceled

ACH payment canceled at partner request

Ach.Payment.Rejected

ACH payment rejected due to a compliance failure or fail to fund

Ach.Payment.Sent

ACH payment sent to the Federal Reserve

Ach.Payment.Received

ACH inbound payment received

Ach.Payment.ReceivedEarly

ACH early direct deposit payment received

Ach.Return.Received

ACH payment was returned from the receiving bank and has been marked as received

Ach.Noc.Received

A Notification of Change was sent from the receiving bank regarding a previous origination

Ach.Hold.Escalated

ACH inbound or outbound payment is on hold and it's status was escalated. This is often used to indicate that additional actions are needed

RTP events

Event Name

Description

Rtp.Payment.Sent

RTP payment has been successfully sent to the receiving institution and the funds are available in the receiver's bank account

Rtp.Payment.Received

Inbound payment has been received from another institution and has successfully posted to an account in COS

Rtp.Payment.Rejected

Payment has been rejected by the receiving institution or RTP Network. The payment originated from an account with insufficient funds.

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 has failed due to technical reasons.

Rtp.Hold.Escalated

A hold relating to either an outbound payment was marked for escalation by a member of the Operations team. Commonly this is used to indicate additional documentation or action is needed by the partner.

Rtp.Refund.Requested

Request has been received to refund a previously accepted credit transfer

Rtp.Payment.Queued

The receiving institution is offline. The payment will be processed when the receiving institution is back online.

RTP.Limits.Utilization.Changed

This webhook fires when the percentage of successful transfers hits 5%, and fires again every time the transfer interval goes up 5% (at 5%, 10%, 15% and so on).

Wire events

Event Name

Description

Wire.Payment.Accepted

Wire payment was approved via the API. This can happen because authorization or dual authorization is required.

Wire.Payment.Canceled

Outbound wire was canceled at the partner's request

Wire.Payment.Rejected

Outbound wire could not be processed due to compliance reasons or was rejected by the Federal Reserve

Wire.Payment.Processed

Outbound wire has been transmitted to the Federal Reserve. Still possible the wire could be rejected

Wire.Payment.Sent

Outbound wire has been transmitted to the Federal Reserve and has been successfully acknowledged. IMAD number is now available.

Wire.Payment.Received

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 Operations team. Commonly this is used to indicate additional documentation or action is needed by the partner.

International Payments events

Event Name

Description

International.Hold.Cleared

Hold on payment cleared. Funds sent.

International.Hold.Escalated

Payment on hold and status escalated. Additional actions needed.

International.Payment.Sent

Funds sent via a wire payment to the receiver bank

International.Payment.Canceled

Payment canceled at partner request

International.Payment.Returned

Payment rejected by the receiving bank

XPay events

Event Name

Description

XPay.Payment.Received

Inbound pull payment request has been received and is awaiting approval

XPay.Payment.Canceled

Payment canceled at the sender's request or 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, most commonly due to insufficient funds

XPay.Payment.Completed

Payment has been posted to both the sender's and receiver's accounts

Card issuing events

Event Name

Description

Cards.Card.Activated

Debit card activated

Cards.Card.Closed

Debit card closed

Cards.Card.Created

Debit card created

Cards.Card.Failed

Debit card creation failed

Cards.Card.Pin.Set

PIN set for debit card

Cards.Card.Profile.Changed

Profiled of cardholder changed

Cards.Card.Replaced

New card created to replace an existing card

Cards.Card.Suspended

Debit card use temporarily suspended

Cards.Card.Unsuspended

Suspension removed from debit card

Cards.Transaction.Cleared

Card transaction successfully completed

Cards.Transaction.Authorized

Card transaction approved

Cards.Transaction.Declined

Card transaction not approved

Cards.Transaction.Failed

Card transaction did not succeed

Cards.Transaction.Reversed

Payment credited to the originating account

Cards.Card.Status.Changed

Card state has changed

Checks events

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

Outbound check could not be processed due to compliance reasons or was rejected by the Federal Reserve

Check.Return.Received

A previously deposited check has been returned by the receiving bank

Check.Details.Changed

Details of a check have been changed

Check.Hold.Escalated

A hold relating to either an inbound or outbound check was marked for escalation by a member of the Operations team. Commonly this is used to indicate additional documentation or action is needed by the partner.

Check.Policy.Changed

A check's Reg CC Policy has been updated

Check.PositivePay.Created

A check has been authorized for Positive Pay

Check.PositivePay.Revoked

A check's Positive Pay status has been revoked

Check.Payment.Unauthorized

A check drawn on an account in COS has been presented but was not authorized for Positive Pay



🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.