---
title: "List bulk payouts"
method: GET
path: "/bulk-payouts"
tags: ["Bulk Payouts"]
---

# List bulk payouts

`GET /bulk-payouts`

## Request

- Base URL: `https://api.enterprise.airtm.com/v2`
- URL: `https://api.enterprise.airtm.com/v2/bulk-payouts`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/docs/bulk-payouts/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to receive all bulk payouts associated with your account.

## Query parameters

- `before` string
- `after` string
- `perPage` integer
- `status` 'PENDING' | 'IN_PROGRESS' | 'UNCOMPLETED' | 'COMPLETED' | 'REJECTED': The current status of the bulk payout - `PENDING`: The bulk payout was received, but it has yet to be started - `IN_PROGRESS`: Our system is currently processing all the individual payouts contained in this bulk payout. - `COMPLETED`: This doesn't mean all payouts were completed successfully, it may have guest or failed items. It means only that the processing, validations and creation of operations related to that task is completed. - `REJECTED`: The enterprise rejected the bulk payout - `UNCOMPLETED`: Reserved for future use

## Response `200`

Ok

- PaginatedBulkPayout: Represents a paginated collection of items.
  - `items` BulkPayout[], required: The items in the current page.
    - `updatedAt` string, date-time, required: Timestamp of the last update made to the payout.
    - `executionDate` string, date-time: Timestamp of when the payout was executed.
    - `createdAt` string, date-time, required: Timestamp of when the payout was created.
    - `paidAmount` number, double, required: Aggregated amount of all individual payouts in this bulk that were paid
    - `totalAmount` number, double, required: Aggregated amount of all individual payouts in this bulk
    - `total` number, double, required: Number of individual payouts in this bulk
    - `status` 'PENDING' | 'IN_PROGRESS' | 'UNCOMPLETED' | 'COMPLETED' | 'REJECTED', required: The current status of the bulk payout - `PENDING`: The bulk payout was received, but it has yet to be started - `IN_PROGRESS`: Our system is currently processing all the individual payouts contained in this bulk payout. - `COMPLETED`: This doesn't mean all payouts were completed successfully, it may have guest or failed items. It means only that the processing, validations and creation of operations related to that task is completed. - `REJECTED`: The enterprise rejected the bulk payout - `UNCOMPLETED`: Reserved for future use
    - `originalFileName` string: The name of the file if the bulk payout was created uploading a CSV
    - `enterpriseUserId` string, uuid, required: Unique identifier of the enterprise who created this bulk payout
    - `id` string, uuid, required: Unique identifier
  - `startCursor` string: The cursor for the first item in the current page.
  - `endCursor` string: The cursor for the last item in the current page.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2.md) - [All operations](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/revisions/c9ed13d4c5c0?raw)