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

# Get bulk payments by id

`GET bulk-payments/{bulkPaymentId}/payments`

## Request

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

Get the status of all payments in an existing bulk payment of yours.
This will allow you to find out which payments succeeded, are still
pending or may have failed. This endpoint is paginated, so make sure to
"flip through the pages" via the query parameter "page" if you need to
get all the information.

## Path parameters

- `bulkPaymentId` string: ID of the bulk payment to look into.

## Query parameters

- `page` string
- `sort` string

## Headers

- `Accept` string
- `Authorization` string

## Response `200`

OK

- object
  - `payments` object[]
    - `receiver_email` string
    - `airtm_user_id` string
    - `amount` number
    - `currency` string
    - `note` string
    - `internal_note` string
    - `status` string
    - `hash` string
  - `count` number: Number of individual payments found.
  - `pages` number: Number of pages with all the individual payments.
  - `currentPage` number: Current page that the partner is exploring.

---

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