Overview
Webhooks help customers receive real-time updates on API activity, including the creation and updates of persons, cards, and transactions.
Leveraging Webhooks
As activities occur within a program, Qolo sends a request containing event information to a hosted endpoint configured in Qolo's system. The client's hosted endpoint must be active in order to process the webhook events sent to it.
Webhooks are useful for:
- Monitoring transaction patterns
- Maintaining transaction records, as well as tracking KYB/KYC and card status
- Staying informed about all program activities
Event types
Event | Description |
---|---|
card | Subscribe to receive updates on all card-related events, including PIN changes, fulfillment, status updates, and replacements. |
person.created | Subscribe to receive updates when a person's record is created in the Qolos system. |
person.verification.success | Subscribe to receive a webhook notification when a person passes KYC validation. |
person.updated | Subscribe to receive a webhook notification when changes occur to a person's record. |
wallet.created | Subscribe to receive a webhook notification when a wallet is created. |
account.created | Subscribe to receive a webhook notification when an account is created. |
account.activated | Subscribe to receive a webhook notification when an account is activated. |
account.closed | Subscribe to receive a webhook notification when an account is closed. |
account.status | Subscribe to receive a webhook notification when an account status is updated. |
account.instrument.created | Subscribe to receive a webhook notification when an account instrument is created. |
outside.instrument.created | Subscribe to receive a webhook notification when an external instrument is created. |
outside.instrument.updated | Subscribe to receive a webhook notification when an external instrument is updated |
auth.approved | Subscribe to receive a webhook notification when a card transaction is successful. |
auth.reversed | Subscribe to receive a webhook notification when a card transaction is reversed. |
auth.declined | Subscribe to receive a webhook notification when a card transaction is declined. |
bankeft.credit.received | Subscribe to receive a webhook notification when an ACH credit transaction is successfully credited to an account. |
bankeft.credit.reversed | Subscribe to receive a webhook notification when an ACH credit transaction is reversed. |
bankeft.credit.returned | Subscribe to receive a webhook notification when an ACH credit transaction is returned. |
bankeft.debit.received | Subscribe to receive a webhook notification when an ACH debit transaction is successfully processed from an account. |
bankeft.debit.reversed | Subscribe to receive a webhook notification when an ACH debit transaction is reversed. |
bankeft.debit.returned | Subscribe to receive a webhook notification when an ACH debit transaction is returned. |
transfer.success | Subscribe to receive a webhook notification when an internal transfer is successfully completed. |
check.cleared | Subscribe to receive a webhook notification when a check is successfully cleared. |
payment.success | Subscribe to receive a webhook notification when a scheduled payment is successfully processed. |
payment.failure | Subscribe to receive a webhook notification when a scheduled payment fails to process. |
company.created | Subscribe to receive updates when a company record is created in the Qolos system. |
company.updated | Subscribe to receive updates when a company record is updated in the Qolos system. |
Updated 13 days ago