--- title: "Get a workflow configuration" method: GET path: "/merchant/workflows/{workflowCode}/versions/{workflowVersion}" tags: ["Workflows"] --- # Get a workflow configuration `GET /merchant/workflows/{workflowCode}/versions/{workflowVersion}` Get a workflow configuration version. ## Path parameters - `workflowCode` string, required — Machine-friendly code of Workflow. - `workflowVersion` number, required — Workflow configuration version. ## Query parameters - `includeResolvedRulesets` boolean ## Response `200` Workflow configuration version. - object - `createdAt` string, date-time, required — Creation date of the workflow configuration. - `workflowCode` string, required — Machine-friendly code of Workflow. - `workspaceId` string, uuid, required — Workspace ID that the workflow configuration belongs to. - `createdBy` string, email — User email. The values are set with the credentials of the request owner. - `description` string — Description for the workflow. - `version` integer, required — Version of a Workflow Configuration. - `config` object, required — Configuration of the workflow. - `workspaceId` string, uuid — Workspace ID that the workflow configuration belongs to. - `global` object — Configuration shared between nodes. - `notifications` object — Configuration for notifications sent by workflow nodes. - `targets` object[], required — Targets where notifications need to be sent. - `destination` string, required — URL where notification needs to be sent. - `enabledEventTypes` string[], required — A list of events what need to be sent to the destination. If empty, the destination will be disabled, so no notifications will be sent there. - `steps` object[] — Workflow steps configuration. - `type` 'trigger' | 'action' | 'condition', required — Defines the type of operation to be executed. Each type has a different set of parameters. - `name` string, required — A human-readable step name (e.g. Authorization retry with Checkout). - `code` string, required — A machine-readable step name (e.g. authorizeRetryWithCheckout). - `params` union, required — Set of configuration parameters specific to the step type. - object — Parameters for an action step. - `type` 'createInstrument' | 'lookup' | 'authorize' | 'capture' | 'cancel' | 'refund' | 'fraudScore' | 'fraudUpdate' | 'notify' | 'payout', required — Type of action (e.g. authorize, createInstrument, etc). - `settings` union — Settings for a workflow action step, varying by action type. - object — Fraud action settings for fraud score and update actions. - … - object — Authorization action settings for payment processing. - … - object — Notification action settings for workflow events. - … - `expiration` string — Time after the action starts before it is considered expired, in ISO 8601 format (e.g. PT1H for 1 hour). - `nextActions` object — Specifies next actions executed sequentially in response to lifecycle events of an action. - `onScheduled` union[] - … - `onUnscheduled` union[] - … - `onRequested` union[] - … - `onStarted` union[] - … - `onPaused` union[] - … - `onResumed` union[] - … - `onCompleted` union[] - … - `onUpdated` union[] - … - object — Parameters for a condition step that executes different actions based on a set of rules. - `rules` object[] — A list of rules evaluated in order. The actions of the first matching rule are executed. - `condition` union, required - … - `actions` union[] — A list of actions to execute if the condition is met. - … - `defaultActions` union[] — A list of default actions to execute if no rules are met. - union - … - object — Parameters for a trigger step (entry point). - `type` 'clientAPI' | 'merchantAPI' | 'event', required — Specifies the API type for the trigger. - `params` union — Configuration parameters specific to the trigger type. - object — Parameters for clientAPI and merchantAPI trigger types. - … - object — Parameters for event trigger type. - … - `requestMapping` object[] — A list of field mappings from the trigger request to the next steps input or static values. - `from` string — Source field path in the trigger request (optional if using static value). - `to` string, required — Destination field path in the next step input. - `value` unknown - `responseMapping` object[] — A list of field mappings from the workflow step outputs to the API response or static values. - `from` string — Source field path in the trigger request (optional if using static value). - `to` string, required — Destination field path in the next step input. - `value` unknown - `nextActions` union[] — A list of actions executed sequentially after the trigger completes. - union - … - `lookup` object — Configuration for the lookup node. - `paymentOptions` union — Configuration for a specific step of a workflow node. - object - `staticConfigs` object, required — Static configuration of the step. - object - `rulesets` object[], required — Rulesets of the step. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - object - `resolvedRulesets` object[], required — Resolved Rulesets of the step. - `createdAt` string, date-time — Creation date of the ruleset. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - `trigger` object, required — An action that determines when the rules should be evaluated. - … - `rules` object[] — Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled. - … - `defaultAction` union, required — Default action to execute if none of rule conditions are fulfilled. - … - `authorize` object — Configuration for the authorize node. - `settings` union — Configuration for a specific step of a workflow node. - object - `staticConfigs` object, required — Static configuration of the step. - object - `rulesets` object[], required — Rulesets of the step. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - object - `resolvedRulesets` object[], required — Resolved Rulesets of the step. - `createdAt` string, date-time — Creation date of the ruleset. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - `trigger` object, required — An action that determines when the rules should be evaluated. - … - `rules` object[] — Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled. - … - `defaultAction` union, required — Default action to execute if none of rule conditions are fulfilled. - … - `providerOptions` union — Configuration for a specific step of a workflow node. - object - `staticConfigs` object, required — Static configuration of the step. - object - `rulesets` object[], required — Rulesets of the step. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - object - `resolvedRulesets` object[], required — Resolved Rulesets of the step. - `createdAt` string, date-time — Creation date of the ruleset. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - `trigger` object, required — An action that determines when the rules should be evaluated. - … - `rules` object[] — Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled. - … - `defaultAction` union, required — Default action to execute if none of rule conditions are fulfilled. - … - `startPaymentSession` object — Configuration for the start payment session node. - `providerOptions` union — Configuration for a specific step of a workflow node. - object - `staticConfigs` object, required — Static configuration of the step. - object - `rulesets` object[], required — Rulesets of the step. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - object - `resolvedRulesets` object[], required — Resolved Rulesets of the step. - `createdAt` string, date-time — Creation date of the ruleset. - `id` string, uuid, required — ID of Ruleset. - `version` number, required — Ruleset version. - `trigger` object, required — An action that determines when the rules should be evaluated. - … - `rules` object[] — Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled. - … - `defaultAction` union, required — Default action to execute if none of rule conditions are fulfilled. - … - `description` string — Description for the workflow. - `setAsDefaultBy` string, email, nullable — User email who set this workflow version as default. - `setAsDefaultAt` string, date-time — Timestamp when this configuration was set as default. - `versions` object[] — Rollout configuration for traffic splitting between versions. Only populated when fetching the default version. - `version` integer, required — The workflow config version. - `weight` integer, required — The weight of traffic to route to this version (1–100). All entries must sum to 100. ## Other responses - `401` — Unauthorized. - `403` — Insufficient Scope. - `404` — Not Found. - `429` — Too Many Requests. --- [API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/versions/9dd2f0158582/schema)