Webhooks

Webhook Event Catalog

Bank Account Management Webhooks

Bank Account Management Webhooks report activity related to user-owned bank accounts, including any external account linking.

Event NameDescription
Consumer.BankAccount.CreatedSent once a new bank account is associated/added to their profile.
Consumer.BankAccount.DeletedSent once a new bank account is removed from their profile.

Consumer Webhooks

The Consumer webhooks provide notifications about updates to consumers in your Upward Tennant.

Event NameDescription
Consumer.CreatedSent once a consumer is created.
Consumer.UpdatedSent any time a consumer object is updated.
Consumer.ClosedSent when a consumer account is closed.

Consumer KYC Webhooks

The Consumer KYC Webhooks provide notifications about the status of their KYC session

Event NameDescription
Consumer.KYC.ApprovedSent once a Consumer is fully KYC approved
Consumer.KYC.CompletedSent once a Consumer has completed filling out data in an interactive KYC session
Consumer.KYC.FailedSent when a Consumer fails KYC
Consumer.KYC.NeedsReviewSent if a Consumer’s KYC data needs further review
Consumer.KYC.PendingSent once a Consumer’s KYC session is Pending
Consumer.KYC.StartedSent once a Consumer has begun the KYC process

Consumer Underwriting Webhooks

The Consumer Underwriting Webhooks provide notifications about their pre-loan underwriting

Event NameDescription
Consumer.Underwriting.ApprovedSent once a Consumer’s Underwriting is approved
Consumer.Underwriting.FailedSent when a Consumer has failed Underwriting

Credit Line Webhooks

The Credit-Line webhooks provide notifications about updates to consumers’ credit lines.

Event NameDescription
CreditLine.CreatedSent once a new Credit Line is created
CreditLine.UpdatedSent once a Credit Line is updated
CreditLine.ClosedSent once a Credit Line has been closed

Credit Line Transaction Webhooks

Event NameDescription
CreditLine.Transaction.CreatedSent once a new transaction is created
CreditLine.Transaction.ClearedSent once a transaction is cleared
CreditLine.Transaction.ClosedSent once a transaction has been closed
CreditLine.Transaction.CanceledSent once a transaction has been canceled

Payment Webhooks

Payment webhooks are broken down into the following categories:

  • ACH Payments
  • AFT / OCT Payments
  • Book Transfers
  • Instant Payments
  • P2P Payments

ACH Payment Webhooks

ACH Webhooks report updates during the lifecycle of an ACH Request.

Event NameDescription
Payment.ACH.CreatedSent once an ACH Payment is created.
Payment.ACH.CompletedSent when an ACH Payment is completed and funds have settled.
Payment.ACH.FailedSent when an ACH Payment fails - usually due to insufficient balance or incorrect sender/receiver data.
Payment.ACH.CanceledSent when an ACH Payment is canceled - usually via API or support action.
Payment.Ach.ReceivedSend when an ACH Payment is received

AFT / OCT Payment Webhooks

AFT (incoming) Payment Webhooks report updates during the lifecycle of an card payment Request.

Event NameDescription
Payment.Aft.CreatedSent once an AFT Payment is created.
Payment.Aft.SentSent once an AFT Payment is sent to the network.
Payment.Aft.CompletedSent once an AFT Payment has been completed.
Payment.Aft.FailedSent once an AFT Payment fails.
Payment.Aft.CanceledSent once an AFT Payment is canceled.

OCT (outbound) Payment Webhooks report updates during the lifecycle of an card payment Request.

Event NameDescription
Payment.Oct.CreatedSent once an OCT Payment is created.
Payment.Oct.SentSent once an OCT Payment is sent to the network.
Payment.Oct.CompletedSent once an OCT Payment has been completed.
Payment.Oct.FailedSent once an OCT Payment fails.
Payment.Oct.CanceledSent once an OCT Payment is canceled.

Instant Payment Webhooks

Instant Payment Webhooks report updates during the lifecycle of an Instant Payment Request.

Event NameDescription
Payment.Instant.CreatedSent once an Instant Payment is created.
Payment.Instant.SentSent once an Instant Payment is completed and funds have settled. Payment.Instant.Completed webhook can be used interchangeable with Payment.Instant.Sent
Payment.Instant.CompletedSent when an Instant Payment is completed and funds have settled.
Payment.Instant.FailedSent when an Instant Payment fails - usually due to insufficient balance or incorrect sender/receiver data.
Payment.Instant.CanceledSent when an Instant Payment is canceled - usually via API or support action.

P2P Payment Webhooks

P2P Payment Webhooks report updates during the lifecycle of a peer-to-peer transfer between two consumers on your partner network.

Event NameDescription
Payment.P2P.CreatedSent once a P2P payment is submitted and in process. Not sent for payments in pending_review status.
Payment.P2P.CompletedSent when a P2P payment is completed and funds have settled.
Payment.P2P.FailedSent when a P2P payment fails — usually due to a core banking error.
Payment.P2P.CanceledSent when a P2P payment is canceled.

Book Transfer Webhooks

Book Transfer Webhooks report updates during the lifecycle of a Book Transfer Request.

Event NameDescription
Payment.Transfer.CreatedSent once an Instant Payment is created.
Payment.Transfer.CompletedSent when an Instant Payment is completed and funds have settled.
Payment.Transfer.FailedSent when an Instant Payment fails - usually due to insufficient balance or incorrect sender/receiver data.
Payment.Transfer.CanceledSent when an Instant Payment is canceled - usually via API or support action.

Payment Card Webhooks

Payment Card Webhooks report updates during the lifecycle of a Consumer’s Payment Card.

Event NameDescription
PaymentCard.CreatedSent once a Payment Card is created.
PaymentCard.UpdatedSent once a Payment Card is updated.
PaymentCard.ClosedSent once a Payment Card is closed.
PaymentCard.FrozenSent once a Payment Card is frozen.
PaymentCard.UnfrozenSent once a Payment Card is unfrozen.
PaymentCard.ReplacedSent once a Payment Card is replaced.
PaymentCard.LostSent once a Payment Card is marked as lost.
PaymentCard.StolenSent once a Payment Card is marked as stolen.
PaymentCard.PinResetSent once a Payment Card’s PIN has been reset.

Payment Card Transaction Webhooks

Payment Card Transaction Webhooks report information about transactions

Event NameDescription
PaymentCard.Transaction.AuthSent once a Payment Card Transaction is authorized.
PaymentCard.Transaction.AuthExpiredSent if a Payment Card Transaction’s is authorization expires.
PaymentCard.Transaction.SettlementSent once a Payment Card Transaction has settled.
PaymentCard.Transaction.ArchivedSent once a Payment Card Transaction is Archived.
PaymentCard.Transaction.AdjustmentSent once a Payment Card Transaction data has been adjusted.
PaymentCard.atm.loadSent once funds have been loaded via an ATM deposit.