---
title: "Create a payment batch"
method: POST
path: "/payment-batches"
tags: ["Payment Batches"]
---

# Create a payment batch

`POST /payment-batches`

Creates a new 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, if one is not provided then a default name will be generated.
  - `visible` boolean — Whether the payment batch is visible to other API users
  - `payments` object
    - `defaultFundingBudgetId` string, uuid, required — The ID of the budget that will fund each payment if one isn't specified per payment
    - `rows` object[], required — Array of all the payments with optional fundingBudgetId.
      - `amount` string, required
      - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHN' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWD', required
      - `fundingBudgetId` string, uuid — The unique ID of the funding budget.
      - `purposeCode` string — The purpose code of the payment.
      - `purpose` string — The purpose of the payment.
      - `reference` string — The reference of the payment.
      - `externalId` string — A unique customer-defined identifier for the payment. Can be used to match payment requests with webhook notifications.

## Response `201`

Created

- 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.

## Other responses

- `202` — Accepted

---

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