Event Notifications
Stay Updated with Real-Time webhook Event Notifications
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" |
Customer Add Event
{
"event": "customer.add",
"timestamp": "2024-11-25T17:45:57.120628Z",
"data": {
"eventId": "evnt_6744b7d54341b743eeea6ac9",
"object": "customer",
"customer": {
"id": "customer_12345",
"firstName": "John",
"lastName": "Doe",
"businessName": "Amazing Products",
"email": "[email protected]",
"addressLine1": "123 Main Street",
"addressLine2": "Apt. B",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "US",
"website": "www.amazingproducts.com",
"description": "We sell high-quality gadgets",
}
},
"signature": "13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09"
}Webhook Event Fields for Customer Add
| Field | Description | Type | Example |
|---|---|---|---|
| event | The type of event that occurred. | string | "customer.add" |
| timestamp | The time when the event was triggered. | string (ISO 8601) | "2024-11-25T17:45:57.120628Z" |
| eventId | Unique identifier for the event. | string | "evnt_6744b7d54341b743eeea6ac9" |
| object | The type of object related to the event. | string | "customer" |
| data.customer.id | Unique identifier for the customer. | string | "customer_12345" |
| data.customer.firstName | First name of the customer. | string | "John" |
| data.customer.lastName | Last name of the customer. | string | "Doe" |
| data.customer.businessName | Name of the customer's business. | string | "Amazing Products" |
| data.customer.email | Email address of the customer. | string | "[email protected]" |
| data.customer.addressLine1 | Primary address line for the customer. | string | "123 Main Street" |
| data.customer.addressLine2 | Secondary address line for the customer (optional). | string | "Apt. B" |
| data.customer.city | City part of the customer's address. | string | "New York" |
| data.customer.state | State or province part of the customer's address. | string | "NY" |
| data.customer.zipcode | Zip or postal code part of the customer's address. | string | "10001" |
| data.customer.country | Country part of the customer's address. | string (ISO 3166-1 alpha-2) | "US" |
| data.customer.website | Website URL associated with the customer's business. | string | "www.amazingproducts.com" |
| data.customer.description | Description of the customer or their business. | string | "We sell high-quality gadgets" |
| data.customer.signature | Cryptographic signature for verifying the integrity of the event. | string (hexadecimal hash) | "13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09" |
Transfer Event
{
"event": "payment.transfer",
"timestamp": "2024-11-25T17:45:57.120628Z",
"data": {
"eventId": "evnt_647d75a3432102345678",
"object": "wallet",
"transactionDetails": {
"status": "success",
"amount": 1000.00,
"currency": "NGN",
"amountSent": 1000.00,
"amountSentCurrency": "NGN"
},
"recipient": {
"recipientAccountName": "John Doe",
"recipientAccountNumber": "0123456789",
"recipientBankName": "First Bank of Nigeria",
"recipientBankCode": "023",
"recipientBankAddress": "123 Main Street, Lagos",
"recipientRoutingNumber": "123456789"
},
"status": "success",
"amount": 1000.00,
"currency": "NGN"
},
"signature": "13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09"
}Webhook Event Fields for Transfer
| Field | Description | Type | Example |
|---|---|---|---|
| event | The type of event that occurred. | string | "payment.transfer" |
| timestamp | The time when the event was triggered. | string (ISO 8601) | "2024-11-25T17:45:57.120628Z" |
| eventId | Unique identifier for the event. | string | "evnt_647d75a3432102345678" |
| object | The type of object related to the event. | string | "wallet" |
| transactionDetails.status | Status of the transaction. | string | "success" |
| transactionDetails.amount | Amount transferred. | number | 1000.00 |
| transactionDetails.currency | Currency of the transferred amount. | string (ISO 4217) | "NGN" |
| transactionDetails.amountSent | Amount actually sent (may differ due to fees). | number | 1000.00 |
| transactionDetails.amountSentCurrency | Currency of the sent amount. | string (ISO 4217) | "NGN" |
| recipient.recipientAccountName | Name of the recipient's account. | string | "John Doe" |
| recipient.recipientAccountNumber | Recipient's account number. | string | "0123456789" |
| recipient.recipientBankName | Name of the recipient's bank. | string | "First Bank of Nigeria" |
| recipient.recipientBankCode | Code identifying the recipient's bank. | string | "023" |
| recipient.recipientBankAddress | Address of the recipient's bank. | string | "123 Main Street, Lagos" |
| recipient.recipientRoutingNumber | Routing number for the recipient's bank. | string | "123456789" |
| status | Overall status of the transfer. | string | "success" |
| amount | Total amount involved in the transfer. | number | 1000.00 |
| currency | Currency of the total amount. | string (ISO 4217) | "NGN" |
| signature | Cryptographic signature for verifying the integrity of the event. | string (hexadecimal hash) | "13a49b932b796da6cb4e33eafc2fa316061b4c360899d4de09c58d904e093a09" |
Updated 3 months ago