Bank Account Events
When subscribed to the BankAccount webhooks you will receive the following events:
| event_type | description | references |
|---|---|---|
| company.bank_account.created | Company bank account has been created | {"company_uuid": "<uuid>"} |
| company.bank_account.ready_for_verification | Micro-withdrawals are completed and the verification process can begin by using the verify a company bank account endpoint. | {"company_uuid": "<uuid>"} |
| company.bank_account.verified | Company bank account has been verified | {"company_uuid": "<uuid>"} |
| company.bank_account.updated | Company bank account has been updated | {"company_uuid": "<uuid>"} |
| company.bank_account.deleted | Company bank account has been deleted | {"company_uuid": "<uuid>"} |
| contractor.bank_account.created | Contractor bank account has been created | {"contractor_uuid": "<uuid>"} |
| contractor.bank_account.updated | Contractor bank account has been updated | {"contractor_uuid": "<uuid>"} |
| contractor.bank_account.deleted | Contractor bank account has been deleted | {"contractor_uuid": "<uuid>"} |
| employee.bank_account.created | Employee bank account has been created | {"employee_uuid": "<uuid>"} |
| employee.bank_account.updated | Employee bank account has been updated | {"employee_uuid": "<uuid>"} |
| employee.bank_account.deleted | Employee bank account has been deleted | {"employee_uuid": "<uuid>"} |
Bank account webhooks contain references that will have the additional UUIDs to call the Gusto API to retrieve the entire entity. The example below contains references because an employee UUID is required to retrieve the bank account from the API /v1/employees/{employee_id}/payment_method
Example payload
Updated 1 day ago