| Order | Step | Description | Requirements |
|---|---|---|---|
| 1 | notification | Send an SMS message to the Customer with a link to the request. | Required as the first step in the workflow. |
| 2 | customer-account | Create a new Customer Account. Use this step if the workflow is for a new Customer. | Either customer-account or lookup-profile is required as the second step in the workflow. Important If both customer-account and lookup-profile are included in the workflow, the request will fail. |
| 2 | lookup-profile | Find an existing Customer Account. Use this step if the workflow is for an existing Customer. | Either customer-account or lookup-profile is required as the second step in the workflow. Important If both customer-account and lookup-profile are included in the workflow, the request will fail. |
| 3 | 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. If move-money is included in the workflow, this newly created Financial Account will be used as the Customer Financial Account in the transaction. | This step is optional. If the workflow includes move-money, either financial-account or lookup-financial-account is required. Important If both financial-account and lookup-financial-account are included in the workflow, the request will fail. |
| 3 | lookup-financial-account | Find an existing Financial Account for the Customer. This step can be used for existing Customers only. If move-money is included in the workflow, this existing Financial Account will be used as the Customer Financial Account in the transaction. | This step is optional. If the workflow includes move-money, either financial-account or lookup-financial-account is required. Important If both financial-account and lookup-financial-account are included in the workflow, the request will fail. |
| 4 | move-money | Create a transaction using the Customer’s Financial Account. Either financial-account or lookup-financial-account will be used as the Customer Financial Account in the transaction. | This step is optional. |
| Step | Parameters (* required) |
|---|---|
| notification | * channel * phoneNumber introductoryMessage |
| customer-account | none |
| lookup-profile | * customerId |
| financial-account | * financialAccountSubType |
| lookup-financial-account | * customerFinancialAccountId |
| move-money | * transactionType * solution * baFinancialAccountId * currency * amount * priority (required for ACH and Wire) * description (required for Wire) memo (available for Wire) * paymentReasonId |
The following requests illustrate typical use cases for LinX workflows.
The following workflow will:
{
"title": "Create a new Customer Account for John Doe",
"expireIn": "2",
"parameters": {
"channel": "SMS",
"phoneNumber": "+16471234567",
"introductoryMessage": "Create a new customer account"
},
"steps": [
{
"name": "notification"
},
{
"name": "customer-account"
}
]
}
The following workflow will:
{
"title": "Create a new Financial Account for John Doe",
"expireIn": "2",
"parameters": {
"channel": "SMS",
"phoneNumber": "+16471234567",
"introductoryMessage": "Add a debit card",
"customerId": "8c8cab63-4e53-4acf-9efa-e7324816aa36",
"financialAccountSubType": "DEBIT"
},
"steps": [
{
"name": "notification"
},
{
"name": "lookup-profile"
},
{
"name": "financial-account"
}
]
}
The following workflow will:
{
"title": "Send a rebate to a new Financial Account for new Customer John Doe",
"expireIn": "2",
"parameters": {
"channel": "SMS",
"phoneNumber": "+16471234567",
"introductoryMessage": "You have a rebate",
"financialAccountSubType": "DEBIT",
"transactionType": "SEND",
"solution": "push-to-card",
"baFinancialAccountId": "31c6d624-6a0c-4049-b1f1-f3ea7d00ba35",
"currency": "USD",
"amount": 256.25,
"priority": "IMMEDIATE",
"paymentReasonId": "payment-of-rebates"
},
"steps": [
{
"name": "notification"
},
{
"name": "customer-account"
},
{
"name": "financial-account"
},
{
"name": "move-money"
}
]
}
The following workflow will:
{
"title": "Send a rebate to an existing Financial Account for John Doe",
"expireIn": "2",
"parameters": {
"channel": "SMS",
"phoneNumber": "+16471234567",
"introductoryMessage": "You have a rebate",
"customerId": "8c8cab63-4e53-4acf-9efa-e7324816aa36",
"customerFinancialAccountId": "bbbf2fbf-81d4-4f2d-8f80-201bcca921d4",
"transactionType": "SEND",
"solution": "push-to-card",
"baFinancialAccountId": "31c6d624-6a0c-4049-b1f1-f3ea7d00ba35",
"currency": "USD",
"amount": 256.25,
"priority": "IMMEDIATE",
"paymentReasonId": "payment-of-rebates"
},
"steps": [
{
"name": "notification"
},
{
"name": "lookup-profile"
},
{
"name": "lookup-financial-account"
},
{
"name": "move-money"
}
]
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2023 RocketKOR, Inc. All rights reserved.
