---
title: "Download payment batch payments"
method: POST
path: "/payment-batches/{paymentBatchId}/payments/download"
tags: ["Payment Batches"]
---

# Download payment batch payments

`POST /payment-batches/{paymentBatchId}/payments/download`

## Request

- Base URL: `https://api.equalsmoney.com/v2`
- URL: `https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments/download`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/equalsmoney/apis/cis-api/docs/payment-batches/:paymentBatchId/payments/download/post.ts> (a function with typed inputs; its response is checked against the schema)

Download all payments submitted in a payment batch.

## Path parameters

- `paymentBatchId` string, uuid, required: The unique ID of the Payment Batch.

## Query parameters

- `accountId` string, required: The ID of the account to work with.
- `statuses` union
  - 'created' | 'validated' | 'confirmed' | 'started' | 'completed' | 'failed'
  - string[]

## Headers

- `content-type` 'text/csv' | 'application/json', required: Indicates the format of the downloaded file.

## Request body

- object

## Response `200`

OK

- unknown

---

[API](https://skmtc.dev/equalsmoney/apis/cis-api.md) - [All operations](https://skmtc.dev/equalsmoney/apis/cis-api/llms.txt) - [OpenAPI document](https://skmtc.dev/equalsmoney/apis/cis-api/revisions/a162c72b8bf6?raw)
