---
title: "Create a payment instrument group"
method: POST
path: "/paymentInstrumentGroups"
tags: ["Payment instrument groups"]
---

# Create a payment instrument group

`POST /paymentInstrumentGroups`

Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.

## Request body

- PaymentInstrumentGroupInfo
  - `balancePlatform` string, required — The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs.
  - `description` string — Your description for the payment instrument group.
  - `properties` object — Properties of the payment instrument group.
  - `reference` string — Your reference for the payment instrument group.
  - `txVariant` string, required — The tx variant of the payment instrument group.

## Response `200`

OK - the request has succeeded.

- PaymentInstrumentGroup
  - `balancePlatform` string, required — The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs.
  - `description` string — Your description for the payment instrument group.
  - `id` string — The unique identifier of the payment instrument group.
  - `properties` object — Properties of the payment instrument group.
  - `reference` string — Your reference for the payment instrument group.
  - `txVariant` string, required — The tx variant of the payment instrument group.

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

## Changes

- **2024-01-16** (v2) `24691235e721` — 1 info
  - the endpoint scheme security `clientKey` was added to the API
- **2023-11-14** (v2) `12a0c6036e6b` — 10 warning
  - removed the optional property `response/paths` from the response with the `400` status
  - removed the optional property `response/paths` from the response with the `401` status
  - removed the optional property `response/paths` from the response with the `403` status
  - removed the optional property `response/paths` from the response with the `422` status
  - …6 more

[Change history](https://skmtc.dev/adyen/apis/balanceplatformservice/changes/paymentInstrumentGroups/post.md)

---

[API](https://skmtc.dev/adyen/apis/balanceplatformservice.md) · [All operations](https://skmtc.dev/adyen/apis/balanceplatformservice/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/balanceplatformservice/revisions/8761ac1a9aab/schema)
