Below is a list of event types we currently send through webhooks. We are planning to add more event types in the near future.
IDV webhooks
Flow | Event |
---|
The IDV of the end-user has been approved | BaaSPersonIdv.Approved |
The IDV of the end-user has been declined | BaaSPersonIdv.Declined |
Application webhooks
Flow | event |
---|
Informs that application is in compliance review | BaasApplication.ComplianceReview |
Informs that application was approved and IBAN is issued, and other APIs can be initiated with provided baasClientID | BaasApplication.ApplicationApproved |
Informs that application was declined | BaasApplication.ApplicationDeclined |
Payment webhooks
Flow | Event |
---|
Outgoing payment status change notification | OutgoingPayment.Created |
Outgoing payment status change notification | OutgoingPayment.Processing |
Outgoing payment status change notification | OutgoingPayment.Completed |
Outgoing payment status change notification | OutgoingPayment.Rejected |
Settled incoming payment notification | IncomingPayment.Completed |
Payload samples for payment webhooks can be found in Payment webhooks API Reference.
Account webhooks
Flow | Event |
---|
Account balance change notification (both, credit and debit transactions trigger this notification) | Account.BalanceChanged |
Payload samples for account webhooks can be found in Accounts webhooks API Reference.
Card application webhooks
Flow | Event |
---|
Card application is created. ConnectPay reviews applications and notifies customer about decision. | BaaSCardApplication.Approved |
Card application is created. ConnectPay reviews applications and notifies customer about decision. | BaaSCardApplication.Declined |
Payload samples for card application webhooks can be found in Card application webhooks API Reference.
Card payment webhooks
Flow | Event |
---|
Triggered when successful card authorisation is made | BaaSCard.HoldAdded |
Triggered when authorisation is modified. Popular use case: Automatic fuel dispenser | BaaSCard.HoldModified |
Triggered when card authorisation is removed | BaaSCard.HoldDeleted |
Triggered when card receives a refund | BaaSCard.Refunded |
Card status webhooks
Flow | Event |
---|
Card application is approved and card is created in system | BaaSCard.Created |
Card ordered in personalisation centre | BaaSCard.Ordered |
Card personalized in personalisation centre | BaaSCard.Personalized |
Card dispatched by personalisation centre | BaaSCard.Dispatched |
Card is activated | BaaSCard.Activated |
Card blocked | BaaSCard.Blocked |
Card expired | BaaSCard.Expired |
Card awaiting renewal. 30 days left till card expiration | BaaSCard.AwaitingRenewal |
Card can’t be closed as the are pending authorisations. Card will received “closed” status after authorisations are cleared. | BaaSCard.Closing |
Card closed | BaaSCard.Closed |
Account status webhooks
Flow | Event |
---|
Triggered when IBAN is blocked for Debit | BaaSAccount.DebitBlocked |
Triggered when IBAN is blocked for Credit | BaaSAccount.CreditBlocked |
Triggered when IBAN is blocked for Debit and Credit | BaaSAccount.DebitAndCreditBlocked |
Triggered when IBAN is unblocked | BaaSAccount.Unblocked |
Triggered when IBAN is closed | BaaSAccount.Closed |
Merchant payment status webhooks (available only for Banking as a Service customers)
Flow | Event |
---|
Payment initiation request received from Merchant. | MerchantPayment.Initiated |
Payment initiation request sent to Provider. | MerchantPayment.Processing |
Redirect received from Provider OR Payment status update received from provider, however payment status is not terminal. | MerchantPayment.PendingProvider |
Payment approved. | MerchantPayment.Approved |
Funds has been received in Merchant Account. | MerchantPayment.Settled |
Payment failed. | MerchantPayment.Failed |
Payment canceled or abandoned at Provider OR Session expires OR Consumer cancels payment before initiating it. | MerchantPayment.Abandoned |
Payment was refunded. | MerchantPayment.Refunded |
Partial amount of a payment was refunded. | MerchantPayment.PartiallyRefunded |
Payload samples for merchant payment status webhooks can be found in Merchant payment status webhooks API Reference.
Authorize to receive webhooks
Subscribe to receive webhooks
General webhooks usage rules