Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Accounts

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.

patch/corporate/v2/corporate-accounts/{externalAccountId}/status

Path parameters

externalAccountIdstring required

External account ID

Request body

statusstring

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

reason_external_idstring

External reason ID specifying account restrictions<br> minimum: 1 maximum: 120

update_childrenboolean

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

metadataMetadata2

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.<br> Note that data entered in this field is not saved.<br> <b>Note</b>: 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.<br>

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example request

{
  "status": "DORMANT",
  "reason_external_id": "CREDIT_ONLY",
  "update_children": true
}

Response

OK