Guides

Wallet Deactivated

This webhook is triggered when a worker's wallet is deactivated. This could be due to Branch confirming fraud, or the worker requesting that their account be closed.

Event

WALLET_DEACTIVATED

Data

employee_id - String
Unique ID for the worker

account_number - String
Worker 16-character Branch account number

routing_number - String
Routing number for the initialized account

reason_code - String
Reason code for deactivation

TERMS_OF_SERVICE_VIOLATION
CONFIRMED_FRAUD
USER_REQUESTED

The wallet is deactivated due to fraud check failing, fraudulent activity detected, violation of terms of service, or the worker requesting deactivation.

reason - String
Reason for deactivation

time_emitted - datetime
Time and date of the deactivation

is_claimed - Boolean
Indicates if wallet is claimed

Example

"data": {
  "employee_id": "123",
  "account_number": "1234567891234567",
  "routing_number": "084106768",
  "reason_code": "USER_REQUESTED",
  "reason": "Worker Resigned",
  "time_emitted": "2023-12-30T15:40:32-08:00",
  "is_claimed": true
}

Updated 3 months ago