# GET /api/transactions/batch-file

Gets a filtered, paged list of batch files.

Supports filtering by merchant, status, upload date range, and file name.
Results are paged using skip/take pagination.

**Operation ID:** `GET_api_transactions_batch-file`

## Authorization

No permission required.

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| MerchantId | query | no | 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 | query | no | PhoeniXGateTransactionsBatchBackgroundBatchStatus | Gets or sets the status used to filter the batch file list. |
| UploadedDateFrom | query | no | string(date-time) | Gets or sets the start of the uploaded date range used to filter batch files. |
| UploadedDateTo | query | no | string(date-time) | Gets or sets the inclusive upper bound of the uploaded date range used to filter batch files. |
| FileName | query | no | string | Gets or sets the name of the file to filter or identify within the batch file list request. |
| Sorting | query | no | string |  |
| SkipCount | query | no | integer(int32) |  |
| MaxResultCount | query | no | integer(int32) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

The filtered list of batch files.

**Content type:** `text/plain`

Schema: `WinkPGApplicationDtosPagedResultDtoOfPhoeniXGateTransactionsBatchBackgroundBatchFileDto`

**Content type:** `application/json`

Schema: `WinkPGApplicationDtosPagedResultDtoOfPhoeniXGateTransactionsBatchBackgroundBatchFileDto`

**Content type:** `text/json`

Schema: `WinkPGApplicationDtosPagedResultDtoOfPhoeniXGateTransactionsBatchBackgroundBatchFileDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 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.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.
