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.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/paymentInstrumentGroups
Click to copy

Request parameters

balancePlatform string Required

The unique identifier of the balance platform to which the payment instrument group belongs.

description string
Max length: 300

Your description for the payment instrument group, maximum 300 characters.

properties [string] object

Properties of the payment instrument group.

reference string
Max length: 150

Your reference for the payment instrument group, maximum 150 characters.

txVariant string Required

The tx variant of the payment instrument group.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy