Reference

Registration Status

Status

Description

Active

Everything is OK.

Suspended

Something went wrong. Several attempts to send events to this registration failed. No further attempts will be made until registration is restarted.

Restarting

We are attempting to restart this registration. An event must be successfully transmitted before the status will transition back to Active.

Registration Types

Type

Description

Push

Events will be pushed to a partner endpoint. A 200 OK response is expected in order for it to be considered successful. (Default)

Poll

Events will be consumed by partner polling the events API periodically and calling acknowledge API method for each event successfully processed.

File

Events will be sent to the partner via SFTP in a CSV file once per day.

Event Status

Status

Description

Pending

Event has been created, but no attempt to send it has been made yet.

Success

Event was successfully delivered to the registered URL.

Failed

We could not deliver the event to the registered URL. See the event logs for more detail on the failure reason.

Format

Format

Description

Basic

Webhook is delivered with an array of resource identifiers related to that event.

Extended

With this format you get everything in a 'Basic' event, in addition you will receive a 'Details' array containing various meta data pertaining to each resource. For example, on the ACH.Return.Received event you would receive the Return Code and Original Payment ID.

Customer Events

Event Name

Notes

Core.Customer.Onboarded

A new customer has been onboarded.

Core.Customer.Profile.Changed

Core.Customer.Name.Changed

Core.Customer.CifNumber.Changed

Core.Customer.Address.Added

Core.Customer.Address.Changed

Core.Customer.Address.Removed

Core.Customer.Phone.Added

Core.Customer.Phone.Changed

Core.Customer.Phone.Removed

Core.Customer.Identification.Added

Core.Customer.Identification.Changed

Core.Customer.Identification.Removed

Core.Customer.Email.Added

Core.Customer.Email.Changed

Core.Customer.Email.Removed

Core.Customer.Ofac.Changed

A customer OFAC scan status has been changed.

Core.Customer.PepScan.Changed

A customer PEP scan status has been changed.

Account Events

Event Name

Notes

Core.Account.Opened

Core.Account.Status.Changed

Core.Account.Closed

Core.Account.Title.Changed

Core.Account.Settled

Core.SubAccount.Opened

Core.SubAccount.Status.Changed

Core.SubAccount.Closed

Core.SubAccount.Title.Changed

Core.Relationship.Added

Core.Relationship.Removed

Core.Restriction.Placed

Core.Restriction.Removed

Core.Fee.Assessed

Core.Fee.Waived

Core.Interest.Accrued

Core.Interest.Paid

Core.Statement.Generated

Core.StatementDocument.Attached

A document (pdf) was attached to a generated statement.

Core.StopPayment.Placed

Core.StopPayment.Removed

Core.RegDPolicy.Violated

A Regulation D policy was violated on a savings account.

Transaction Events

Event Name

Notes

Core.Transaction.Completed

Transaction completed successfully.

Core.Transaction.Rejected

Transaction was unable to complete.

Core.Activity.Posted

Account activity record has been posted as the result of a transaction.

Core.MemoPost.Created

Core.MemoPost.Changed

Core.MemoPost.Removed

Core.Hold.Placed

Core.Hold.Changed

Core.Hold.Removed

ACH Events

Event Name

Notes

Ach.Payment.Canceled

Outbound payment was canceled at the partner's request.

Ach.Payment.Rejected

Outbound payment could not be processed due to compliance reasons or failed to fund.

Ach.Payment.Sent

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

RTP Events

Event Name

Description

RTP.Payment.Sent

Outbound 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.

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.

Wire Events

Event Name

Description

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.

XPay Events

Event Name

Description

XPay.Payment.Received

Inbound 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.

Debit Card Events

Event Name

Description

DebitCard.Card.Activated

A card has been successfully activated.

DebitCard.Card.UnderReview

A card has been changed to review status.

DebitCard.Card.Closed

A card has been permanently closed.

DebitCard.Card.Created

A card has been created pending activation.

DebitCard.Card.CreateFailed

Card creation has failed.

DebitCard.Card.Ordered

A card has been ordered and will be mailed to the customer.

DebitCard.Card.PinCreated

A card PIN has been set for the first time.

DebitCard.Card.PinReset

A card PIN has been 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 temporarily suspended.

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

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.

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.Payment.Returned

A previously deposited check has been returned by the receiving bank.


Did this page help you?