Sign in

v1

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

Roll back transaction banking account status

Roll back an account from its final status. <b>Note</b>: You can only change the account status from its final status to one that is both not final and not in a dormant state.

This endpoint generates an Account status changed event.

For more information on account statuses, refer to Manage account statuses.

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

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

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

descriptionstring

Account status reason description<br> minLength: 1 maxLength: 500

Example request

{
  "status": "DORMANT",
  "reason_external_id": "CREDIT_ONLY",
  "description": "CREDIT_ONLY"
}

Response

OK