Available events
| Event | Description | Default (On / Off) |
|---|---|---|
| collection_account.creation_succeeded | Triggered when the status is enabled | On |
| collection_account.disablement_succeeded | Triggered when the status is disabled | On |
Webhook payload
Every event uses the same envelope, anddata is projected through a fixed allowlist — only the fields below are ever sent, regardless of the event.
| Field | Sub-fields | Type | Description |
|---|---|---|---|
| type | string | The event type, for example collection_account.creation_succeeded | |
| id | string | Unique ID of the event, prefixed evt_ | |
| object | string | String representing the object’s type. It is event here | |
| created_at | timestamp | Timestamp at which the event was created | |
| data | json | The collection account, or the request driving the change — see below | |
| id | string | cva_/cwa_ account id on the three succeeded events, cvar_/cwar_ request id on all others | |
| object | string | String representing the object’s type. It is always collection_account here | |
| status | string | Account status (enabled/disabled) on the three succeeded events, request status on all others | |
| on_behalf_of | string | ID of the entity the account is configured on behalf of, prefixed ent_. Empty for direct accounts | |
| currencies | array of string | Currencies, uppercase, ISO-4217 standard | |
| payment_method_type | string | Type of payment method. Sent on the three succeeded events only | |
| metadata | json | Key-value pairs attached to the collection account. Sent on the three succeeded events only | |
| virtual_account | json | Bank details. Present for virtual accounts only | |
| wallet | json | Wallet details. Present for wallets only | |
| failure_reason | string | Reason the request failed. Present on the *_failed events only | |
| created_at | timestamp | Creation timestamp of the object in data | |
| updated_at | timestamp | Last-updated timestamp of the object in data |
wallet carries type and deposit_address. virtual_account carries account_holder_name, account_number, iban, bank_name and bank_codes, plus bank_branch and bank_address on the three succeeded events.
Sample Events
collection_account.creation_succeeded
{
"type": "collection_account.creation_succeeded",
"id": "evt_crqinqs584jmicmfjbhg",
"object": "event",
"created_at": "2024-09-26T09:39:55.369534811Z",
"data": {
"metadata": {},
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"bank_address": {
"address_line_1": "testAdd",
"address_line_2": "testAdd1",
"country": "United States of America"
},
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"bank_code": "testBankCode",
"bsb_code": "testBsbCode",
"fedwire_routing_number": "TestFedWire",
"routing_code": "testRoutingCode",
"sort_code": "testSortCode",
"swift_code": "testSwift"
},
"bank_branch": "testBankBranch",
"bank_name": "testBank",
"iban": "testIban"
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:39:25.03501Z",
"id": "cva_crqinja9chqqs7moi8rg",
"object": "collection_account",
"payment_method_type": "local_bank_transfer_cad",
"status": "enabled",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
]
}
}
collection_account.disablement_succeeded
{
"type": "collection_account.disablement_succeeded",
"id": "evt_crqiom4584jmicmfjf5g",
"object": "event",
"created_at": "2024-09-26T09:41:44.365564104Z",
"data": {
"metadata": {},
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"bank_address": {
"address_line_1": "testAdd",
"address_line_2": "testAdd1",
"country": "United States of America"
},
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"bank_code": "testBankCode",
"bsb_code": "testBsbCode",
"fedwire_routing_number": "TestFedWire",
"routing_code": "testRoutingCode",
"sort_code": "testSortCode",
"swift_code": "testSwift"
},
"bank_branch": "testBankBranch",
"bank_name": "testBank",
"iban": "testIban"
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:43.349835Z",
"id": "cva_crqinja9chqqs7moi8rg",
"object": "collection_account",
"payment_method_type": "local_bank_transfer_cad",
"status": "disabled",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
]
}
}
Upcoming Webhook Events
The following webhook events will be available soon when Tazapay enables self-serve Collection Account creation via APIs.
data block, id is the request id (cvar_/cwar_) and status is the request status. payment_method_type and metadata are not sent on these events. Use collection_account.creation_succeeded, disablement_succeeded or reenable_succeeded for the account itself.
| Event | Meaning | Default (On / Off) |
|---|---|---|
collection_account.creation_under_approval_hold | Enablement request is held pending approval | Off |
collection_account.creation_requires_action | Enablement request needs input from you | On |
collection_account.creation_failed | Enablement request failed | On |
collection_account.creation_cancelled | Enablement request was cancelled | On |
collection_account.disablement_under_processing | Disablement request has started processing | Off |
collection_account.disablement_requires_action | Disablement request needs input from you | On |
collection_account.disablement_failed | Disablement request failed | On |
collection_account.disablement_cancelled | Disablement request was cancelled | On |
collection_account.reenable_under_processing | Re-enablement request has started processing | Off |
collection_account.reenable_failed | Re-enablement request failed | On |
collection_account.reenable_cancelled | Re-enablement request was cancelled | On |
collection_account.reenable_succeeded | Account is enabled again (account event, status is enabled) | On |
collection_account.creation_under_approval_hold
{
"type": "collection_account.creation_under_approval_hold",
"id": "evt_crqinqs584jmicmfjb02",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "approval_hold",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.creation_requires_action
{
"type": "collection_account.creation_requires_action",
"id": "evt_crqinqs584jmicmfjb03",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "requires_action",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.creation_failed
{
"type": "collection_account.creation_failed",
"id": "evt_crqinqs584jmicmfjb04",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "failed",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"failure_reason": "Enablement request failed due to compliance check.",
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.creation_cancelled
{
"type": "collection_account.creation_cancelled",
"id": "evt_crqinqs584jmicmfjb05",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "cancelled",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.disablement_under_processing
{
"type": "collection_account.disablement_under_processing",
"id": "evt_crqinqs584jmicmfjb06",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "not_initiated",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.disablement_requires_action
{
"type": "collection_account.disablement_requires_action",
"id": "evt_crqinqs584jmicmfjb07",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "requires_action",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.disablement_failed
{
"type": "collection_account.disablement_failed",
"id": "evt_crqinqs584jmicmfjb08",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "failed",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"failure_reason": "Disablement request failed at the provider.",
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.disablement_cancelled
{
"type": "collection_account.disablement_cancelled",
"id": "evt_crqinqs584jmicmfjb09",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "cancelled",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.reenable_under_processing
{
"type": "collection_account.reenable_under_processing",
"id": "evt_crqinqs584jmicmfjb10",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "not_initiated",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.reenable_failed
{
"type": "collection_account.reenable_failed",
"id": "evt_crqinqs584jmicmfjb11",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "failed",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"failure_reason": "Re-enablement request failed at the provider.",
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.reenable_cancelled
{
"type": "collection_account.reenable_cancelled",
"id": "evt_crqinqs584jmicmfjb12",
"object": "event",
"created_at": "2024-09-26T09:41:00.000000000Z",
"data": {
"id": "cvar_crqinja9chqqs7moi8rg1",
"object": "collection_account",
"status": "cancelled",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T09:41:00.03501Z"
}
}
collection_account.reenable_succeeded
{
"type": "collection_account.reenable_succeeded",
"id": "evt_crqinqs584jmicmfjbi2",
"object": "event",
"created_at": "2024-09-26T10:10:30.000000000Z",
"data": {
"id": "cva_crqinja9chqqs7moi8rg",
"object": "collection_account",
"payment_method_type": "local_bank_transfer_cad",
"status": "enabled",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"currencies": [
"CAD"
],
"virtual_account": {
"account_holder_name": "testacc",
"account_number": "testacc1234-56-1234",
"iban": "testIban",
"bank_name": "testBank",
"bank_codes": {
"ach_routing_number": "testRoutingNumber",
"routing_code": "testRoutingCode",
"swift_code": "testSwift"
}
},
"metadata": {},
"created_at": "2024-09-26T09:39:25.03501Z",
"updated_at": "2024-09-26T10:10:30.03501Z"
}
}