POST///
Creates a new status transition for a deposit account, changing its status to ACTIVE, SUSPENDED, or TERMINATED.
Accounts in the
TERMINATED state cannot be transitioned to another state. TERMINATED is a final state.URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the deposit account, as returned by the POST /depositaccounts endpoint.Allowable Values: Existing deposit account token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the transition. If you do not include a token, the system will generate one automatically. Allowable Values: 36 char max |
| status string Required | New status to apply to the deposit account. Allowable Values: ACTIVE, SUSPENDED, TERMINATED |
| reason string Required | Reason for the deposit account status transition. Allowable Values: 1-255 char max |
Sample request body
JSON
{
"token": "e3942f4d-55fc-49dc-b094-d8fc69b8ca38",
"status": "SUSPENDED",
"reason": "Account suspended due to suspicious activity."
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the deposit account transition. Allowable Values: 36 char max |
| status string Returned | Status of the deposit account at the time of the transition. Allowable Values: ACTIVE, SUSPENDED, TERMINATED |
| reason string Returned | Reason for the deposit account status transition. Allowable Values: 255 char max |
| created_time datetime Returned | Date and time when the transition was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| account object Returned | Deposit account associated with the transition. Allowable Values: token, name, user_token, business_token, status, reason, type, account_number, routing_number, sort_code, ibans, bic, interest_tier_token, current_tier_rate, created_time, last_modified_time |
| account.token string Returned | Unique identifier of the deposit account. Allowable Values: 36 char max |
| account.name string Conditionally returned | Name of the deposit account. Allowable Values: 255 char max |
| account.user_token string Conditionally returned | Unique identifier of the user associated with the deposit account. Allowable Values: 36 char max |
| account.business_token string Conditionally returned | Unique identifier of the business associated with the deposit account. Allowable Values: 36 char max |
| account.status string Returned | Current status of the deposit account. Allowable Values: ACTIVE, SUSPENDED, TERMINATED, PENDING, FAILED |
| account.reason string Conditionally returned | Reason for the current status of the deposit account. Allowable Values: 255 char max |
| account.type string Conditionally returned | Type of the deposit account. Allowable Values: CHECKING, SAVINGS, WALLET, DEPOSIT_ACCOUNT |
| account.account_number string Conditionally returned | Bank account number associated with the deposit account. Allowable Values: A valid bank account number |
| account.routing_number string Conditionally returned | Bank routing number used for US automated clearing house (ACH) transactions, or a local clearing code for other regions. Allowable Values: A valid bank routing number |
| account.sort_code string Conditionally returned | Sort code that identifies the bank and branch, primarily used in the United Kingdom. Allowable Values: 6 digit code |
| account.ibans array of strings Conditionally returned | Array of International Bank Account Numbers (IBANs) for cross-border transfers. Allowable Values: Up to 34 char max per IBAN, depending on the country |
| account.bic string Conditionally returned | Bank Identifier Code used for international identification of banks. Allowable Values: 8 char max. See the SWIFT BIC standard |
| account.interest_tier_token string Conditionally returned | Unique identifier of the interest tier applied to the deposit account. Allowable Values: 36 char max |
| account.current_tier_rate string Conditionally returned | Current interest rate applied to the deposit account, as a percentage ranging from 0 to 100. Do not include a percent sign (%). Allowable Values: 0–100 |
| account.created_time datetime Returned | Date and time when the deposit account was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| account.last_modified_time datetime Returned | Date and time when the deposit account was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "e3942f4d-55fc-49dc-b094-d8fc69b8ca38",
"reason": "Account suspended due to suspicious activity.",
"status": "SUSPENDED",
"created_time": "2026-01-08T18:10:00Z",
"account": {
"token": "b27f2c40-3a2e-4d8f-a93b-7c6e1f5d8b21",
"name": "My Checking Account",
"user_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "SUSPENDED",
"type": "CHECKING",
"account_number": "9873654102",
"routing_number": "021000021",
"created_time": "2026-01-08T17:56:06Z",
"last_modified_time": "2026-01-08T18:10:00Z"
}
}