This release adds a new public Private Account Lifecycle guide and documents the customer-facing lifecycle actions available for private accounts: cancel, block, and activate.
Impact: You now have a dedicated guide that explains the public lifecycle actions supported for private accounts, including their intended usage, supported state transitions, and example requests.
Action required: Review the new guide if your integration needs to temporarily block, reactivate, or permanently cancel private accounts.
References: Private Account Lifecycle
Impact: The public API documentation now includes the endpoint to permanently cancel a private account.
Action required: If you need to permanently disable a private account, use: PUT /v1/clients/{clientId}/accounts/{accountId}/cancel
References:
- Private Account Lifecycle
PUT /v1/clients/{clientId}/accounts/{accountId}/cancel
Impact: The public API documentation now includes the endpoint to temporarily block a private account.
Action required: If you need to temporarily disable a private account, use: PUT /v1/clients/{clientId}/accounts/{accountId}/block
References:
- Private Account Lifecycle
PUT /v1/clients/{clientId}/accounts/{accountId}/block
Impact: The public API documentation now includes the endpoint to restore a previously blocked private account to ACTIVE.
Action required: If you need to reactivate a previously blocked private account, use: PATCH /v1/clients/{clientId}/accounts/{accountId}/activate
References:
- Private Account Lifecycle
PATCH /v1/clients/{clientId}/accounts/{accountId}/activate
Impact: The Quickstart can now direct integrators to the lifecycle management guide after private account creation, making the next operational steps easier to discover.
Action required: None.
References: