Supported Events
Learn the supported events that Bloc sends via webhooks
All of our webhook events follow the same payload structure.
{
"event": "transaction.new",
"data": {}//transaction payload.
}
Supported Events
{
"event": "transaction.new",
"data": {
"id": "64107faf7f1b4b36103f8858",
"created_at": "2023-03-14T14:07:43.489Z",
"updated_at": "2023-03-14T14:07:43.489Z",
"amount": 4150,
"reference": "ref_64107faf7f1b4b36103f8856",
"status": "successful",
"shared": false,
"currency": "NGN",
"environment": "test",
"payment_method": "Television",
"provider": "000000000000000000000000",
"payment_type": "payin",
"source": "Commission",
"meta_data": null,
"organization_id": "640b045929eb9cf45bc720c9",
"customer_id": "000000000000000000000000",
"fee": 0,
"billing_id": "000000000000000000000000",
"customer_detail": {
"full_name": "",
"phone_number": "",
"country": ""
},
"reversal": false,
"previous_account_balance": 6250,
"current_account_balance": 10400,
"account_id": "640b045929eb9cf45bc720d3",
"drcr": "CR"
}
}
{
"event": "transaction.updated",
"data": {
"id": "64107faf7f1b4b36103f8858",
"created_at": "2023-03-14T14:07:43.489Z",
"updated_at": "2023-03-14T14:07:43.489Z",
"amount": 4150,
"reference": "ref_64107faf7f1b4b36103f8856",
"status": "successful",
"shared": false,
"currency": "NGN",
"environment": "test",
"payment_method": "Television",
"provider": "000000000000000000000000",
"payment_type": "payin",
"source": "Commission",
"meta_data": null,
"organization_id": "640b045929eb9cf45bc720c9",
"customer_id": "000000000000000000000000",
"fee": 0,
"billing_id": "000000000000000000000000",
"customer_detail": {
"full_name": "",
"phone_number": "",
"country": ""
},
"reversal": false,
"previous_account_balance": 6250,
"current_account_balance": 10400,
"account_id": "640b045929eb9cf45bc720d3",
"drcr": "CR"
}
}
{
"event": "account.created",
"data": {
"id": "640b316727103d5dea5d8f83",
"name": "Praise Philemon",
"bvn": "22386660326",
"kyc_tier": "1",
"created_at": "2023-03-10T13:32:23.394Z",
"updated_at": "2023-03-10T13:32:23.394Z",
"status": "Open",
"environment": "live",
"organization_id": "640795657198161a57fdcc3b",
"balance": 10000,
"available_balance": 10000,
"currency": "NGN",
"meta_data": null,
"customer_id": "64086a9b09f32fa267e02232",
"customer": {
"id": "64086a9b09f32fa267e02232",
"email": "[email protected]",
"status": "active",
"kyc_tier": "1",
"phone_number": "08180992590",
"first_name": "Praise ",
"last_name": "Philemon",
"gender": "male",
"customer_type": "Personal",
"bvn": "22386660326"
},
"account_number": "2019851519",
"bank_name": "Banc Corp",
"type": "Fixed",
"collection_account": false,
"hide_account": false,
"SkipNumber": false,
"external_account": {},
"collection_rules": {}
}
}
{
"event": "account.collection.created",
"data": {
"id": "64105e617f1b4b36103f8708",
"name": "Bloc Dashboard",
"created_at": "2023-03-14T11:45:37.925951879Z",
"account_number": "2048401671",
"bank_name": "Banc Corp"
}
}
{
"event": "wallet.created",
"data": {
"id": "645a1e0385b17f000a3052a2",
"name": "Bloc Dashboard 240",
"created_at": "2023-05-09T10:18:43.241568455Z",
"account_number": "2010451356",
"bank_name": "Banc Corp",
"balance": 0
}
}
{
"event": "customer.created",
"data": {
"id": "64105f5d7f1b4b36103f870e",
"full_name": "erati mas",
"phone_number": "09174839247",
"organization_id": "640b045929eb9cf45bc720c9",
"environment": "test",
"email": "[email protected]",
"country": "",
"group": "main",
"status": "active",
"created_at": "2023-03-14T11:49:49.839Z",
"updated_at": "2023-03-14T12:26:54.927Z",
"first_name": "mas",
"last_name": "eratti",
"kyc_tier": "0",
"bvn": "22303240817",
"date_of_birth": "0001-01-01T00:00:00Z",
"customer_type": "retail",
"source": "Banking",
"address": {}
}
}
{
"event": "customer.kyc.revalidated",
"data": {
"id": "6410612c7f1b4b36103f872a",
"full_name": "atti bug",
"phone_number": "08033225577",
"organization_id": "640b045929eb9cf45bc720c9",
"environment": "test",
"email": "[email protected]",
"country": "Nigeria",
"group": "main",
"status": "active",
"created_at": "2023-03-14T11:57:32.567Z",
"updated_at": "2023-03-15T22:44:50.289Z",
"first_name": "bug",
"last_name": "atti",
"kyc_tier": "3",
"bvn": "22403240419",
"place_of_birth": "Port Harcourt",
"gender": "Male",
"identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224450bug202315032244506410612c7f1b4b36103f872a.png",
"image_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503223849bug202315032238496410612c7f1b4b36103f872a.png",
"means_of_identity": "Drivers License",
"date_of_birth": "1992-03-30T00:00:00Z",
"means_of_identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224133bug202315032241336410612c7f1b4b36103f872a.png",
"customer_type": "Personal",
"source": "Banking",
"address": {
"street": "",
"city": "Lekki",
"state": "lagos",
"country": "Nigeria",
"postal_code": "1000101"
}
}
}
{
"event": "customer.kyc.upgraded.t1",
"data": {
"id": "6410612c7f1b4b36103f872a",
"full_name": "atti bug",
"phone_number": "08033225577",
"organization_id": "640b045929eb9cf45bc720c9",
"environment": "test",
"email": "[email protected]",
"country": "Nigeria",
"group": "main",
"status": "active",
"created_at": "2023-03-14T11:57:32.567Z",
"updated_at": "2023-03-15T22:44:50.289Z",
"first_name": "bug",
"last_name": "atti",
"kyc_tier": "1",
"bvn": "22403240419",
"place_of_birth": "Port Harcourt",
"gender": "Male",
"identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224450bug202315032244506410612c7f1b4b36103f872a.png",
"image_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503223849bug202315032238496410612c7f1b4b36103f872a.png",
"means_of_identity": "Drivers License",
"date_of_birth": "1992-03-30T00:00:00Z",
"means_of_identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224133bug202315032241336410612c7f1b4b36103f872a.png",
"customer_type": "Personal",
"source": "Banking",
"address": {
"street": "",
"city": "Lekki",
"state": "lagos",
"country": "Nigeria",
"postal_code": "1000101"
}
}
}
{
"event": "customer.kyc.upgraded.t2",
"data": {
"id": "6410612c7f1b4b36103f872a",
"full_name": "atti bug",
"phone_number": "08033225577",
"organization_id": "640b045929eb9cf45bc720c9",
"environment": "test",
"email": "[email protected]",
"country": "Nigeria",
"group": "main",
"status": "active",
"created_at": "2023-03-14T11:57:32.567Z",
"updated_at": "2023-03-15T22:44:50.289Z",
"first_name": "bug",
"last_name": "atti",
"kyc_tier": "2",
"bvn": "22403240419",
"place_of_birth": "Port Harcourt",
"gender": "Male",
"identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224450bug202315032244506410612c7f1b4b36103f872a.png",
"image_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503223849bug202315032238496410612c7f1b4b36103f872a.png",
"means_of_identity": "Drivers License",
"date_of_birth": "1992-03-30T00:00:00Z",
"means_of_identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224133bug202315032241336410612c7f1b4b36103f872a.png",
"customer_type": "Personal",
"source": "Banking",
"address": {
"street": "",
"city": "Lekki",
"state": "lagos",
"country": "Nigeria",
"postal_code": "1000101"
}
}
}
{
"event": "customer.kyc.upgraded.t3",
"data": {
"id": "6410612c7f1b4b36103f872a",
"full_name": "atti bug",
"phone_number": "08033225577",
"organization_id": "640b045929eb9cf45bc720c9",
"environment": "test",
"email": "[email protected]",
"country": "Nigeria",
"group": "main",
"status": "active",
"created_at": "2023-03-14T11:57:32.567Z",
"updated_at": "2023-03-15T22:44:50.289Z",
"first_name": "bug",
"last_name": "atti",
"kyc_tier": "3",
"bvn": "22403240419",
"place_of_birth": "Port Harcourt",
"gender": "Male",
"identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224450bug202315032244506410612c7f1b4b36103f872a.png",
"image_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503223849bug202315032238496410612c7f1b4b36103f872a.png",
"means_of_identity": "Drivers License",
"date_of_birth": "1992-03-30T00:00:00Z",
"means_of_identity_url": "https://banc-corp-kyc.s3.us-west-1.amazonaws.com/BlocDashboard/test/atti-bug-6410612c7f1b4b36103f872a/atti20231503224133bug202315032241336410612c7f1b4b36103f872a.png",
"customer_type": "Personal",
"source": "Banking",
"address": {
"street": "",
"city": "Lekki",
"state": "lagos",
"country": "Nigeria",
"postal_code": "1000101"
}
}
}
{
"event": "card.created",
"data": {
"id": "63fdd10f265e921d6ef79f66",
"account_id": "63f60c602e865607de5b6817",
"organisation_id": "63c547e63f75813f516fe809",
"environment": "test",
"type": "virtual",
"name": "Saint Deemene",
"currency": "NGN",
"provider_card_id": "63fdd0839971f8a41ff3b08e",
"provider_card_holder_id": "63fdd04e9971f8a41ff3b055",
"brand": "Verve",
"expiry_date": "0001-01-01T00:00:00Z",
"issuance_fees": 250000,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": "0001-01-01T00:00:00Z",
"billing_address": {
"address": "44 Mobil Road Ilaje",
"city": "Ajah",
"state": "Lagos",
"country": "Nigeria"
},
"spending_channels": {}
}
}
{
"event": "card.frozen",
"data": {
"id": "64103944d1d8583c5ebb64f8",
"customer_id": "64102f442dd39da03ad71a80",
"organisation_id": "63c547e63f75813f516fe809",
"environment": "test",
"type": "virtual",
"name": "Saint Deekor",
"currency": "NGN",
"balance": 4950000,
"brand": "Verve",
"status": "inactive",
"billing_address": {
"street": "44 Mobil Road Ilaje",
"city": "Ajah",
"state": "Lagos",
"country": "Nigeria",
"postal_code": "100001"
},
"expiry_month": "06",
"expiry_year": "25",
"created_at": "2023-03-14T09:07:16.032Z",
"updated_at": "2023-03-14T09:33:53.171Z"
},
}
{
"event": "card.unfrozen",
"data": {
"id": "64103944d1d8583c5ebb64f8",
"customer_id": "64102f442dd39da03ad71a80",
"organisation_id": "63c547e63f75813f516fe809",
"environment": "test",
"type": "virtual",
"name": "Saint Deekor",
"currency": "NGN",
"balance": 4950000,
"brand": "Verve",
"status": "active",
"billing_address": {
"street": "44 Mobil Road Ilaje",
"city": "Ajah",
"state": "Lagos",
"country": "Nigeria",
"postal_code": "100001"
},
"expiry_month": "06",
"expiry_year": "25",
"created_at": "2023-03-14T09:07:16.032Z",
"updated_at": "2023-03-14T09:33:53.171Z"
}
}
{
"event": "card.debited",
"data": {
"id": "64103944d1d8583c5ebb64f8",
"customer_id": "64102f442dd39da03ad71a80",
"organisation_id": "63c547e63f75813f516fe809",
"environment": "test",
"type": "virtual",
"name": "Saint Deekor",
"currency": "NGN",
"balance": 4980000,
"brand": "Verve",
"status": "active",
"billing_address": {
"street": "44 Mobil Road Ilaje",
"city": "Ajah",
"state": "Lagos",
"country": "Nigeria",
"postal_code": "100001"
},
"expiry_month": "06",
"expiry_year": "25",
"created_at": "2023-03-14T09:07:16.032Z",
"updated_at": "2023-03-14T09:33:17.127Z"
}
}
{
"event": "card.debited",
"data": {
"id": "64103944d1d8583c5ebb64f8",
"customer_id": "64102f442dd39da03ad71a80",
"organisation_id": "63c547e63f75813f516fe809",
"environment": "test",
"type": "virtual",
"name": "Saint Deekor",
"currency": "NGN",
"balance": 5000000,
"brand": "Verve",
"status": "active",
"billing_address": {
"street": "44 Mobil Road Ilaje",
"city": "Ajah",
"state": "Lagos",
"country": "Nigeria",
"postal_code": "100001"
},
"expiry_month": "06",
"expiry_year": "25",
"created_at": "2023-03-14T09:07:16.032Z",
"updated_at": "2023-03-14T09:32:21.132Z"
}
}
Types of Events
Here are the different types of events we currently send. We'll update this list as we build more products or discover more actions.
| Event | Description |
|---|---|
| transaction.new | A transaction was created/carried out on Bloc. User can filter via "Source" and "Method" |
| transaction.updated | A transaction status was updated to "successful" or "failed" |
| account.created | A new fixed account was created |
| account.collection.created | A new collection account was created |
| wallet.created | A new wallet was created |
| customer.created | A new customer was created |
| customer.kyc.revalidated | A customer's KYC details has been revalidated |
| customer.kyc.upgraded.t1 | A customer KYC tier has been upgraded to tier 1 |
| customer.kyc.upgraded.t2 | A customer KYC tier has been upgraded to tier 2 |
| customer.kyc.upgraded.t3 | A customer KYC tier has been upgraded to tier 3 |
| card.created | A new card has been created |
| card.frozen | A card has been frozen |
| card.unfrozen | A card has been unfrozen |
| card.debited | A card has been used to perform a debit transaction |
| card.credited | A card has been successfully funded |
Supported Transaction Sources
"Source" refers to where a transaction is happening, while "Method" describes how or what type of transaction is happening. Here's a list of all the sources available in the Bloc API, and their available methods.
| Source | Description | Available methods |
|---|---|---|
| Account | Happened on a Fixed Account | Simulation (on Test Mode), Fixed Account, Collection Account |
| Transfer | Transfer out from Main Balance | Bank Transfer, Internal Transfer |
| Bills | Bills Payment (airtime/data, electricity, TV subscription) | Telecommunication, Electricity, Television |
| Checkout | Happened on the Checkout widget | Bank Transfer, Card, Crypto, Wallet |
| Card | Happened on a Card | Charge, Fund, Withdraw |
| Fee | Transaction fees or charges | KYC, Bank Transfer, Card Issuance, Collection Account |
| Commission | You received a commission from a bill payment | Telecommunication, Electricity, Television |
| Settlement | Money settled from Settlement Balance to Main Balance | Main Balance |
Credit & Debit Indicators
| CR/DR | Meaning | Description |
|---|---|---|
| CR | Credit | Inflow - money is received into an account or business |
| DR | Debit | Outflow - money is sent out, deducted or withdrawn from an account or business. |
Updated 4 months ago
Next