Gets a filtered, paged list of batch files.
GET
/api/transactions/batch-file
deprecated
No permission required.
Supports filtering by merchant, status, upload date range, and file name. Results are paged using skip/take pagination.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
MerchantId
required |
query | string (uuid) | Gets or sets the unique identifier of the merchant to filter the batch file list. When not specified, results are not restricted to a single merchant. |
Status
required |
query | PhoeniXGateTransactionsBatchBackgroundBatchStatus | Gets or sets the status used to filter the batch file list. |
UploadedDateFrom
required |
query | string (date-time) | Gets or sets the start of the uploaded date range used to filter batch files. |
UploadedDateTo
required |
query | string (date-time) | Gets or sets the inclusive upper bound of the uploaded date range used to filter batch files. |
FileName
required |
query | string | Gets or sets the name of the file to filter or identify within the batch file list request. |
Sorting
required |
query | string | |
SkipCount
required |
query | integer (int32) | |
MaxResultCount
required |
query | integer (int32) | |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 The filtered list of batch files.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.