Create a LinX Workflow

Create a LinX workflow for a new or existing Customer. The workflow defines the activities RocketKOR will execute for the Customer.

When you create a workflow request, RocketKOR sends a link directly to the Customer via SMS. The Customer will use this link to review and complete the workflow steps.

Note For details on the activities you can include in a workflow, see LinX Workflow Steps.

Note You can also use a template to create a LinX workflow.

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.

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.

steps REQUIRED

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.

inputs CONDITIONAL

object

Parameters for steps that require Customer input. The Customer will be prompted to provide this information when completing the workflow.

Required for the enhance-profile and document-acceptance steps.

user

object

Parameters for enhance-profile and document-acceptance. The following parameters are available for each step.

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

Step	Required Parameters	Optional Parameters
enhance-profile	At least one of the optional parameters must be provided.	personalInfo [salutation, dateOfBirth] addresses [SHIPPING, MAILING, PHYSICAL] phoneNumber [HOME or WORK]
document-acceptance	documents [documentId, documentGroup]	none

Step

Required Parameters

Optional Parameters

enhance-profile

At least one of the optional parameters must be provided.

personalInfo [salutation, dateOfBirth]

addresses [SHIPPING, MAILING, PHYSICAL]

phoneNumber [HOME or WORK]

document-acceptance

documents [documentId, documentGroup]

none

parameters REQUIRED

object

Parameters for steps that do not require Customer input. The following parameters are available for each step.

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

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

Returns

Returns the LinX Workflow object. This object contains a unique ID for the workflow, the workflow template details (if applicable), 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,
  "parameters": {
    "phoneNumber": "+16471234567",
    "channel": "SMS",
    "introductoryMessage": "You have a rebate",
    "customerId": "01ac41f3-86a3-4651-b043-c0fbc1e1adff",
    "customerFinancialAccountId": "d83ee738-786a-43cf-b1db-24c8788523c4",
    "transactionType": "SEND",
    "solution": "push-to-card",
    "baFinancialAccountId": "31c6d624-6a0c-4049-b1f1-f3ea7d00ba35",
    "currency": "USD",
    "amount": 256.25,
    "paymentReasonId": "payment-of-rebates"
  },
  "steps": [
    {
      "name": "notification"
    },
    {
      "name": "lookup-profile"
    },
    {
      "name": "enhance-profile",
      "inputs": {
        "user": {
          "personalInfo": [
            "salutation",
            "dateOfBirth"
          ],
          "addresses": [
            "SHIPPING",
            "MAILING",
            "PHYSICAL"
          ],
          "phoneNumber": [
            "HOME" // can be HOME or WORK
          ]
        }
      }
    },
    {
      "name": "lookup-financial-account"
    },
    {
      "name": "document-acceptance"
      "inputs": {
        "user": {
          "documents": [
            {
              "documentId": "ebt-communication-consent",
              "documentGroup": "bank-accounts"
            }
          ]
        }
      }
    },
    {
      "name": "move-money"
    }
  ]
}

SAMPLE RESPONSE

				
					{
  "workflowId": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
  "templateId": "",
  "templateVersionId": "",
  "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"
    }
  ]
}