---
title: "Get bulk payments history"
method: GET
path: "bulk-payments"
tags: ["Bulk Payments"]
---

# Get bulk payments history

`GET bulk-payments`

## Request

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

Endpoint to get all bulk payments associated with your account. This
will give you an overview of all the bulk payments you ever posted. 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.

## Query parameters

- `page` string: Page number to get bulk payments information from.

## Headers

- `Accept` string
- `Authorization` string

## Response `200`

OK

- object
  - `bulk_payments` object[]: Array of bulk payments that were created by the partner.
    - `id` string
    - `status` string
    - `created_at` string
    - `payments` object
      - `count` number
      - `completed` number
      - `failed` string
  - `count` number: Number of bulk payments found.
  - `pages` number: Number of pages with bulk payment information.
  - `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)
