Retrieve details for a LinX workflow. The workflow status and details are returned. The status of each workflow step is also returned.
GET /v2/linx/workflows/{workflowId}
Authorization: Bearer <access_token>
workflowId
string (UUID)
ID of the LinX workflow.
None
Returns the LinX Workflow Detail object. This object contains a unique ID for the workflow, the workflow status, and the workflow details.
SAMPLE RESPONSE
{
"id": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
"templateId": "eacdf965-e9d8-408f-9cdf-3c7902d26ea7",
"templateVersionId": "81f0f547-679c-4059-a6d7-1060021518cf",
"status": "ACTIVE",
"title": "Send a rebate to John Doe",
"currentStep": 4,
"steps": [
{
"id": "07b6944a-70e1-48f0-bbb9-bf07b3c74820",
"stepName": "notification",
"stepDisplayName": "Notification",
"stepDescription": "Send notifications.",
"data": {
"channel": "SMS",
"email": "john.doe@abc.com",
"phoneNumber": "+1123123412345"
},
"status": "COMPLETED"
},
{
"id": "37fd1a41-d5bb-4b08-8474-86a329210c4b",
"stepName": "lookup-profile",
"stepDisplayName": "Lookup customer account",
"stepDescription": "Find an existing customer account.",
"data": {
"customerId": "01ac41f3-86a3-4651-b043-c0fbc1e1adff",
"email": "john.doe@abc.com",
"phoneNumber": "+1123123412345"
},
"status": "COMPLETED"
},
{
"id": "ed2c04d9-a1e2-4821-91c0-51b898e70213",
"stepName": "lookup-financial-account",
"stepDisplayName": "Lookup a valid informed financial account"",
"stepDescription": "Find an existing customer financial account.",
"data": {
"customerFinancialAccountId": "2829e6eb-d937-4d07-85c1-2ce8961e2448",
"financialAccountSubType": "CREDIT"
},
"status": "COMPLETED"
},
{
"id": "c0168342-57d9-43fd-9cb3-8f30fc0605f5",
"stepName": "move-money",
"stepDisplayName": "Transaction Summary",
"stepDescription": "Review and confirm your transaction summary.",
"data": {
"customerFinancialAccountName": "John Doe Credit Card",
"transactionType": "SEND",
"amount": "28.56",
"solution": "push-to-card",
"currency": "USD",
"priority": "IMMEDIATE",
"baFinancialAccountName": "ABC Checking Account",
},
"status": "ACTIVE"
}
],
"phoneNumber": "+16471234567",
"email": "john.doe@abc.com",
"expireAt": "2023-11-11T21:00:49.776302Z",
"nextNotificationAt": "2023-11-10T21:00:49.776302Z",
"completedAt": "",
"declineReason": "DONT_KNOW_BUSINESS_SENDER",
"declineDescription": "I don't recognize this transaction",
"createdBy": {
"id": "5f6b0873-f1f2-4ac6-a185-5804c4c5c303",
"type": "service-account",
},
"createdAt": "2023-11-09T21:00:49.776302Z",
"updatedBy": {
"id": "5f6b0873-f1f2-4ac6-a185-5804c4c5c303",
"type": "service-account",
},
"updatedAt": "2023-11-10T21:00:49.776302Z"
}
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
@ 2024 RocketKOR, Inc. All rights reserved.
