Retrieve a LinX Workflow

Retrieve details for a LinX workflow. The workflow status and details are returned. The status of each workflow step is also returned.

Endpoint

GET /v2/linx/workflows/{workflowId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

workflowId

string (UUID)

ID of the LinX workflow.

Request Body

None

Returns

Returns a unique ID for the workflow, the workflow status, and the workflow details. The following fields are returned.

string (UUID)

ID of the workflow.

status

string enum, values: ACTIVE, ARCHIVED, CANCELLED, COMPLETED, CREATED, DECLINED, EXPIRED

Current status of the workflow.

title

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

currentStep

integer (int32)

Index of the current workflow step to be completed by the Customer.

steps

array of objects

Steps included in the workflow. The steps must be listed in the following order:

notification
customer-account or lookup-profile
financial-account or lookup-financial-account
move-money

For more information, see LinX Workflow Steps.

string (UUID)

ID of the workflow step.

stepName

string enum, values: notification, customer-account, lookup-profile, financial-account, lookup-financial-account, move-money

Name of the workflow step.

stepDisplayName

string

Short display name for the step. Example: Lookup customer account

stepDescription

string

Description of the step. Example: Find an existing customer account.

data

object

Parameters and values related to the step.

status

string enum, values: ACTIVE, COMPLETED, DECLINED, CREATED

Status of the step.

phoneNumber

string

Customer’s mobile phone number. The LinX request is sent to this number via SMS.

string

Customer’s email address. Returned when a Customer is created or found in the current workflow step.

expireAt

string (date-time)

Date and time the request expires.

nextNotificationAt

string (date-time)

Date and time the next reminder notification will be sent to the Customer.

completedAt

string (date-time)

Date and time the workflow was completed.

declineReason

string enum, values: DONT_KNOW_BUSINESS_SENDER, INCORRECT_PAYMENT_REASON, INCORRECT_FINANCIAL_ACCOUNT, INCORRECT_AMOUNT, OTHER

Reason the transaction was declined by the Customer.

declineDescription

string

Details provided by the Customer regarding why the transaction was declined.

createdBy

string

Entity that created the LinX request.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

createdAt

string (date-time)

Date and time the LinX request was created in the RocketKOR system.

updatedBy

string

Entity that last updated the Linx request.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

updatedAt

string (date-time)

Date and time the LinX request was last updated.

SAMPLE RESPONSE

				
					{
  "id": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
  "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",
  "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"
}