---
title: "Get bulk payout"
method: GET
path: "/bulk-payouts/{id}"
tags: ["Bulk Payouts"]
---

# Get bulk payout

`GET /bulk-payouts/{id}`

## Request

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

Endpoint to retrieve the details of an existing bulk payout. The status `RUNNING` is the default
after you have posted your bulk payout. It means that the individual payouts are being
processed and not all of them have been processed yet. Once that has happened, the status will
switch to `DONE`.

To list all payouts associated with a specific bulk payout, use the [List Payouts](#tag/payouts/GET/payouts)
endpoint and pass the bulk payout id as the `bulkPayoutId` query parameter.

## Path parameters

- `id` string, required

## Response `200`

Ok

- BulkPayout
  - `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

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