Webhooks

Learn how to listen for deposits that land in your virtual accounts.

Money arriving in a virtual account is not something you initiate, so there is no response to read it from. Register a webhook endpoint and Bitnob delivers virtual_account.deposit.success as soon as a transfer lands. Return a 200 OK from your endpoint to acknowledge delivery.

To test, use Simulate Deposit in sandbox instead of waiting on a real transfer.

Try It Out

Deposit Success

Use Case

Fired when a transfer into one of your virtual accounts is confirmed. Use it to mark an order paid, release goods, or credit a customer in your own ledger.

Payload Fields

eventTypestring

Always 'virtual_account.deposit.success' for this event. Route on this value.

eventIdUUID

Unique per delivery. Use it as an idempotency key so a redelivered event is not credited twice.

payload.amountstring

Amount deposited, in naira as a string. '5000000' is ₦50,000.00.

payload.currencystring

Currency of the deposit. NGN for Nigerian virtual accounts.

payload.virtual_account_idUUID

The account the money landed in. Use it to attribute the deposit to one of your customers. The funds credit your business NGN balance, not a per-customer balance.

payload.ledger_transaction_idUUID

Identifier of the resulting ledger entry. Matches the transaction returned by Get Account Transactions.

payload.provider_transaction_idUUID

Identifier from the upstream bank partner. Quote it when raising a query about a specific transfer.

payload.referencestring

Server-generated reference for the deposit (e.g. 'DEP_fce659bd60fe7b7').

virtual_account.deposit.success