Retrieve Commando Mode control set - Marqeta Docs

GET//

Retrieve a specific Commando Mode control set.

URL path parameters

Fields	Description
token string Required	Unique identifier of the Commando Mode control set you want to retrieve. Allowable Values: Existing Commando Mode control set token

Response body

Fields	Description
commando_mode_enables object Conditionally returned	Defines program behavior when Commando Mode is enabled. Allowable Values: Existing `commando_mode_enables` object
commando_mode_enables.auth_controls array of strings Conditionally returned	Unique identifiers of the authorization controls enabled while in Commando Mode. Allowable Values: Valid array of one or more existing authorization control tokens
commando_mode_enables.ignore_card_suspended_state boolean Conditionally returned	If set to `true`, transactions conducted while Commando Mode is enabled proceed even when the card is suspended. If set to `false`, transactions conducted while Commando Mode is enabled are declined if the card is suspended. Allowable Values: `true`, `false`
commando_mode_enables.program_funding_source string Returned	Unique identifier of the program funding source that substitutes for the program gateway funding source upon Commando Mode enablement. Allowable Values: 36 char max
commando_mode_enables.use_cache_balance boolean Conditionally returned	This field is not currently in use. Allowable Values: N/A
commando_mode_enables.velocity_controls array of strings Conditionally returned	Unique identifiers of the velocity controls enabled while in Commando Mode. Velocity controls that are enabled in Commando Mode are inactive until a Commando Mode event occurs. When Commando Mode velocity controls are activated, they conform to the `velocity_window` specified in that velocity control. For example, a `velocity_window` of `DAY` is one calendar day starting at 00:00:00 UTC. If a Commando Mode event occurs at 11:59:59 UTC, the `DAY` window includes all transactions that occurred between 00:00:00 and 11:59:59 on that calendar day. Allowable Values: One or more existing velocity control tokens
created_time datetime Returned	Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
current_state object Conditionally returned	Describes the Commando Mode control set’s `current_state` object. Allowable Values: Existing `current_state` object
current_state.channel string Returned	Mechanism that changed the Commando Mode control set’s state. Allowable Values: `API`, `SYSTEM`
current_state.commando_enabled boolean Returned	Indicates whether Commando Mode is enabled. - If `commando_enabled` is `true` and `COMMANDO_MANUAL` is configured, all transactions are processed via Commando Mode. - If `commando_enabled` is `true` and `COMMANDO_AUTO` is configured, Commando Mode is ready to intervene only when a transaction times out or encounters an error. Allowable Values: `true`, `false`
current_state.reason string Conditionally returned	Describes the reason why the current state of the Commando Mode control set was last changed. Allowable Values: 255 char max
current_state.username string Conditionally returned	Identifies the user who last changed the Commando Mode control set’s state. Allowable Values: 255 char max
last_modified_time datetime Returned	Date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
program_gateway_funding_source_token string Conditionally returned	Unique identifier of the associated program gateway funding source. Allowable Values: Existing program gateway funding source token
real_time_standin_criteria object Conditionally returned	Specifies which event types automatically enable Commando Mode. Allowable Values: Existing `real_time_standin_criteria` object
real_time_standin_criteria.enabled boolean Conditionally returned	If set to `true`, Commando Mode is automatically enabled by events defined in the `real_time_standin_criteria` object. If set to `false`, Auto Commando Mode is not enabled. Allowable Values: `true`, `false`
real_time_standin_criteria.include_application_errors boolean Conditionally returned	If set to `true`, an application error (any non-connection, non-timeout error) automatically enables Commando Mode when `real_time_standin_criteria.enabled` is also `true`. Allowable Values: `true`, `false`
real_time_standin_criteria.include_connection_errors boolean Conditionally returned	If set to `true`, a non-timeout connection error automatically enables Commando Mode when `real_time_standin_criteria.enabled` is also `true`. Allowable Values: `true`, `false`
real_time_standin_criteria.include_response_timeouts boolean Conditionally returned	If set to `true`, a gateway response slower than 3000ms automatically enables Commando Mode when `real_time_standin_criteria.enabled` is also `true`. Allowable Values: `true`, `false`
token string Conditionally returned	Unique identifier of the Commando Mode control set. Allowable Values: Existing Commando Mode control set token

Sample response body

JSON

{
  "token": "commando_mode_1",
  "program_gateway_funding_source_token": "pgm_gateway_src_1",
  "current_state": {
    "commando_enabled": false,
    "reason": "New Commando Mode created",
    "channel": "SYSTEM"
  },
  "commando_mode_enables": {
    "program_funding_source": "pgm_funding_src_1",
    "velocity_controls": [
      "vel_control_1"
    ]
  },
  "created_time": "2023-02-14T18:48:10Z",
  "last_modified_time": "2023-02-14T18:48:10Z"
}