Update transaction banking account status

Update the status of a transaction banking account and the statuses of all the account's children.

This endpoint generates the following event:

For more information on account status and reasons, see Manage account statuses.

Note: This endpoint requires an account token — an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 60

External account ID

Body Params

Status to update

string
length between 1 and 9

New status for the account.
Note: When updating the account status, make sure the status is not a final status or a status in the dormancy configuration.

string
length ≥ 1

External reason ID specifying account restrictions
minimum: 1 maximum: 120

boolean

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

metadata
object

Key-value pair field that you can use to send any information relating to a status change. The information you send is propagated in the Account status changed event.
Note that data entered in this field is not saved.
Note: If you include external_account_id in this field, the Pismo platform ignores it and only uses the one you sent in the path parameter.

Responses
204

OK

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json