Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Statuses and reasons

Update status

Update account status.

This endpoint generates an Account status changed event.

Refer to the Account status guide for more information.

patch/accounts/v2/accounts/{accountId}/status

Path parameters

accountIdinteger required
Example:6912345

Account ID

Request body

statusstring required

Account status. The pre-defined account statuses are DEBIT_ONLY, NORMAL, BLOCKED, and CANCELLED. You can create your own account statuses with the Create status endpoint.

reason_idinteger

ID of the reason why the account is in its current status. You can create reasons with the Create status reason endpoint.

descriptionstring

Description of why the account is in its current status

update_childrenboolean

Whether to update status of all account children linked through the attribute parent_account_id (true) or not (false).

Example request

{
  "status": "BLOCKED",
  "reason_id": 123,
  "description": "Registration restriction",
  "update_children": true
}

Response

OK