Workflow Based on a Template: Required/Optional Parameters

When creating a LinX workflow based on a template, some of the parameters can be set in the template, while other parameters can be (or must be) provided in the request body. The following table shows the parameters that must be provided in the template, the parameters that must be provided in the request body, and the parameters that can be provided in either the template or the request body. The required parameters for each step are marked with *.

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

Workflow Step

Template

These parameters must be provided in the template.

Request Body

These parameters must be provided in the workflow request body.

Template or Request Body

These parameters can be provided in the template or the workflow request body.

notification

none

phoneNumber

channel

introductoryMessage

customer-account

none

none

none

lookup-profile

none

customerId

none

enhance-profile

personalInfo [salutation, dateOfBirth]

address [SHIPPING, MAILING, PHYSICAL]

phoneNumber [HOME or WORK]

none

none

financial-account

none

none

financialAccountSubType

lookup-financial-account

none

customerFinancialAccountId

none

document-acceptance

documents [documentGroup, documentId]

none

none

move-money

none

baFinancialAccountId

amount

transactionType

solution

* currency

priority (required for ACH and Wire)

description (required for Wire)

memo (available for Wire)

paymentReasonId

ON THIS PAGE
Exit mobile version