---
title: "Update a payment batch"
method: PATCH
path: "/payment-batches/{paymentBatchId}"
tags: ["Payment Batches"]
---

# Update a payment batch

`PATCH /payment-batches/{paymentBatchId}`

Updates attributes of a payment batch.

## Path parameters

- `paymentBatchId` string, uuid, required — The unique ID of the Payment Batch.

## Query parameters

- `accountId` string, required — The ID of the account to work with.

## Request body

- object
  - `name` string — The name of the Payment Batch.
  - `visible` boolean — Whether the payment batch is visible to other API users

## Response `200`

OK

- object
  - `id` string, uuid, required — The unique ID of the Payment Batch.
  - `accountId` string, required — The ID of the account the Payment Batch belongs.
  - `name` string, nullable, required — The name of the Payment Batch.
  - `createdBy` object, required — The creator of the payment batch.
    - `id` string, uuid, required — The ID of the creator.
    - `type` 'person' | 'product', required — The type of the initiator.
  - `product` object, required
    - `id` string, uuid, required — The ID of the product.
    - `name` string, required — The name of the product.
  - `status` 'draft' | 'validated' | 'confirmed' | 'started' | 'completed' | 'failed' | 'cancelled', required — The status of the Payment Batch.
  - `visible` boolean, nullable, required — Whether the payment batch is visible to other API users
  - `visibleAt` string, date-time, nullable, required — Timestamp indicating when the payment batch was made visible. UTC.
  - `confirmedBy` object, nullable, required — The initiator of the payment batch.
    - `id` string, uuid, required — The ID of the initiator.
    - `type` 'person' | 'product', required — The type of the initiator.
  - `confirmedAt` string, date-time, nullable, required — Timestamp indicating when the payment batch was confirmed. UTC.
  - `passedMfaCheckAt` string, date-time, nullable, required — Timestamp indicating when the payment batch passed MFA check. UTC.
  - `riskCheckedAt` string, date-time, nullable, required — Timestamp indicating when the payment batch was risk checked. UTC.
  - `ordersSentAt` string, date-time, nullable, required — Timestamp indicating when the orders were sent. UTC.
  - `createdAt` string, date-time, required — Timestamp indicating when the payment batch was created. UTC.
  - `updatedAt` string, date-time, required — Timestamp indicating when the payment batch was updated. UTC.
  - `alerts` object[], nullable
    - `timestamp` string, date-time, required
    - `type` 'Error' | 'Warning', required
    - `code` string, required
    - `message` string, nullable, required
  - `ordersSummary` object, nullable
    - `numberOfOrders` integer, required
    - `uniqueCurrencyCodes` string[], required
  - `input` object, nullable, required
    - `format` 'json' | 'csv', required — The format that the payments were uploaded in.
    - `status` 'accepted' | 'uploaded' | 'validated' | 'failed', required — The status of the upload
    - `createdAt` string, date-time, required — The date the Resource was initially created. ISO 8601 format without milliseconds.
    - `updatedAt` string, date-time, required — The date the Resource was last modified. ISO 8601 format without milliseconds.

---

[API](https://skmtc.net/equalsmoney/apis/cis-api.md) · [All operations](https://skmtc.net/equalsmoney/apis/cis-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/equalsmoney/cis-api/versions/a162c72b8bf6/schema)