Global Collection Account status specific 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
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" ] } }
Check the collection account object parameter details here - Global Collection Account
Upcoming Webhook Events The following webhook events will be available soon when Tazapay enables self-serve Collection Account creation via APIs. The Collection Account status and embedded request status in the payload will reflect the current state as described below.
Event Collection Account Status Request Type Request Status collection_account.creation_under_processingdisabledenablementprocessingcollection_account.creation_requires_actiondisabledenablementrequires_actioncollection_account.creation_under_approval_holddisabledenablementapproval_holdcollection_account.creation_faileddisabledenablementfailedcollection_account.creation_cancelleddisabledenablementcancelledcollection_account.disablement_under_processingenableddisablementprocessingcollection_account.disablement_requires_actionenableddisablementrequires_actioncollection_account.disablement_failedenableddisablementfailedcollection_account.disablement_cancelledenableddisablementcancelled
collection_account.creation_under_processing { "type" : "collection_account.creation_under_processing" , "id" : "evt_abc001processingeva" , "object" : "event" , "created_at" : "2024-09-26T09:39:26.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "disabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva001enablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "enablement" , "status" : "processing" , "requested_currencies" : [ "CAD" ], "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:39:26.03501Z" , "status_description" : "Enablement request is being processed." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:39:26.03501Z" } }
collection_account.creation_requires_action { "type" : "collection_account.creation_requires_action" , "id" : "evt_abc002requiresaction" , "object" : "event" , "created_at" : "2024-09-26T09:40:00.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "disabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva001enablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "enablement" , "status" : "requires_action" , "requested_currencies" : [ "CAD" ], "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:40:00.03501Z" , "status_description" : "Additional documentation is required to proceed with enablement." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:40:00.03501Z" } }
collection_account.creation_under_approval_hold { "type" : "collection_account.creation_under_approval_hold" , "id" : "evt_abc003approvalhold" , "object" : "event" , "created_at" : "2024-09-26T09:40:30.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "disabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva001enablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "enablement" , "status" : "approval_hold" , "requested_currencies" : [ "CAD" ], "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:40:30.03501Z" , "status_description" : "Enablement request is pending approval by Tazapay." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:40:30.03501Z" } }
collection_account.creation_failed { "type" : "collection_account.creation_failed" , "id" : "evt_abc004failed" , "object" : "event" , "created_at" : "2024-09-26T09:41:00.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "disabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva001enablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "enablement" , "status" : "failed" , "requested_currencies" : [ "CAD" ], "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:41:00.03501Z" , "status_description" : "Enablement request failed due to compliance check." } ], "status_description" : "" , "metadata" : {}, "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_abc005cancelled" , "object" : "event" , "created_at" : "2024-09-26T09:41:10.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "disabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva001enablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "enablement" , "status" : "cancelled" , "requested_currencies" : [ "CAD" ], "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:41:10.03501Z" , "status_description" : "Enablement request cancelled by merchant." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:41:10.03501Z" } }
collection_account.disablement_under_processing { "type" : "collection_account.disablement_under_processing" , "id" : "evt_abc006disprocessing" , "object" : "event" , "created_at" : "2024-09-26T09:41:45.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "enabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva002disablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "disablement" , "status" : "processing" , "created_at" : "2024-09-26T09:41:44.03501Z" , "updated_at" : "2024-09-26T09:41:45.03501Z" , "status_description" : "Disablement request is being processed." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:41:45.03501Z" } }
collection_account.disablement_requires_action { "type" : "collection_account.disablement_requires_action" , "id" : "evt_abc007disrequires" , "object" : "event" , "created_at" : "2024-09-26T09:42:00.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "enabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva002disablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "disablement" , "status" : "requires_action" , "created_at" : "2024-09-26T09:41:44.03501Z" , "updated_at" : "2024-09-26T09:42:00.03501Z" , "status_description" : "Additional information required before disablement can proceed." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:42:00.03501Z" } }
collection_account.disablement_failed { "type" : "collection_account.disablement_failed" , "id" : "evt_abc008disfailed" , "object" : "event" , "created_at" : "2024-09-26T09:42:30.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "enabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva002disablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "disablement" , "status" : "failed" , "created_at" : "2024-09-26T09:41:44.03501Z" , "updated_at" : "2024-09-26T09:42:30.03501Z" , "status_description" : "Disablement request failed." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:42:30.03501Z" } }
collection_account.disablement_cancelled { "type" : "collection_account.disablement_cancelled" , "id" : "evt_abc009discancelled" , "object" : "event" , "created_at" : "2024-09-26T09:42:45.000000000Z" , "data" : { "id" : "cva_crqinja9chqqs7moi8rg" , "object" : "collection_account" , "type" : "virtual_account" , "payment_method_type" : "local_bank_transfer_cad" , "status" : "enabled" , "currencies" : [ "CAD" ], "on_behalf_of" : "ent_d72h4h5hq6qriqd392e0" , "virtual_account" : { "account_holder_name" : "testacc" , "account_number" : "testacc1234-56-1234" , "bank_name" : "testBank" , "bank_branch" : "testBankBranch" , "bank_address" : { "address_line_1" : "testAdd" , "address_line_2" : "testAdd1" , "country" : "United States of America" }, "bank_codes" : { "ach_routing_number" : "testRoutingNumber" , "routing_code" : "testRoutingCode" , "swift_code" : "testSwift" }, "iban" : "testIban" , "account_reenablement_supported" : true }, "requests" : [ { "id" : "req_cva002disablement" , "object" : "collection_account_request" , "collection_account_id" : "cva_crqinja9chqqs7moi8rg" , "type" : "disablement" , "status" : "cancelled" , "created_at" : "2024-09-26T09:41:44.03501Z" , "updated_at" : "2024-09-26T09:42:45.03501Z" , "status_description" : "Disablement request cancelled by merchant." } ], "status_description" : "" , "metadata" : {}, "created_at" : "2024-09-26T09:39:25.03501Z" , "updated_at" : "2024-09-26T09:42:45.03501Z" } }
