Account Number Statuses - Lead | API Docs

Lifecycle

Diagram of the statuses and lifecycle for accounts.

Statuses

Status	Description	Notes
unassigned	An Account Number is created but has not been assigned to a valid customer through either entity_id or client_customer_id.	Cannot send or receive any transfers.
active	An Account Number is assigned or re-activated with a valid customer.	Can receive and send (if enabled) transfers.
inactive	An `active` Account Number being deactivated by client, or deactivated by Lead due to internal policies.	Cannot receive or send any transfers.
canceled	This is a terminal status and can not be re-activated. Canceled Account Number will not be recycled for future usage.	Cannot send or receive any transfers.

Webhooks

account_number.created fires when an Account Number is created. Status changes do not fire webhooks; poll GET /v1/account_number/{account_number_id} if you need to observe them. Status transitions are driven by the assign, activate, deactivate, and cancel endpoints; see Managing Account Numbers.

⌘I