---
title: "Get bulk payments details"
method: GET
path: "bulk-payments/{bulkPaymentId}"
tags: ["Bulk Payments"]
---

# Get bulk payments details

`GET bulk-payments/{bulkPaymentId}`

## Request

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

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

## Path parameters

- `bulkPaymentId` string

## Headers

- `Content-Type` string
- `Authorization` string

## Response `200`

OK

- object
  - `id` string: ID
  - `status` string: Status of the bulk payment, please check the Possible Statuses section in this endpoint's summary.
  - `payments` object
    - `count` number: Number of individual payments within the bulk payment.
    - `pending` number: Number of individual payments in the PENDING status.

## Other responses

- `404`: Not Found

---

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