Create Commando Mode control set

Action: POST
Endpoint: /commandomodes

A Commando Mode control set defines what happens when you enable Commando Mode. Activating Commando Mode switches your program gateway funding source to a non-gateway program funding source and enables any velocity controls you specify.

Commando Mode control sets are associated with program gateway funding sources. Each program gateway funding source can have a single associated "commandomode" object.

Body field details

Name Type Required? Description Allowable Values
token string No The unique identifier of the Commando Mode control set.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other API 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.
36 char max
programgateway_funding_source_token string Yes The unique identifier of the associated program gateway funding source. Existing program gateway funding source token.
commando_mode_enables object Yes Determines what happens when Commando Mode is enabled.

The commando_mode_enables object

Name Type Required? Description Allowable Values
program_funding_source string Yes The unique identifier of the program funding source that substitutes for the program gateway funding source upon Commando Mode activation. 36 char max
velocity_controls array No The velocity controls enabled upon Commando Mode activation. One or more existing velocity control tokens.

The current_state object (response)

The Marqeta platform returns the "current_state" object of the Commando Mode control set in the response.

Name Description Allowable Values
commando_enabled Indicates whether Commando Mode is active. true | false
reason Describes the reason for changing the current state of the Commando Mode control set. Any
channel The mechanism changing the Commando Mode control set's state. API | SYSTEM
user_name Identifies the user who changed the Commando Mode control set's state. Any

Sample request body

{
"token": "commando_mode_1",
"programgateway_funding_source_token": "pgm_gateway_src_1", 
"commando_mode_enables": {
"program_funding_source": "pgm_funding_src_1"
"velocity_controls" : [
"vel_control_1"
]
}
}

Sample response body

{
"token": "commado_mode_1",
"programgateway_funding_source_token": "pgm_gateway_src_1",
"current_state": {
"commando_enabled": false,
"reason": "New commandomode created",
"channel": "SYSTEM"
},
"commando_mode_enables": {
"program_funding_source": "pgm_funding_src_1"
"velocity_controls" : [
"vel_control_1"
]
},
"created_time": "2017-02-14T18:48:10Z",
"last_modified_time": "2017-02-14T18:48:10Z"
}


Retrieve Commando Mode control set

Action: GET
Endpoint: /commandomodes/{token}

URL path parameters

Name Type Required? Description Allowable Values
token string No The unique identifier of the Commando Mode control set.
Existing Commando Mode token.

The current_state object (response)

The Marqeta platform returns the "current_state" object of the Commando Mode control set in the response.

Name Description Allowable Values
commando_enabled Indicates whether Commando Mode is active. true | false
reason Describes the reason for changing the current state of the Commando Mode control set. Any
channel The mechanism changing the Commando Mode control set's state. API | SYSTEM
user_name Identifies the user who changed the Commando Mode control set's state. Any

Sample response body

{
"token": "commado_mode_1",
"programgateway_funding_source_token": "pgm_gateway_src_1",
"current_state": {
"commando_enabled": false,
"reason": "New commandomode created",
"channel": "SYSTEM"
},
"commando_mode_enables": {
"program_funding_source": "pgm_funding_src_1"
"velocity_controls" : [
"vel_control_1"
]
},
"created_time": "2017-02-14T18:48:10Z",
"last_modified_time": "2017-02-14T18:48:10Z"
}


Update Commando Mode control set

Action: PUT
Endpoint: /commandomodes/{token}

Include the modified details in JSON format in the body of the request. Only values of parameters included in the request are modified; all others are left unchanged.

URL path parameters

Name Type Required? Description Allowable Values
token string Yes The unique identifier of the Commando Mode control set. Existing Commando Mode control set token.

Body field details

Name Type Required? Description Allowable Values
token string No The unique identifier of the Commando Mode control set.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other API 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.
36 char max
programgateway_funding_source_token string Yes The unique identifier of the associated program gateway funding source. Existing program gateway funding source token.
commando_mode_enables object Yes Determines what happens when Commando Mode is enabled.

The commando_mode_enables object

Name Type Required? Description Allowable Values
program_funding_source string Yes The unique identifier of the program funding source that replaces the program gateway funding source upon Commando Mode activation. 36 char max
velocity_controls array No The velocity controls enabled upon Commando Mode activation. One or more existing velocity control tokens.

The current_state object (response)

The Marqeta platform returns the "current_state" object of the Commando Mode control set in the response.

Name Description Allowable Values
commando_enabled Indicates whether Commando Mode is active. true | false
reason Describes the reason for changing the current state of the Commando Mode control set. Any
channel The mechanism changing the Commando Mode control set's state. API | SYSTEM
user_name Identifies the user who changed the Commando Mode control set's state. Any

Sample Request Body

{
"token": "commando_mode_1",
"programgateway_funding_source_token": "pgm_gateway_src_1", 
"commando_mode_enables": {
"program_funding_source": "pgm_funding_src_1"
"velocity_controls" : [
"vel_control_2"
]
}
}

Sample Response Body

{
"token": "commado_mode_1",
"programgateway_funding_source_token": "pgm_gateway_src_1",
"current_state": {
"commando_enabled": false,
"reason": "New commandomode created",
"channel": "SYSTEM"
},
"commando_mode_enables": {
"program_funding_source": "pgm_funding_src_1"
"velocity_controls" : [
"vel_control_2"
]
},
"created_time": "2017-02-14T18:48:10Z",
"last_modified_time": "2017-02-14T18:48:10Z"
}


List Commando Mode control sets

Action: GET
Endpoint: /commandomodes

This endpoint supports field filtering and pagination.

Sample response body

{
"count" : 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"token": "commado_mode_1",
"programgateway_funding_source_token": "pgm_gateway_src_1",
"current_state": {
"commando_enabled": false,
"reason": "New commandomode created",
"channel": "SYSTEM"
},
"commando_mode_enables": {
"program_funding_source": "pgm_funding_src_1"
"velocity_controls" : [
"vel_control_1"
]
},
"created_time": "2017-02-14T18:48:10Z",
"last_modified_time": "2017-02-14T18:48:10Z"
}
]
}


Create Commando Mode transition

Action: POST
Endpoint: /commandomodes/transitions

A Commando Mode transition activates/deactivates a given Commando Mode control set. You must have an existing Commando Mode control set to activate/deactivate Commando Mode.

Body field details

Name Type Required? Description Allowable Values
token string No The unique identifier of the Commando Mode transition.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other API 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.
36 char max
commando_mode_token string Yes The unique identifier of the Commando Mode control set to transition. Existing Commando Mode token.
transition object Yes Determines the state of the associated Commando Mode control set.

The transition object

Name Type Required? Description Allowable Values
commando_enabled boolean Yes Indicates whether Commando Mode is active. true | false
reason string No Describes the reason for changing the current state of the Commando Mode control set. 512 char max

Default: null
channel string Yes The mechanism changing the Commando Mode control set's state. API | SYSTEM
user_name string No Identifies the user who changed the Commando Mode control set's state. 256 char max

Default: null

Sample request body

{
  "token": "commando_mode_1_transition",                                         
  "commando_mode_token": "commando_mode_1",
  "transition": {                                         
  "commando_enabled": "true”,
  "reason": "Lost connection",
  "channel": "API",
  "user_name": "Bob"
}
}

Sample response body

{
  "token": "commando_mode_1_transition",                                         
  "commando_mode_token": "commando_mode_1",
  "transition": {                                         
  "commando_enabled": "true”,
  "reason": "Lost connection",
  "channel": "API",
  "user_name": "Bob"
},
"created_time": "2017-02-14T18:48:10Z",
}


Retrieve Commando Mode transition

Action: GET
Endpoint: /commandomodes/transitions/{token}

URL path parameters

Name Type Required? Description Allowable Values
token string Yes The unique identifier of the Commando Mode transition. Existing Commando Mode transition token.

Sample response body

{
  "token": "commando_mode_1_transition",                                         
  "commando_mode_token": "commando_mode_1",
  "transition": {                                         
  "commando_enabled": "true”,
  "reason": "Lost connection",
  "channel": "API",
  "user_name": "Bob"
},
"created_time": "2017-02-14T18:48:10Z",
}


List Commando Mode transitions

Action: GET
Endpoint: /commandomodes/{commandomode_token}/transitions

This endpoint supports field filtering and pagination.

URL path parameters

Name Type Required? Description Allowable Values
token string Yes The unique identifier of the Commando Mode control set. Existing Commando Mode token.

Sample response body

{
"count" : 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
  "token": "commando_mode_1_transition",                                         
  "commando_mode_token": "commando_mode_1",
  "transition": {                                         
"commando_enabled": "true”,
  "reason": "Lost connection",
  "channel": "API",
  "user_name": "Bob"
},
"created_time": "2017-02-14T18:48:10Z",
}
]
}