Events

With our Webhook event notifications, you can streamline your operations by automatically receiving updates for important actions within the platform. Below is a list of the available events, along with their descriptions, to help you configure your webhook and stay on top of critical activities in real-time.

Example Payloads

Virtual Account Add Event (USD)

{
  "event": "virtual_account.add",
  "timestamp": "2024-11-25T17:45:57.120628Z",
  "data": {
    "eventId": "evnt_6744b7d54341b743eeea6ac9",
    "object": "virtual_account",
    "virtual_account": {
      "id": "6744b7d44341b743eeea6ac8",
      "walletId": "6744b7164341b743eeea6ac0",
      "customerId": "6743b58c5a7a39553b4915d2",
      "accountNumber": "900489121292",
      "accountName": "",
      "bankName": "Bank of Nowhere",
      "bankCode": null,
      "routingNumber": "101019644",
      "bankAddress": "1800 North Pole St., Orlando, FL 32801",
      "currency": "USD",
      "countryIsoCode": "US",
      "walletAddress": "GCMTQIUY5HMFWEUB4Y52N2UW4SZEAJHTF5AZGCJH3MJX5XOSGFOLI7BZ",
      "chain": "stellar"
    }
  },
  "signature": "13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09"
}

Virtual Account Add Event (NGN)

{
  "event": "virtual_account.add",
  "timestamp": "2024-11-25T17:45:57.120628Z",
  "data": {
    "eventId": "evnt_6744b7d54341b743eeea6ac9",
    "object": "virtual_account",
    "virtual_account": {
       "id": "647d75a3432102345678",
       "walletId": "wallet_12345",
       "customerId": "customer_98765",
       "accountNumber": "0123456789",
       "accountName": "John Doe",
       "bankName": "First Bank of Nigeria",
       "bankCode": "023",
       "currency": "NGN",
       "countryIsoCode": "NG"
   }
  },
  "signature": "13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09"
}

Webhook Event Fields for Virtual Account Add

Field	Description	Type	Example
event	The type of event that occurred.	string	"virtual_account.add"
timestamp	The time when the event was triggered.	string (ISO 8601)	"2024-11-25T17:45:57.120628Z"
data.eventId	Unique identifier for the event.	string	"evnt_6744b7d54341b743eeea6ac9"
data.object	The type of object related to the event.	string	"virtual_account"
data.virtual_account.id	Unique identifier for the virtual account.	string	"6744b7d44341b743eeea6ac8"
data.virtual_account.walletId	Identifier for the associated wallet.	string	"6744b7164341b743eeea6ac0"
data.virtual_account.customerId	Identifier for the customer owning the virtual account.	string	"6743b58c5a7a39553b4915d2" (USD)
"customer_98765" (NGN)
data.virtual_account.accountNumber	The virtual account number.	string	"900489121292" (USD)
"0123456789" (NGN)
data.virtual_account.accountName	Name associated with the virtual account.	string	"" (USD)
"John Doe" (NGN)
data.virtual_account.bankName	Name of the bank associated with the virtual account.	string	"Bank of Nowhere" (USD)
"First Bank of Nigeria" (NGN)
data.virtual_account.bankCode	Code identifying the bank.	string or null	null (USD)
"023" (NGN)
data.virtual_account.routingNumber	Routing number for the bank (specific to certain countries).	string	"101019644" (USD)
N/A (NGN)
data.virtual_account.bankAddress	Address of the bank.	string	"1800 North Pole St., Orlando, FL 32801" (USD)
N/A (NGN)
data.virtual_account.currency	Currency used in the virtual account.	string (ISO 4217)	"USD" (USD)
"NGN" (NGN)
data.virtual_account.countryIsoCode	ISO code for the country.	string (ISO 3166-1 alpha-2)	"US" (USD)
"NG" (NGN)
data.virtual_account.walletAddress	Address associated with the wallet.	string	"GCMTQIUY5HMFWEUB4Y52N2UW4SZEAJHTF5AZGCJH3MJX5XOSGFOLI7BZ" (USD)
N/A (NGN)
data.virtual_account.chain	Blockchain or network the wallet belongs to.	string	"stellar" (USD)
N/A (NGN)
signature	Cryptographic signature for verifying the integrity of the event.	string (hexadecimal hash)	"13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09"