Workflow: Required/Optional Parameters

When creating a LinX workflow that is not based on a template, the workflow parameters must be provided in the request body.

The following table shows the available parameters for each workflow step. The required parameters for each step are marked with *.

Note  Parameters for the enhance-profile and document-acceptance steps must be provided in the appropriate steps.inputs object. Parameters for the other steps must be provided in the parameters object.

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

Step

Parameters

notification

* phoneNumber

channel

introductoryMessage

customer-account

none

lookup-profile

* customerId

enhance-profile

personalInfo [salutation, dateOfBirth]

address [SHIPPING, MAILING, PHYSICAL]

phoneNumber [HOME or WORK]

financial-account

* financialAccountSubType

lookup-financial-account

* customerFinancialAccountId

document-acceptance

* documents [documentGroup, documentId]

move-money

* transactionType

* solution

* baFinancialAccountId

* currency

* amount

* priority (required for ACH and Wire)

* description (required for Wire)

memo (available for Wire)

* paymentReasonId

ON THIS PAGE