Event Types

Subscribe to specific events to receive notifications when they occur.

Available Events

Event Description
virtual_account.created A new virtual account was created
virtual_account.credited Funds were deposited into a virtual account
transfer.initiated A transfer was initiated
transfer.completed A transfer was completed successfully
transfer.failed A transfer failed
* Subscribe to all events

Virtual Account Events

virtual_account.created

Triggered when a new virtual account is created via the API.

Use cases:

  • Update your database with the new account details
  • Send a notification to your user
  • Trigger onboarding workflows

virtual_account.credited

Triggered when funds are deposited into a virtual account.

Use cases:

  • Credit your user's balance in your system
  • Send payment confirmation to your user
  • Trigger order fulfillment workflows

Transfer Events

transfer.initiated

Triggered when a transfer is initiated from a virtual account.

Use cases:

  • Log the transfer attempt
  • Update pending transaction status
  • Notify relevant stakeholders

transfer.completed

Triggered when a transfer is completed successfully.

Use cases:

  • Update transaction status to successful
  • Send confirmation to the sender
  • Update accounting records

transfer.failed

Triggered when a transfer fails.

Use cases:

  • Update transaction status to failed
  • Notify the user of the failure
  • Initiate refund or retry workflows