Create deposit account transition - Marqeta Docs

POST//

Creates a transition record to activate, suspend, or deactivate a deposit account.

Warning
Accounts in the TERMINATED state cannot be transitioned to another state. TERMINATED is a final state.

Request body

Fields	Description
token string Optional	Unique identifier of the account transitions record. If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 36 char max
account_token string Required	Unique identifier of the deposit account. Allowable Values: 36 char max
state string Required	Status of the account transitions record. Allowable Values: `ACTIVE`, `SUSPENDED`, `TERMINATED`
channel string Required	Channel associated with the account transitions record. Most account transitions use the `API` channel, and the `SYSTEM` channel is typically reserved for use by the Marqeta platform. For a detailed description of each of these values, see the `channel` field on the Card Transitions page. Allowable Values: `API`, `ADMIN`, `IVR`, `FRAUD`, `SYSTEM`
reason string Required	Explanation of why the account transitions record was created. Allowable Values: 255 char max

Response body

Fields	Description
token string Returned	Unique identifier of the account transitions record. Allowable Values: 36 char max
user_token OR business_token string Returned	Unique identifier of the user or business associated with the account transitions record. Allowable Values: 36 char max
account_token string Returned	Unique identifier of the deposit account. Allowable Values: 36 char max
state string Returned	Status of the deposit account. Allowable Values: `ACTIVE`, `SUSPENDED`, `TERMINATED`
channel string Returned	Channel associated with the account transitions record. Allowable Values: `API`, `ADMIN`, `IVR`, `FRAUD`, `SYSTEM`
reason string Returned	Explanation of why the account transitions record was created. Allowable Values: 255 char max
created_time string Returned	Date and time when the deposit transition was created. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ssZ

Sample request body

JSON

{
  "channel": "API",
  "account_token": "bf344baf-054b-420a-852f-cbedb3413b37",
  "reason": "Suspicious activity detected",
  "state": "SUSPENDED"
}

Sample response body

JSON

{
  "token": "a4e1237b-c335-4e39-acb7-bf942b2751fe",
  "user_token": "bd6772cc-3cd9-4004-8ef1-fa0743bf5d0d",
  "account_token": "bf344baf-054b-420a-852f-cbedb3413b37",
  "state": "SUSPENDED",
  "channel": "API",
  "created_time": "2020-11-15T20:27:50Z"
}