Create a LinX Workflow Using a Template

Create a LinX workflow for a new or existing Customer based on a workflow template. The workflow will be created using the latest version of the template.

A LinX workflow template can contain the following settings:

Introductory message shown to the Customer at the start of the workflow (optional)
Workflow request expiry period (optional)
Workflow steps and related parameters (required)

When creating the workflow creation request:

You can override the introductory message and expiry period from the template.
You cannot add, modify, or delete the workflow steps from the template.
You must include specific parameters for the notification, lookup-profile, lookup-financial-account, and move-money steps in the request body. These parameters are listed in the Request Body section below.
You cannot modify or delete parameters that are included in the template.
For the notification, financial-account, and move-money steps, you can add parameters that are not included in the template.
For the enhance-profile and document-acceptance steps, you cannot add, modify, or delete the user input parameters that are included in the template.

Note For details on the parameters you can include in the request, see Workflow Based on a Template: Required/Optional Parameters.

Note Ensure that the request includes all required parameters. Some required parameters may be set in the template, while others must be provided in the request. For details, see Workflow Based on a Template: Required/Optional Parameters.

Note For more information about templates, see LinX Templates Overview.

Endpoint

POST /v2/linx/workflows

Authorization Header

Authorization: Bearer <access_token>

Request Body

title REQUIRED

string

Name for the LinX workflow. This name is used internally and should describe the purpose of the workflow (example: Send refund to John Smith).

customerMemo

string

Introductory message to display to the Customer at the start of the workflow.

If customerMemo is provided, this will override the customerMemo value provided in the template.

expireInHours

integer

Request expiry period (in hours). The workflow request and the link provided to the Customer will expire at this time. If expireInHours is not provided, the system default value will be used.

If expireInHours is provided, this will override the defaultExpiryDays value provided in the template.

templateId CONDITIONAL

string (UUID)

ID of the LinX template to use for the workflow. Either templateId or templateName is required. Note that if both these parameters are provided, the request will fail.

templateName CONDITIONAL

string

Name of the LinX template to use for the workflow. Either templateName or templateId is required. Note that if both these parameters are provided, the request will fail.

parameters REQUIRED

object

Additional parameters to include in the workflow. Some parameters must be provided in the request body; the remaining parameters can be provided in the request body if they are not included in the template.

Note If an optional parameter is included in both the template and the request body, the template value will be used.

The following parameters are available for each step.

Note For detailed information about each parameter, see Workflow Parameter Definitions.

Step	Required Parameters for the Request Body	Optional Parameters for the Request Body
notification	phoneNumber	channel introductoryMessage
customer-account	none	none
lookup-profile	customerId	none
enhance-profile	none	none
financial-account	none	financialAccountSubType
lookup-financial-account	customerFinancialAccountId	none
document-acceptance	none	none
move-money	baFinancialAccountId amount	transactionType solution currency priority (required for ACH and Wire) description (required for Wire) memo (available for Wire) paymentReasonId

Returns

Returns the LinX Workflow object. This object contains a unique ID for the workflow, the workflow template details, and a summary of the workflow steps.

Also returns the LinX Result object. This object contains the outcome of the request and any detailed error messaging.

SAMPLE REQUEST

				
					{
  "title": "Send a rebate to John Doe",
  "customerMemo": "Hi John Doe, we’ve processed your rebate.",
  "expireInHours": 48,
  "templateId": "6746d9f8-eb72-45d3-81c9-d53f386d6ce3",
  "parameters": {
    "phoneNumber": "+16471234567",
    "customerId": "01ac41f3-86a3-4651-b043-c0fbc1e1adff",
    "customerFinancialAccountId": "d83ee738-786a-43cf-b1db-24c8788523c",
    "baFinancialAccountId": "31c6d624-6a0c-4049-b1f1-f3ea7d00ba35",
    "amount": 256.25
  }
}

SAMPLE RESPONSE

				
					{
  "workflowId": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
  "templateId": "eacdf965-e9d8-408f-9cdf-3c7902d26ea7",
  "templateVersionId": "81f0f547-679c-4059-a6d7-1060021518cf",
  "result": {
    "successful": true
  },
  "steps": [
    {
      "stepName": "notification",
      "stepId": "07b6944a-70e1-48f0-bbb9-bf07b3c74820"
    },
    {
      "stepName": "lookup-profile",
      "stepId": "37fd1a41-d5bb-4b08-8474-86a329210c4b"
    },
      "stepName": "enhance-profile",
      "stepId": "63bae94f-12a2-40b8-be02-1b31f1d6c066"
    },
    {
      "stepName": "lookup-financial-account",
      "stepId": "ed2c04d9-a1e2-4821-91c0-51b898e70213"
    },
      "stepName": "document-acceptance",
      "stepId": "7894f1c1-6861-47c2-831c-c4b9b5d87e5f"
    },
    {
      "stepName": "move-money",
      "stepId": "c0168342-57d9-43fd-9cb3-8f30fc0605f5"
    }
  ]
}