---
title: "Download Bulk Payors"
method: GET
path: "/entity/{entityId}/counterparties/payors/download"
tags: ["entity > counterparty > bulk"]
---

# Download Bulk Payors

`GET /entity/{entityId}/counterparties/payors/download`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/entity/{entityId}/counterparties/payors/download`
- Auth: HTTP bearer

Get a URL to download payor counterparties as a CSV/JSON file. This endpoint lets you download customers linked to the entity.

## Path parameters

- `entityId` string, required

## Query parameters

- `format` 'CSV' | 'JSON'
- `search` string
- `networkType` 'ENTITY' | 'NETWORK'
- `paymentMethods` boolean
- `invoiceMetrics` boolean
- `counterpartyId` string
- `metadata` InvoiceTypesMetadataFilter
  - `key` string, required
  - `value` union, required
    - string
    - string[]
- `returnMetadata` string

## Response `200`

Response with status 200

- CommonsBulkDownloadResponse
  - `url` string, required
  - `mimeType` string, required

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `403`: Error response with status 403
- `404`: Error response with status 404
- `409`: Error response with status 409
- `500`: Error response with status 500
- `501`: Error response with status 501

---

[API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)