Listening for Wallet Creation Webhooks

A wallet creation webhook provides real-time notifications to your system when a new wallet is successfully created, enabling seamless integration and automated updates.

Webhook Types

In the wallet (currently applicable only to customer wallets) creation workflow you should expect to receive the following webhooks:

EventDescription
bvnk:ledger:wallet:createThe wallet creation request has transitioned to a new state.

Data Types

Field

Description

event

The type of event triggering the webhook.

eventId

A unique identifier for the event.

timestamp

The timestamp of when the event occurred.

data.status

The status of the wallet creation request.

Possible values:

  • PROCESSING
  • REJECTED
  • COMPLETED

data.id

A unique identifier of the wallet.

data.walletName

The name of the wallet.

data.currencyCode

The currency code of the wallet.

data.accountReference

A unique reference of the account that owns the wallet.

data.customerReference

A unique reference of the customer that owns the wallet (optional).

data.ledgers

Contains information about the ledger.

data.ledgers[0].type

The type of ledger.

Possible values:

  • FIAT
  • CRYPTO

data.ledgers[0].code

The code for the bank ledger is issued by.

Will be provided only if ledgers.type = FIAT.

data.ledgers[0].accountNumber

The bank account number.

Will be provided only if ledgers.type = FIAT.

data.ledgers[0].accountNumberFormat

The format of the account number.

Will be provided only if ledgers.type = FIAT.

Possible values:

  • IBAN
  • SCAN
  • SWIFT
  • ABA
  • BBAN
  • CUBIX

Webhook Examples

For example:

{
   "event": "bvnk:ledger:wallet:create",
   "eventId": "0193da1c-a95f-7f7d-a524-f1a3654bec86",
   "timestamp": "2024-12-18T14:12:11.743368759Z",
      "data": {
         "id": "a:24121851098381:mohEmnT:1",
         "status": "COMPLETED",
         "ledgers": [
            {
               "code": "LHVBEE20",
               "type": "FIAT",
               "accountNumber": "EE047777000028534345",
               "accountNumberFormat": "IBAN"
            }
         ],
         "walletName": "Finance Wallet",
         "currencyCode": "EUR",
         "accountReference": "3399c975-e1c1-4acf-9a90-6cfbdcdeaaea",
         "customerReference": "f62a5da6-f727-4a6b-bb51-78003545b7ee"
      }
}