Ctrl K
Webhooks
Webhooks notify of events in real-time. Configure your webhook URL in your dashboard.
Events
Select an event to see a sample payload.
create-wallet.successWallet created.
Sample payload
(JSON)
{ "eventId": "01M3H7K3R9NBXV8QD3TZ7WYKM6", "customer_id": "01M3H7K2QXVB9NDTZ4R6PWGMSE", "eventType": "create-wallet.success", "eventCategory": "create_wallet", "eventData": { "wallet_id": "01M3H7K3R5QBXN9VD2TZ6WYKMS", "name": "Acme Technologies Limited API", "customer_id": "01M3H7K2QXVB9NDTZ4R6PWGMSE", "currency": "NGN", "identifier": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "tag": "api", "email": null, "phone": null, "wallet_meta": "" }, "pvb_wallet": "01M3H7K3R2N8VBXD5TZQ7WYKMP"}bank-transfer.inflow.successInflow success.
Sample payload
(JSON)
{ "eventId": "01M3H7K4S2NXVBQ9D7TZ3WYKM5", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "eventType": "bank-transfer.inflow.success", "eventCategory": "inflow_transaction", "eventData": { "id": "3f1c9a20-7d4e-4b85-9c13-6a2f8e0d5b71", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "destination_wallet_id": "01M3H7K3R9NBXV8QD3TZ7WYKM6", "type": "inter", "category": "bank_transfer_inflow", "amount": 100000, "currency": "NGN", "narration": "Transfer from ADA OKONKWO", "ip_address": "198.51.100.24", "transaction_id": "b94d7e02-1c58-4a33-9f61-7d2e4b8c05af", "timestamp": "2026-09-28T22:14:59.308Z", "internal_reference": "01M3H7K4S4QVBXN7D9TZ5WYKM3", "status": "COMPLETED", "provider": "nibss", "third_party_reference": "000000260928221450000000000001", "initiator_reference": "000000260928221450000000000001", "lock_funds_id": null, "recipient_name": null, "recipient_bank_account_number": "9900000034", "recipient_bank_account_name": "ACME TECHNOLOGIES LIMITED/ADA OKONKWO", "sender_bank_account_number": "9900000056", "sender_bank_name": "SAMPLE BANK", "sender_name": "ADA OKONKWO", "webhook_data": null, "fee": 0, "provider_fee": null, "pay_withholding_tax": false, "withholding_tax_type": null, "withholding_tax_destination": null, "withholding_tax_paid": false, "is_withholding_tax": false, "restriction_data": null, "batch_id": null, "execution_mode": null, "batch_number": null, "reason": null, "last_retry_attempt": null, "accrued_interest_wallet": null, "destination_wallet_balance": 100000, "destination_wallet_ledger_balance": 100000, "destination_transaction_balance": 100000, "reference": "01M3H7K4S4QVBXN7D9TZ5WYKM3", "session_id": "000000260928221450000000000001" }, "pvb_reference": "PVB01M3H7K4S6XBVQN3D5TZ7WYKM9", "pvb_wallet": "01M3H7K3RBQXVN5BD9TZ2WYKM4", "pvb_destination_wallet": null, "pvb_third_party_reference": null, "pvb_schedule_payment_id": null, "pvb_destination_account_creation_reference": null}bank-transfer.outflow.successOutflow success.
Sample payload
(JSON)
{ "eventId": "01M3H7K5T8XVBQN5D6TZ4WYKM2", "customer_id": "7a3e1f90-4c82-4d16-b5e7-2f9a08c3d641", "eventType": "bank-transfer.outflow.success", "eventCategory": "bank_transfer_outflow", "eventData": { "id": "a142e8b7-3f05-4c69-8b2d-9e60a3f71c48", "customer_id": "7a3e1f90-4c82-4d16-b5e7-2f9a08c3d641", "source_wallet_id": "01M3H7K4S2NXVBQ9D7TZ3WYKM5", "type": "inter", "category": "bank_transfer_outflow", "amount": 1500000, "currency": "NGN", "narration": "Payout", "ip_address": "198.51.100.24", "transaction_id": "f903b1d8-27e4-4a65-9c81-0b5d6e3a729f", "timestamp": "2026-09-28T22:50:43.481Z", "session_id": "000000260928235046000000000002", "internal_reference": "01M3H7K6V2QBXVN7D3TZ9WYKM5", "status": "COMPLETED", "provider": "pocket", "third_party_reference": "PVB01M3H7K6V4XQBVN9D5TZ3WYKM7", "initiator_reference": "PVB01M3H7K6V4XQBVN9D5TZ3WYKM7", "lock_funds_id": null, "response_code": null, "response_message": null, "recipient_name": null, "recipient_bank_code": "999999", "recipient_bank_name": null, "recipient_bank_account_number": "9900000056", "recipient_bank_account_name": null, "webhook_data": null, "fee": 7500, "provider_fee": null, "pay_withholding_tax": false, "withholding_tax_type": null, "withholding_tax_destination": null, "withholding_tax_paid": false, "is_withholding_tax": false, "restriction_data": null, "batch_id": null, "execution_mode": null, "batch_number": null, "reason": null, "last_retry_attempt": null, "accrued_interest_wallet": null, "source_wallet_balance": 500000, "source_wallet_ledger_balance": 500000, "source_transaction_balance": 500000, "reference": "01M3H7K6V2QBXVN7D3TZ9WYKM5" }, "pvb_reference": "PVB01M3H7K6V4XQBVN9D5TZ3WYKM7", "pvb_wallet": "01M3H7K4S4QVBXN7D9TZ5WYKM3", "pvb_destination_wallet": null, "pvb_third_party_reference": null, "pvb_schedule_payment_id": null}wallet-transfer.outflow.successWallet transfer success.
Sample payload
(JSON)
{ "eventId": "01M3H7K4S8NVXBQ5D3TZ9WYKM7", "customer_id": "7a3e1f90-4c82-4d16-b5e7-2f9a08c3d641", "eventType": "wallet-transfer.outflow.success", "eventCategory": "wallet_transfer", "eventData": { "id": "c57a2e91-6b04-4f28-8d35-1e9c7a0f46b3", "customer_id": "7a3e1f90-4c82-4d16-b5e7-2f9a08c3d641", "source_wallet": "01M3H7K3R9NBXV8QD3TZ7WYKM6", "destination_wallet": "6e5a0c38-bb88-11f1-a539-42010a9c0026", "type": "inter", "category": "p2p", "amount": 50000, "currency": "NGN", "narration": "P2P to Ada Okonkwo", "ip_address": "198.51.100.24", "transaction_id": "d06f3b47-82ac-4e51-b739-5c84f1e20a96", "timestamp": "2026-09-28T22:29:05.812Z", "internal_reference": "01M3H7K5T2QXBVN9D4TZ6WYKM8", "status": "COMPLETED", "third_party_reference": "PVB01M3H7K5T4BXQVN7D2TZ8WYKM6", "initiator_reference": "PVB01M3H7K5T4BXQVN7D2TZ8WYKM6", "source_wallet_balance": 50000, "source_wallet_ledger_balance": 50000, "destination_wallet_balance": 150000, "destination_wallet_ledger_balance": 150000, "source_transaction_balance": 50000, "destination_transaction_balance": 150000, "reference": "01M3H7K5T2QXBVN9D4TZ6WYKM8", "fee": null, "reason": null, "batch_id": null, "withholding_tax_type": null, "accrued_interest_wallet": null }, "pvb_reference": "PVB01M3H7K5T6VQXBN3D8TZ2WYKM4", "pvb_wallet": "01M3H7K3RBQXVN5BD9TZ2WYKM4", "pvb_destination_wallet": "01M3H7K3RDXVBQ7ND5TZ9WYKM8", "pvb_third_party_reference": "e8213c65-4d79-4a0b-9e52-3f7b1d8c604a", "pvb_schedule_payment_id": null}bank-transfer.outflow.failedOutflow failure.
Sample payload
(JSON)
{ "eventId": "01M4FAIL0UTFL0WEXAMPLE0001", "customer_id": "7a3e1f90-4c82-4d16-b5e7-2f9a08c3d641", "eventType": "bank-transfer.outflow.failed", "eventCategory": "outflow_transaction", "eventData": { "id": "01M4FAILTXNEXAMPLE000000001", "customer_id": "7a3e1f90-4c82-4d16-b5e7-2f9a08c3d641", "source_wallet_id": "01M3H7K4S2NXVBQ9D7TZ3WYKM5", "destination_wallet_id": "00000000-0000-0000-0000-000000000000", "type": "outflow", "category": "bank_transfer_outflow", "amount": 5000000, "currency": "NGN", "narration": "Payout", "ip_address": "198.51.100.24", "transaction_id": "01M4FAILTXNEXAMPLE000000001", "timestamp": "2026-10-21T11:05:00.000Z", "status": "failed", "third_party_reference": "WT-00000-DR-0000000000000-EXAMPLE", "initiator_reference": "PVB01M4FAIL0UTFL0WEXAMPLE01", "response_code": null, "response_message": null, "recipient_bank_code": "999999", "recipient_bank_name": "SAMPLE BANK", "recipient_bank_account_name": "ADA OKONKWO", "recipient_bank_account_number": "9900000056", "session_id": "000000261021110500000000000003", "internal_reference": "01M4FAILREFEXAMPLE000000001", "created_at": "2026-10-21T11:04:40.000Z", "updated_at": "2026-10-21T11:05:00.000Z", "source_wallet_balance": 2000000, "source_wallet_ledger_balance": 2000000, "source_transaction_balance": 2000000, "destination_wallet_balance": 0, "destination_wallet_ledger_balance": 0, "reference": "01M4FAILREFEXAMPLE000000001", "provider": "nibss", "reason": "Beneficiary account name mismatch", "fee": 5000 }, "pvb_reference": "PVB01M4FAIL0UTFL0WEXAMPLE01", "pvb_wallet": "01M3H7K4S4QVBXN7D9TZ5WYKM3", "pvb_destination_wallet": null, "pvb_third_party_reference": "WT-00000-DR-0000000000000-EXAMPLE", "pvb_schedule_payment_id": null}reserve_virtual_account.successVirtual account created.
Sample payload
(JSON)
{ "eventId": "01M3H7K3RBQXVN5BD9TZ2WYKM4", "customer_id": "01M3H7K2QXVB9NDTZ4R6PWGMSE", "eventType": "reserve_virtual_account.success", "eventCategory": "reserve_account", "eventData": { "wallet_id": "01M3H7K3R5QBXN9VD2TZ6WYKMS", "account_type": "Savings", "account_number": "9900000012", "account_name": "Acme Technologies Limited/Acme Technologies Limited API", "provider_reference": "01M3H7K3RDXVBQ7ND5TZ9WYKM8", "bank_name": "POCKET", "status": "Active", "identifier": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "isPaypoint": false, "paypoint": {} }, "pvb_wallet": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "pvb_paypoint": null, "pvb_reference": "01M3H7K3RDXVBQ7ND5TZ9WYKM8"}interest-accrued.successInterest accrued.
Sample payload
(JSON)
{ "eventId": "01M3H7K2QXVB9NDTZ4R6PWGMSE", "customer_id": "01M3H7K2QXVB9NDTZ4R6PWGMSE", "eventType": "interest-accrued.success", "eventCategory": "interest_accrued", "eventData": { "id": "01M3H7K3R7VBXQ9ND4TZ5WYKM2", "wallet_id": "8c41d2a6-bb52-11f1-a539-42010a9c0026", "balance": 2500000, "percentage": 3, "interest_date": "2026-09-01T00:00:00.000Z", "amount": 2055, "interest_type": "differential", "differential_wallet_id": "01M3H7K3R5QBXN9VD2TZ6WYKMS" }, "pvb_wallet": "01M3H7K2QYP4BXRD9TZN6WVKM3", "pvb_wallet_name": "Acme Technologies Limited Savings", "pvb_split_interest_with_wallet": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "pvb_split_interest_with_wallet_name": "Acme Technologies Limited API"}interest-payout.successInterest payout.
Sample payload
(JSON)
{ "eventId": "01M3H7K6V6BVXQN5D7TZ9WYKM3", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "eventType": "interest-payout.success", "eventCategory": "interest_payout", "eventData": { "id": "27b4c6a0-5e18-4d72-9a36-8c01f5b7e943", "amount": 733, "destination_wallet": "6e5a0c38-bb88-11f1-a539-42010a9c0026", "destination_wallet_balance": 1650814, "destination_wallet_ledger_balance": 1650814, "destination_transaction_balance": 1650814, "reference": "01M3H7K6V8VXBQN3D9TZ5WYKM7", "timestamp": "2026-10-01T00:08:58.626Z", "batch_id": "01M3H7K6V8VXBQN3D9TZ5WYKM7", "break_down": { "gross_interest_payout": 814, "withholding_tax": 81, "net_interest_payout": 733 } }, "pvb_reference": "PVB01M3H7K6V6BVXQN5D7TZ9WYKM3", "pvb_wallet": "01M3H7K3RDXVBQ7ND5TZ9WYKM8", "pvb_accrued_interest_wallet": "01M3H7K3RDXVBQ7ND5TZ9WYKM8", "pvb_destination_wallet": null, "pvb_third_party_reference": null}restriction-created.successRestriction placed.
Freeze sample
(JSON)
{ "eventId": "01M3H7K7W2QXBVN5D3TZ9WYKM6", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "eventType": "restriction-created.success", "eventCategory": "restriction", "eventData": { "id": "01M3H7K7W4BXQVN9D5TZ3WYKM7", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "type": "Wallet", "property": "Freeze", "reason": "Freeze Restriction", "amount": 0, "wallet_id": "01M3H7K3R9NBXV8QD3TZ7WYKM6", "status": "Active", "available_balance": 345230, "ledger_balance": 345230 }, "pvb_wallet": "01M3H7K3RBQXVN5BD9TZ2WYKM4"}Lien sample
(JSON)
{ "eventId": "01M3H7K7W8XVBQN5D6TZ4WYKM3", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "eventType": "restriction-created.success", "eventCategory": "restriction", "eventData": { "id": "01M3H7K8X2QBXVN7D3TZ9WYKM4", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "type": "Wallet", "property": "Lien", "reason": "This transaction is currently in review and would be updated shortly", "amount": 1000000, "wallet_id": "6e5a0c38-bb88-11f1-a539-42010a9c0026", "status": "Active", "available_balance": 650733, "ledger_balance": 1650733 }, "pvb_wallet": "01M3H7K3RDXVBQ7ND5TZ9WYKM8"}restriction-lifted.successRestriction lifted.
Freeze sample
(JSON)
{ "eventId": "01M3H7K7W6VQXBN3D8TZ2WYKM5", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "eventType": "restriction-lifted.success", "eventCategory": "restriction", "eventData": { "id": "01M3H7K7W4BXQVN9D5TZ3WYKM7", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "type": "Wallet", "property": "Freeze", "reason": "Freeze Restriction", "transaction_reference": null, "amount": 0, "lifted_at": "2026-10-01T12:43:36.000Z", "wallet_id": "01M3H7K3R9NBXV8QD3TZ7WYKM6", "status": "Lifted", "available_balance": 345230, "ledger_balance": 345230 }, "pvb_wallet": "01M3H7K3RBQXVN5BD9TZ2WYKM4"}Lien sample
(JSON)
{ "eventId": "01M3H7K8X4XQBVN9D5TZ3WYKM2", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "eventType": "restriction-lifted.success", "eventCategory": "restriction", "eventData": { "id": "01M3H7K8X2QBXVN7D3TZ9WYKM4", "customer_id": "01M3H7K3R2N8VBXD5TZQ7WYKMP", "type": "Wallet", "property": "Lien", "reason": "This transaction is currently in review and would be updated shortly", "transaction_reference": null, "amount": 1000000, "lifted_at": "2026-10-01T12:48:11.000Z", "wallet_id": "6e5a0c38-bb88-11f1-a539-42010a9c0026", "status": "Lifted", "available_balance": 1650733, "ledger_balance": 1650733 }, "pvb_wallet": "01M3H7K3RDXVBQ7ND5TZ9WYKM8"}