---
title: "Read a batch of payments by internal ID, or unique property values"
method: POST
path: "/crm/v3/objects/payments/batch/read"
tags: ["Batch"]
---

# Read a batch of payments by internal ID, or unique property values

`POST /crm/v3/objects/payments/batch/read`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/crm/v3/objects/payments/batch/read`
- Auth: none required
- TypeScript: <https://skmtc.dev/hubspot/apis/crm-payments/docs/crm/v3/objects/payments/batch/read/post.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `archived` boolean

## Request body

- BatchReadInputSimplePublicObjectId
  - `propertiesWithHistory` string[], required
  - `idProperty` string
  - `inputs` SimplePublicObjectId[], required
    - `id` string, required
  - `properties` string[], required

## Response `200`

successful operation

- BatchResponseSimplePublicObject
  - `completedAt` string, date-time, required
  - `requestedAt` string, date-time
  - `startedAt` string, date-time, required
  - `links` object
  - `results` SimplePublicObject[], required
    - `createdAt` string, date-time, required
    - `archived` boolean
    - `archivedAt` string, date-time
    - `propertiesWithHistory` object
    - `id` string, required
    - `properties` object, required
    - `updatedAt` string, date-time, required
  - `status` 'PENDING' | 'PROCESSING' | 'CANCELED' | 'COMPLETE', required

## Other responses

- `207`: multiple statuses
- `default`: An error occurred.

## Changes

- **2024-03-15** (v3) `94a27bf29cd9`: 1 info
  - endpoint added
- **2024-03-14** (v3) `402dd8dd9c71`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/hubspot/apis/crm-payments/changes/crm/v3/objects/payments/batch/read/post.md)

---

[API](https://skmtc.dev/hubspot/apis/crm-payments.md) - [All operations](https://skmtc.dev/hubspot/apis/crm-payments/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/crm-payments/revisions/68e0c18a565e?raw)