Create a LinX Template

Create a LinX workflow template. The template can contain some or all of the workflow settings, including:

Introductory message shown to the Customer at the start of the workflow (optional; if included, can be overridden when creating a new LinX request)
Workflow request expiry period (optional; if included, can be overridden when creating a new LinX request)
Workflow steps (required)
Workflow step parameters (user input parameters are required; other parameters are optional)

Note Some parameters cannot be included in the template and must be provided when creating the workflow 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/templates

Authorization Header

Authorization: Bearer <access_token>

Request Body

name

string

Name for the LinX template. This name is used internally and should describe the purpose of the workflow (example: create-customer-and-enhance-profile). If name is not provided, a unique name for the template will be generated automatically.

displayName REQUIRED

string

Short readable name for the template.

description

string

Description of the template’s purpose.

customerMemo

string

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

Note You can override the this setting when creating a new workflow.

defaultExpiryDays

integer

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

Note You can override the this setting when creating a new workflow.

definition REQUIRED

object

Workflow steps and related parameters.

steps

array of objects

Steps included in the workflow. The steps must be listed in the following order:

notification
customer-account or lookup-profile
enhance-profile
financial-account or lookup-financial-account
document-acceptance
move-money

For more information, see LinX Workflow Steps.

name

string enum, values: notification, customer-account, lookup-profile, enhance-profile, financial-account, lookup-financial-account, document-acceptance, move-money

Name of the step. The following values are supported:

notification Send an SMS message to the Customer with a link to the request.
customer-account Create a new Customer Account. Use this step if the workflow is for a new Customer.
lookup-profile Find an existing Customer Account. Use this step if the workflow is for an existing Customer.
enhance-profile Prompt the Customer to enter additional profile information, such as their address. This step can be used for both new and existing Customers.
financial-account Create a new external bank or card Financial Account for the Customer. This step can be used for both new and existing Customers.
lookup-financial-account Find an existing Financial Account for the Customer. This step can be used for existing Customers.
document-acceptance Require the Customer to accept one or more documents, such as a privacy policy or terms and conditions agreement. This step can be used for both new and existing Customers.
move-money Create a transaction using the Customer’s Financial Account from financial-account or lookup-financial-account. This step can be used for both new and existing Customers.

input

object

Parameters for the step. You can define parameters for the following categories:

preDefined Set parameter values as part of the template. For example, you could add a default introductoryMessage for the notification step.
user Select parameters to be entered by the Customer. When the Customer completes the workflow steps, they will be prompted to provide this information. User input parameters are required for the enhance-profile and document-acceptance steps.

preDefined

ordered map

Template parameters with predefined values. The following parameters can be predefined for each step.

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

Note Required parameters for the workflow request are marked with *. These parameters can be provided in the template or when creating the request.

Step	Template Parameters
notification	channel introductoryMessage
customer-account	none
lookup-profile	none
financial-account	* financialAccountSubType
lookup-financial-account	none
move-money	* transactionType * solution * currency * priority (required for ACH and Wire) * description (required for Wire) memo (available for Wire) * paymentReasonId

user

ordered map

Parameters to be entered by the Customer. The Customer will be prompted to provide this information when completing the workflow. The following parameters can be provided for each step.

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

Note These parameters must be defined in the template (they cannot be defined in the workflow request). Required fields for each step are marked with *.

Step	Template Parameters
enhance-profile	* At least one of the following parameters must be provided: personalInfo [salutation, dateOfBirth] addresses [SHIPPING, MAILING, PHYSICAL] phoneNumber [HOME or WORK]
document-acceptance	* documents [documentId, documentGroup]

Step

Template Parameters

enhance-profile

* At least one of the following parameters must be provided:

personalInfo [salutation, dateOfBirth]

addresses [SHIPPING, MAILING, PHYSICAL]

phoneNumber [HOME or WORK]

document-acceptance

* documents [documentId, documentGroup]

Returns

Returns the LinX Template object. This object contains template details including the template ID, template version ID, template version, and template name.

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

SAMPLE REQUEST

				
					{
  "name": "transaction-for-new-customer",
  "displayName": "Create a transaction for a new Customer",
  "description": "Create a new Customer and a new Financial Account, accept required documents, and create a transaction",
  "customerMemo": "Complete Your Purchase",
  "defaultExpiryDays": 2,
  "definition": {
    "steps": [
      {
        "name": "notification",
        "input": {
          "preDefined": {
            "channel": "SMS",
            "introductoryMessage": "Please complete the following steps to set up your account and complete your purchase."
          }
        }
      },
      {
        "name": "customer-account"
      },
      {
        "name": "financial-account",
        "input": {
          "preDefined": {
            "financialAccountSubType": "CHECKING",
          }
        }
      },
      {
        "name": "document-acceptance",
        "input": {
          "user": {
            "documents": [
              {
                "documentId": "fncl-privacy-policy",
                "documentGroup": "rocket-financial"
              }
            ]
          }
        }
      },
      {
        "name": "move-money",
        "input": {
          "preDefined": {
            "transactionType": "REQUEST",
            "solution": "ACH",
            "currency": "USD",
            "priority": "IMMEDIATE",
            "paymentReasonId": "bill-payment"
          }
        }
      }
    ]
  }
}

SAMPLE RESPONSE

				
					{
  "templateId": "6746d9f8-eb72-45d3-81c9-d53f386d6ce3",
  "templateVersionId": "0e96b2ef-0642-4666-bc35-3c9e81eaf0b7",
  "version": 2,
  "name": "transaction-for-new-customer",
  "result": {
    "successful": true
  }
}