Disable Collection Account
Update the alias or metadata of an existing collection account, or disable or re-enable it by supplying action.
In production, disabling and re-enabling are asynchronous. The call creates a request against the account and returns immediately — the account keeps its current status until that request reaches succeeded. The response carries the account only: it does not include a requests array, so track progress by subscribing to the collection account webhooks or by polling the list endpoint.
In sandbox, disabling and re-enabling are synchronous. No request is created, no lifecycle webhook fires, reason is not recorded, and the returned account already reflects the new status. To exercise the asynchronous production flow in sandbox, drive the request states with the sandbox simulation endpoint instead.
Preconditions for action:
disable— the account must currently beenabled. Wallet accounts cannot be disabled through this endpoint.reenable— the account must currently bedisabled, must have been disabled by you rather than by Tazapay, and must haveis_reenablement_supportedset totrue.- Either action is rejected while another request is already in progress against the account.
action to disable. Once disabled, the account no longer accepts incoming payments. Only virtual accounts can be disabled through this endpoint.
In production, disabling is asynchronous — the account keeps accepting payments until the disablement request reaches succeeded. The response returns the account only and does not include a requests array, so track completion by subscribing to collection_account.disablement_succeeded (see Collection Account Webhooks) or by polling List Collection Accounts with status=disabled.
In sandbox, disabling takes effect immediately: the returned account is already disabled, no request is created, no webhook fires, and reason is not recorded.
An account disabled this way can be re-enabled later when is_reenablement_supported is true. Accounts disabled by Tazapay rather than by you cannot be re-enabled through the API.Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Unique ID of the collection account to update. 24 characters, starting with cva_ (virtual account) or cwa_ (wallet).
Body
Set of key-value pairs to attach to the collection account object.
Nickname for the account.
State transition to perform. Omit to update alias and metadata only. When supplied, a disablement or re-enablement request is created and processed asynchronously.
disable, reenable Reason recorded against the state transition. Applies only when action is supplied. Surfaced as disablement_reason on the resulting request object.