Retrieve LinX Batch Entries by Status

Retrieve details for the workflow requests (called “entries”) for the batch. You can filter the results by status. You can also sort the results and limit the number of results returned.

Endpoint

GET /v2/linx/workflow-batches/{batchId}/entries

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

batchId REQUIRED

string (UUID)

ID of the LinX batch.

Query Parameters

status REQUIRED

string enum, values: NEW, QUEUED, COMPLETED, INVALID, CANCELLING, FAILED

Status of the LinX batch. The following values are supported:

NEW New batch has been created.
QUEUED Batch entries (requests) have been queued for creation.
COMPLETED All requests have been executed.
INVALID JSON schema validation failed.
CANCELLING Batch has been cancelled.
FAILED Batch was not processed.

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32), default value: 1

Page number to return. Uses one-based indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns an array of LinX Batch Status objects.

SAMPLE RESPONSE

				
					{
  "position": 0,
  "title": "Refund",
  "id": 7538498e-7416-4869-ae88-1a6c764cc2f7,
  "status": "ACTIVE",
  "phoneNumber": "5551231234",
  "errorCode": "string",
  "errorMessage": "string",
  "fieldErrors": [
    {
      "fieldName": "string",
      "fieldCategory": "string",
      "code": "string",
      "message": "string"
    }
  ]
}

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

Exit mobile version