# POST /api/transactions/batch-file/upload

Uploads a CSV batch file for transaction processing.

The file must be CSV format and no larger than 10 MB. On upload the file is
saved to blob storage, parsed, and validated. The returned DTO indicates
whether validation succeeded (status = Ready) or failed (status = Failed
with error details in `ErrorMessage`).

**Operation ID:** `batchFileUploadBatchFile`

## Authorization

No permission required.

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The batch file upload payload including file content and merchant context.

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

Schema: `BatchFileUploadDto`

Properties:
- `merchantId` (string(uuid)): Gets or sets the unique identifier of the merchant associated with the batch file upload.
- `fileName` (string): Gets or sets the name of the file associated with the batch upload.
- `fileContent` (string(byte)): Gets or sets the binary content of the file to upload.
- `notes` (string): Gets or sets optional notes associated with the batch file upload.

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

Schema: `BatchFileUploadDto`

Properties:
- `merchantId` (string(uuid)): Gets or sets the unique identifier of the merchant associated with the batch file upload.
- `fileName` (string): Gets or sets the name of the file associated with the batch upload.
- `fileContent` (string(byte)): Gets or sets the binary content of the file to upload.
- `notes` (string): Gets or sets optional notes associated with the batch file upload.

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

Schema: `BatchFileUploadDto`

Properties:
- `merchantId` (string(uuid)): Gets or sets the unique identifier of the merchant associated with the batch file upload.
- `fileName` (string): Gets or sets the name of the file associated with the batch upload.
- `fileContent` (string(byte)): Gets or sets the binary content of the file to upload.
- `notes` (string): Gets or sets optional notes associated with the batch file upload.

## Responses

### 200

Batch file uploaded and validated successfully.

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

Schema: `BatchFileDto`

Properties:
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity.
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified.
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity.
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted.
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted.
- `merchantId` (string(uuid)): Gets or sets the unique identifier of the merchant associated with the batch file.
- `merchantName` (string): Gets or sets the merchant name associated with the batch file.
- `fileName` (string): Gets or sets the name of the file.
- `filePath` (string): Gets or sets the file system path to the batch file.
- `status` (object): Gets or sets the current processing status of the batch file.
- `totalTransactions` (integer(int32)): Gets or sets the total number of transactions included in the batch file.
- `processedTransactions` (integer(int32)): Gets or sets the number of transactions that have been processed for the batch file.
- `successfulTransactions` (integer(int32)): Gets or sets the number of transactions in the batch that completed successfully.
- `failedTransactions` (integer(int32)): Gets or sets the number of transactions in the batch that failed to process.
- `uploadedDate` (string(date-time)): Gets or sets the date and time when the batch file was uploaded.
- `validatedDate` (string(date-time)): Gets or sets the date and time when the batch file was validated.
- `processingStartDate` (string(date-time)): Gets or sets the date and time when processing of the batch file started.
- `processingEndDate` (string(date-time)): Gets or sets the date and time when processing of the batch file completed.
- `processedByUserId` (string(uuid)): Gets or sets the unique identifier of the user who processed the batch file.
- `processedByUserName` (string): Gets or sets the name of the user who processed the batch file.
- `transactions` (array<BatchFileTransactionDto>): Gets or sets the collection of transactions included in the batch file.
- `notes` (string): Gets or sets optional notes associated with the batch file.
- `errorMessage` (string): Gets or sets a human-readable description of the error associated with the batch file, if any.
- `concurrencyStamp` (string): Gets or sets a value used to detect concurrent updates to the batch file.
- `progressPercentage` (number(double)): Calculated property for progress percentage
- `successRate` (number(double)): Calculated property for success rate

### 400

File is not CSV, exceeds 10 MB, or the merchant does not exist.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 403

Forbidden

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause. A sandbox request whose merchant has spent the plan's transaction allowance is refused with a different `application/json` body: `code` is `USAGE_BUDGET_EXCEEDED`, and `limit` and `used` report the allowance. `Retry-After` is sent only when the allowance resets. An allowance that never resets sends none, and retrying won't help.

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

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

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

Schema type: `object`

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a BatchFileUploadDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/batch-file/upload" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "",
  "fileContent": "",
  "notes": ""
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "",
  "fileContent": "",
  "notes": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/batch-file/upload' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, TransactionsApi } from '@winkpg/winkpg-api';

const api = new TransactionsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.batchFileUploadBatchFile({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "",
  "fileContent": "",
  "notes": ""
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/transactions/batch-file/upload', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fileName": "",
    "fileContent": "",
    "notes": ""
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new TransactionsApi(config);
var body = JsonSerializer.Deserialize<BatchFileUploadDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "",
      "fileContent": "",
      "notes": ""
    }
    """);

var result = await api.BatchFileUploadBatchFileAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/transactions/batch-file/upload");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "",
      "fileContent": "",
      "notes": ""
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.TransactionsApi(client)
    body = winkpg_api.BatchFileUploadDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "",
      "fileContent": "",
      "notes": ""
    })
    result = api.batch_file_upload_batch_file(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fileName": "",
  "fileContent": "",
  "notes": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/batch-file/upload",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

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