Payload Example (USD)
Payload Breakdown
| Field | Type | Description |
|---|---|---|
event | string | The name of the event (virtualaccount.creation.completed). |
data.id | string | Unique identifier for the virtual account resource. |
data.firstName | string | Authorized representative’s first name. |
data.lastName | string | Authorized representative’s last name. |
data.email | string | Contact email tied to the account. |
data.phoneNumber | string | Phone number stored for the customer. |
data.reference | string | The unique reference you provided during creation. |
data.accountName | string | Display name for the account (Business Name). |
data.gender | string | Gender of the representative (M or F). |
data.dateOfBirth | string | Date of birth (YYYY-MM-DD). |
data.nationality | string | 2-letter ISO country code of nationality. |
data.idType | string | Type of identification provided. |
data.idNumber | string | Masked identification number. |
data.address | string | Street address. |
data.city | string | City or Town. |
data.postalCode | string | Postal/ZIP code. |
data.account.name | string | The name on the bank account. |
data.account.bankName | string | The name of the issuing bank. |
data.account.number | string | The permanent bank account number. |
data.account.sortCode | string | The bank sort code or routing number. |
data.account.swiftCode | string | The SWIFT/BIC code (primarily for USD accounts). |
data.account.bankAddress | string | The physical address of the issuing bank branch. |
data.status | string | The current status of the account (e.g., ACTIVE). |
data.currency | string | The currency of the account (e.g., USD, NGN, MWK). |
data.country | string | 2-letter ISO country code of the account. |
data.isPermanent | boolean | Indicates if the account is permanent. |
data.company | object | Company registration details. |
data.company.registrationNumber | string | Business registration number. |
data.company.registrationCountry | string | Country where company is registered. |
data.company.registrationDate | string | Date of company registration. |
data.created | string | ISO 8601 timestamp of when the account was created. |
Handling the Webhook
When you receive this webhook:- Verify the signature – Ensure the webhook is authentic using your webhook secret.
- Match the reference – Use
data.referenceto link these account details to the specific request in your system. - Notify the user – Share the
data.account.numberand other relevant details with your customer so they can begin funding their account.
NOTE: For
virtualaccount.failed, the state will be “FAILED”.
